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

Update a customer's cash balance settings

Updates the settings for a customer's cash balance. Use settings.reconciliation_mode to choose how incoming cash balance funds are reconciled, and use expand to request expanded response fields. The response contains the updated cash balance and its settings.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
customerstringrequired
The unique identifier of the customer whose cash balance settings to update. The value must be no more than 5,000 characters.

Optional form parameters for updating cash balance settings and expanding the response.

expandarray<string>optional
Specifies which fields in the response should be expanded.
settingsobjectoptional
A hash of settings for this cash balance.

2 status codes
200Returns the updated cash balance object, including its available balances, customer identifier, 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 settings to update. When supplied, settings.reconciliation_mode must be automatic, manual, or merchant_default; each expand value must be no more than 5,000 characters.