v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Update a cash balance's settings

Changes the settings on a customer’s cash balance.

post/v1/customers/{customer}/cash_balance

Path parameters

customerstring required

Response

Successful response.

availableobject nullable

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.

customerstring required

The ID of the customer whose cash balance this object represents.

customer_accountstring nullable

The ID of an Account representing a customer whose cash balance this object represents.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'cash_balance' required

String representing the object's type. Objects of the same type share the same value.