get/v1/customers/{customer}/balance_transactions

List customer balance transactions

Returns a list of transactions that updated the customer’s balances.

Path parameters

Name	Description
customer*

Query parameters

Name	Description
created	Only return customer balance transactions that were created during the given date interval.
ending_before	A 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.
expand	Specifies which fields in the response should be expanded.
invoice	Only return transactions that are related to the specified invoice.
limit	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after	A 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

Field Type Description

data*

array<customer_balance_transaction>

Details about each object.

array item fields

Field	Type	Description
amount*	integer	The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`.
checkout_session	string \| checkout.session	The ID of the checkout session (if any) that created the transaction.
created*	integer (unix-time)	Time at which the object was created. Measured in seconds since the Unix epoch.
credit_note	string \| credit_note	The ID of the credit note (if any) related to the transaction.
currency*	string (currency)	Three-letter ISO currency code, in lowercase. Must be a supported currency.
customer*	string \| customer	The ID of the customer the transaction belongs to.
customer_account	string	The ID of an Account representing a customer that the transaction belongs to.
description	string	An arbitrary string attached to the object. Often useful for displaying to users.
ending_balance*	integer	The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.
id*	string	Unique identifier for the object.
invoice	string \| invoice	The ID of the invoice (if any) related to the transaction.
livemode*	boolean	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadata	object	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
object*	string	String representing the object's type. Objects of the same type share the same value.
type*	string	Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, `unapplied_from_invoice`, `checkout_session_subscription_payment`, or `checkout_session_subscription_payment_canceled`. See the Customer Balance page to learn more about transaction types.

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.