Customers

Grant credits to a customer

Adds credits to a customer balance. Use Idempotency-Key to make grants safe to retry.

post/v1/sdk/customers/{reference}/credits

Path parameters

referencestring required

Example:cus_3c4d5e6f7g8h

Customer reference identifier

Idempotency-Keystring

Provider-scoped idempotency key for safe grant retries

creditsinteger required

reasonstring

Credits granted successfully

balancenumber required

Customer credit balance after the grant

creditsnumber required

Granted credit amount

customerRefstring required

Customer reference identifier

reasonstring

Machine-readable grant reason

successboolean required

Whether the grant was recorded

Changed in 2 of the 27 revisions of this API.11

Jul 17, 2026bbc2ff2bc8491See the full diff
- ▲
  added the pattern ^[\p{L}\p{N}\s.,'"&\/()+:%;?!@#_[\]\-]*$ to the request property
  request-property-pattern-added
Jul 4, 2026a30b6aef464d1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog