Gets the credit available to the account, by origin.
Required permission
Organisation > Admin > Billing > Read
Response body
- {object}Response object.
data
{object} requiredResult data.currency
stringThe currency code.total
{object}The spendable credit total. Broken down by source below.available
numberCredit available to spend now, across both sources. A Stripe balance the customer owes does not reduce this — it surfaces as an unpaid invoice instead.pending
numberCredit granted but not yet available. Only credit grants have a pending state.grants
{object}Credit from Stripe credit grants, which is what a credit purchase produces.available
numberCredit-grant balance available to spend now.pending
numberCredit granted but not yet available.customerBalance
{object}Credit from a balance adjustment held against the Stripe customer.amount
numberA balance adjustment applied directly against the customer, e.g. a manually issued credit. Positive is credit in the customer's favour; negative is an amount owed. Only the credit direction counts toward `total.available`.lastSyncedAt
stringWhen the credit balance was last synchronized with Stripe.
API
CLI
JS Client
GET /v1/billing/credit-balance
GET /v1/teams/{teamId}/billing/credit-balance
Example response
200 OK
The account credit balance.
JSON
{
"data": {
"currency": "usd"
}
}