Sign in
latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-204887241.6 KB

d29ab7373802

Customers

Get customer credit balance

Returns the credit balance for a customer identified by reference.

get/v1/sdk/customers/{reference}/balance

Path parameters

referencestring required
Example:cus_3c4d5e6f7g8h

Customer reference identifier

Response

Customer balance retrieved successfully

creditsnumber required

Raw credit balance in credits (100 credits = 1 minor currency unit)

creditsPerMinorUnitnumber required

Number of credits per minor currency unit

customerRefstring required

Customer reference identifier

displayCurrencystring required

ISO 4217 display currency code

displayExchangeRatenumber required

Exchange rate from USD to the display currency

Example response

{
  "credits": 4200,
  "creditsPerMinorUnit": 100,
  "customerRef": "cus_3c4d5e6f7g8h",
  "display": {
    "amountMajor": 42,
    "currency": "USD",
    "exchangeRate": 1,
    "formatted": "$42.00",
    "rateSource": "parity"
  },
  "displayCurrency": "USD",
  "displayExchangeRate": 1
}