Customers
get/v1/customers/{customer}/cash_balance_transactions

List cash balance transactions

Returns a list of transactions that modified the customer’s cash balance.

Path parameters

NameDescription
customer*

Query parameters

NameDescription
ending_beforeA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
expandSpecifies which fields in the response should be expanded.
limitA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_afterA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Request body

object (no properties in spec)

Response

FieldTypeDescription
data*array<customer_cash_balance_transaction>

Details about each object.

array item fields
FieldTypeDescription
adjusted_for_overdraftcustomer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft
2 nested fields
FieldTypeDescription
balance_transaction*string | balance_transaction

The Balance Transaction that corresponds to funds taken out of your Stripe balance.

linked_transaction*string | customer_cash_balance_transaction

The Cash Balance Transaction that brought the customer balance negative, triggering the clawback of funds.

applied_to_paymentcustomer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction
1 nested field
FieldTypeDescription
payment_intent*string | payment_intent

The Payment Intent that funds were applied to.

created*integer (unix-time)

Time at which the object was created. Measured in seconds since the Unix epoch.

currency*string

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customer*string | customer

The customer whose available cash balance changed as a result of this transaction.

customer_accountstring

The ID of an Account representing a customer whose available cash balance changed as a result of this transaction.

ending_balance*integer

The total available cash balance for the specified currency after this transaction was applied. Represented in the smallest currency unit.

fundedcustomer_balance_resource_cash_balance_transaction_resource_funded_transaction
1 nested field
FieldTypeDescription
bank_transfer*customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer
id*string

Unique identifier for the object.

livemode*boolean

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

net_amount*integer

The amount by which the cash balance changed, represented in the smallest currency unit. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.

object*string

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

refunded_from_paymentcustomer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction
1 nested field
FieldTypeDescription
refund*string | refund

The Refund that moved these funds into the customer's cash balance.

transferred_to_balancecustomer_balance_resource_cash_balance_transaction_resource_transferred_to_balance
1 nested field
FieldTypeDescription
balance_transaction*string | balance_transaction

The Balance Transaction that corresponds to funds transferred to your Stripe balance.

type*string

The type of the cash balance transaction. New types may be added in future. See Customer Balance to learn more about these types.

unapplied_from_paymentcustomer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction
1 nested field
FieldTypeDescription
payment_intent*string | payment_intent

The Payment Intent that funds were unapplied from.

has_more*boolean

True if this list has another page of items after this one that can be fetched.

object*string

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

url*string

The URL where this list can be accessed.