Sample - Stripe API
GET/v1/customers/{customer}/cash_balance

Retrieve a customer's cash balance

Retrieves the cash balance associated with a customer. Use expand to request additional fields in the returned cash balance object. The response includes available balances, customer association, mode, object type, and balance settings.

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

2 parameters
customerstringrequired
The unique identifier of the customer whose cash balance to retrieve. The value must be no more than 5,000 characters.
expandarray<string>optional
Fields to expand in the response; each value must be no more than 5,000 characters.

2 status codes
200Returns the customer's cash balance object, including available currency balances, customer identifier, live or test mode, object type, and reconciliation settings.
availableobjectoptional
A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
customerstringrequired
The ID of the customer whose cash balance this object represents.
customer_accountstringoptional
The ID of an Account representing a customer whose cash balance this object represents.
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:cash_balance
settingsobjectrequired
defaultError response.
errorobjectrequired

Error handling

customer must be no more than 5,000 characters and must identify the customer whose cash balance to retrieve. Each expand value must be no more than 5,000 characters when expansion is requested.