Skip to main content
GET
Get current credit balance

What the balance includes

balance is the company’s total available balance: regular credits plus unexpired one-time credits. currency is credits, not a payment currency. The response does not include package breakdowns or expiry dates; view those details in the app. See Credits & billing for spending order, renewal, and purchases.

Authorizations

Authorization
string
header
required

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

Response

Credit balance

balance
number
required

Total available company credits, including regular credits and unexpired one-time credits. Package breakdowns and expiry dates are not returned.

currency
string
default:credits
required

Credit unit, not the currency used to purchase a package.