Sign in

v1

latestOpenAPI 3.1.02026-07-222392081.7 MB
Customers > Credits

Create credit product

Create a credit entity for a given product with an optional balance.

post/v1/customers/{id}/credits

Path parameters

idstring required

Request body

product_idstring required

Credit product ID.

namestring

Credit name.

current_balancenumber

Current credit balance.

low_count_thresholdnumber nullable

Value indicating a low threshold.

Example request

{
  "product_id": "itm_3kXODDF42QXtnL",
  "name": "Credit name",
  "current_balance": 2000,
  "low_count_threshold": 10,
  "auto_topup": {
    "credit_count": 32,
    "amount_excluding_tax": 2000
  }
}

Response

Credit created

product_idstring required

Credit product ID.

customer_idstring required

Customer ID related to the credit.

namestring required

Credit name.

current_balancenumber required

Current credit balance.

low_count_thresholdnumber nullable required

Value indicating a low threshold.

last_refreshed_atstring date-time required

Credit last refresh date. UTC date time string in the ISO 8601 format.

created_atstring date-time required

Credit creation date. UTC date time string in the ISO 8601 format.

updated_atstring date-time required

Credit last edition date. UTC date time string in the ISO 8601 format.

Example response

{
  "product_id": "itm_3kXODDF42QXtnL",
  "customer_id": "cus_Typ0px2W0aiEtl",
  "name": "Credit name",
  "current_balance": 2000,
  "low_count_threshold": 10,
  "last_refreshed_at": "2025-11-23T09:00:01.860Z",
  "auto_topup": {
    "credit_count": 32
  },
  "created_at": "2025-10-12T07:00:01.860Z",
  "updated_at": "2025-10-13T10:00:01.860Z"
}