Skip to main content
GET
Get customer credit balance

Authorizations

Authorization
string
header
required

Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer token.

Path Parameters

reference
string
required

Customer reference identifier

Example:

"cus_3c4d5e6f7g8h"

Response

Customer balance retrieved successfully

credits
number
required

Raw credit balance in credits (mils)

Example:

4200

creditsPerMinorUnit
number
required

Number of credits per minor currency unit

Example:

100

customerRef
string
required

Customer reference identifier

Example:

"cus_3c4d5e6f7g8h"

display
object
required

Formatted balance display block for the display currency

displayCurrency
string
required

ISO 4217 display currency code

Example:

"USD"

displayExchangeRate
number
required

Exchange rate from USD to the display currency

Example:

1