The Customer Balance Transaction object

Attributes

• id (string) Unique identifier for the object.

• object (string) String representing the object’s type. Objects of the same type share the same value.

• 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, nullable, expandable (can be expanded into an object with the expand request parameter)) The ID of the checkout session (if any) that created the transaction.

• created (timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.

• credit_note (string, nullable, expandable (can be expanded into an object with the expand request parameter)) The ID of the credit note (if any) related to the transaction.

• currency (enum) Three-letter ISO currency code, in lowercase. Must be a supported currency.

• customer (string, expandable (can be expanded into an object with the expand request parameter)) The ID of the customer the transaction belongs to.

• customer_account (string, nullable) The ID of an Account representing a customer that the transaction belongs to.

• description (string, nullable) 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.

• invoice (string, nullable, expandable (can be expanded into an object with the expand request parameter)) 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, 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.

• type (enum) 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. Possible enum values:

  • adjustment An explicitly created adjustment transaction to debit or credit the credit balance.

  • applied_to_invoice Traces the application of credit against a linked Invoice.

  • checkout_session_subscription_payment Traces the customer balance applied to an Invoice to be created for the linked Checkout Session.

  • checkout_session_subscription_payment_canceled Traces the reversal of an applied balance by the linked Checkout Session. Paired with an earlier ‘checkout_session_subscription_payment‘ transaction.

  • credit_note Traces the creation of credit to a Credit Note and its associated Invoice.

  • initial The starting value of the customer’s credit balance.

  • invoice_overpaid Credits to the credit balance when an invoice receives payments exceeding the amount due.

  • invoice_too_large Debits to the credit balance when the amount due on an invoice is greater than Stripe’s maximum chargeable amount and the customer does not have a cash balance.

  • invoice_too_small Debits to the credit balance when the amount due on an invoice is less than Stripe’s minimum chargeable amount and the customer does not have a cash balance.

  • migration Funds migrated from the legacy customer credit balance.

  • unapplied_from_invoice Traces the reversal of an applied credit balance from a linked Invoice. Paired with an earlier ‘applied_to_invoice’ transaction.

  • unspent_receiver_credit Unspent funds in receiver Sources that got automatically charged and credited to the balance.

The Customer Balance Transaction object

{
  "id": "cbtxn_1MrU9qLkdIwHu7ixhdjxGBgI",
  "object": "customer_balance_transaction",
  "amount": -500,
  "created": 1680216086,
  "credit_note": null,
  "currency": "usd",
  "customer": "cus_NcjdgdwZyI9Rj7",
  "description": null,
  "ending_balance": -500,
  "invoice": null,
  "livemode": false,
  "metadata": {},
  "type": "adjustment"
}