Skip to main content
GET
cURL
Pass the exact customerId used when creating the customer. IDs can contain punctuation, spaces, or slashes; URL encode the query value. The response includes availableCredits from active plan and add-on grants and currentPlan when an active plan or pending Checkout exists. An active plan takes precedence over a pending Checkout. currentPlan is null when neither exists; this does not imply the balance is zero because add-on credits may remain. Your API key selects the organization and Sandbox or Live environment. Unknown IDs return 404 customer_not_found. This operation does not create a customer or initiate Checkout. It may advance a due free-plan period before returning the balance, just as Check credits does.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customerId
string
required
Required string length: 1 - 255

Response

Customer balance and current plan

customerId
string
required
createdAt
string<date-time>
required
availableCredits
integer
required
currentPlan
object | null
required