Sample - Stripe API
GET/v1/billing/credit_balance_summary

Get a customer's credit balance summary

Retrieves the credit balance summary for a customer. Use customer or customer_account to identify the balance owner and provide filter to select an applicability scope or credit grant. The response includes balances grouped by credit grant currency.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 parameters
customerstringoptional
The customer whose credit balance summary to retrieve.
customer_accountstringoptional
The account representing the customer whose credit balance summary to retrieve.
expandarray<string>optional
Specifies which response fields to expand.
filterobjectrequired
Filter criteria for the summary; its `type` must be `applicability_scope` or `credit_grant`.

2 status codes
200Returns a credit balance summary containing the customer or customer account, an array of available and ledger balances, livemode, and the object type.
balancesarray<CreditBalance>required
The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.
customerstringrequired
The customer the balance is for.
customer_accountstringoptional
The account the balance is for.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:billing.credit_balance_summary
defaultError response.
errorobjectrequired

Error handling

filter is required and its type must be either applicability_scope or credit_grant. Use customer or customer_account to identify the customer or account whose balance you want to retrieve.