get/v1/customers/{customer}/cash_balance

Retrieve a cash balance

Retrieves a customer’s cash balance.

Path parameters

Name	Description
customer*

Query parameters

Name	Description
expand	Specifies which fields in the response should be expanded.

Request body

object (no properties in spec)

Response

Field Type Description

available

object

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.

customer*

string

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

customer_account

string

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

livemode*

boolean

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

object*

string

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

settings*

customer_balance_customer_balance_settings

2 nested fields

Field	Type	Description
reconciliation_mode*	string	The configuration for how funds that land in the customer cash balance are reconciled.
using_merchant_default*	boolean	A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance