Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Retrieve a customer balance transaction

Retrieves a specific customer balance transaction that updated the customer’s balances.

get/v1/customers/{customer}/balance_transactions/{transaction}

Path parameters

customerstring required
transactionstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

amountinteger required

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.

createdinteger required

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

currencystring currency required

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

customer_accountstring nullable

The ID of an Account representing a customer that the transaction belongs to.

descriptionstring nullable

An arbitrary string attached to the object. Often useful for displaying to users.

ending_balanceinteger required

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.

idstring required

Unique identifier for the object.

livemodeboolean required

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

metadataobject nullable

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'customer_balance_transaction' required

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

type'adjustment' | 'applied_to_invoice' | 'checkout_session_subscription_payment' | 'checkout_session_subscription_payment_canceled' | 'credit_note' | 'initial' | 'invoice_overpaid' | 'invoice_too_large' | 'invoice_too_small' | 'migration' | 'unapplied_from_invoice' | 'unspent_receiver_credit' required

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.