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

Retrieve a customer balance transaction

Retrieves one customer balance transaction that changed a customer's credit balance. Use expand when you need selected response fields returned in expanded form.

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

3 parameters
customerstringrequired
The unique identifier of the customer that owns the balance transaction; the value must be no longer than 5,000 characters.
transactionstringrequired
The unique identifier of the customer balance transaction.
expandarray<string>optional
Specifies response fields to expand; each expansion value must be no longer than 5,000 characters.

2 status codes
200Returns the customer balance transaction, including its amount, currency, customer, resulting `ending_balance`, creation time, and transaction type.
amountintegerrequired
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_sessionstringoptional
The ID of the checkout session (if any) that created the transaction.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
credit_notestringoptional
The ID of the credit note (if any) related to the transaction.
currencystringrequired
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
customerstringrequired
The ID of the customer the transaction belongs to.
customer_accountstringoptional
The ID of an Account representing a customer that the transaction belongs to.
descriptionstringoptional
An arbitrary string attached to the object. Often useful for displaying to users.
ending_balanceintegerrequired
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.
idstringrequired
Unique identifier for the object.
invoicestringoptional
The ID of the invoice (if any) related to the transaction.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:customer_balance_transaction
typestringrequired
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](https://docs.stripe.com/billing/customer/balance#types) to learn more about transaction types.
Allowed:adjustmentapplied_to_invoicecheckout_session_subscription_paymentcheckout_session_subscription_payment_canceledcredit_noteinitialinvoice_overpaidinvoice_too_largeinvoice_too_smallmigrationunapplied_from_invoiceunspent_receiver_credit
defaultReturned when the API cannot retrieve the transaction and provides an error object.
errorobjectrequired

Error handling

customer must identify the customer that owns the transaction, and transaction must identify the balance transaction to retrieve. Each expand value must be no longer than 5,000 characters.