Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Credits

Credit reduction

Endpoint for reducing credits on the customer's account.

A credit reduction creates a negative credit record, decreasing the customer's wallet balance. Use this endpoint to apply a credit spend, expiration, or manual correction. The response returns the ID of the newly created reduction record.

If credit_type_id is not provided, the project-default credit type is used. The note field is optional and is recorded in the credit history audit log, visible via GET /credit-history.

⚠️ This action method is disabled by default. Please contact the CareCloud administrator to allow usage of this method. ⚠️ Action methods are available only in the Enterprise interface.

post/credits/actions/reduce-credits

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Request body

amountnumber float required

Number of reduced credits.

customer_idstring required

The unique ID of the customer. GET /customers

partner_idstring required

The unique ID of the partner. GET /partners

credit_type_idstring

The unique ID of the credit type. If the parameter is not set, a default credit type is set. GET /credit-types

currency_idstring

The unique ID of the currency. If not set, the default currency of the project is used. GET /currencies

notestring

A credit reduce note.

Example request

{
  "amount": 100,
  "customer_id": "8ea2591121e636086a4a9c0992",
  "partner_id": "86e05affc7a7abefcd513ab400",
  "credit_type_id": "86e05affc7a7abefcd513ab400",
  "currency_id": "8bed991c68a470e7aaeffbf048",
  "note": "Credit expiration"
}

Response

Created

Example response

{
  "data": {
    "credit_id": "80c2c110a50db9f8134b6b72b3"
  }
}