Sample - Stripe API
GET/v1/customers/{customer}/balance_transactions

List customer balance transactions

Lists transactions that have updated a customer's credit balance. Use invoice and created to filter the results, and use cursor parameters to page through the transaction history.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

7 parameters
customerstringrequired
The unique identifier of the customer whose balance transactions to list; the value must be no longer than 5,000 characters.
createdobjectoptional
Filters transactions by creation time using a Unix timestamp or a range with `gt`, `gte`, `lt`, and `lte`.
ending_beforestringoptional
An object ID cursor that returns the page of results before the specified transaction.
expandarray<string>optional
Specifies response fields to expand; each expansion value must be no longer than 5,000 characters.
invoicestringoptional
Filters results to transactions related to the specified invoice; the value must be no longer than 5,000 characters.
limitintegeroptional
The number of transactions to return, from 1 to 100. Defaults to 10 when omitted.
starting_afterstringoptional
An object ID cursor that returns the page of results after the specified transaction.

2 status codes
200Returns a list object containing customer balance transaction objects in `data`, a `has_more` pagination flag, the `list` object type, and the list `url`.
dataarray<CustomerBalanceTransaction>required
Details about each object.
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Allowed:list
urlstringrequired
The URL where this list can be accessed.
defaultReturned when the API cannot process the request and provides an error object.
errorobjectrequired

Error handling

customer must identify the customer whose balance transactions you want to retrieve. limit must be between 1 and 100, and use starting_after or ending_before with an object ID to navigate between pages.