The Customer Balance Transaction object 

Attributes

• idstring

  Unique identifier for the object.

• amountinteger

  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.

• currencyenum

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

• customerstringExpandable

  The ID of the customer the transaction belongs to.

• descriptionnullable string

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

• ending_balanceinteger

  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.

• metadatanullable 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.

• typeenum

  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.

  Show 2 more

More attributes

Collapse all

• objectstring

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

• checkout_sessionnullable stringExpandable

  The ID of the checkout session (if any) that created the transaction.

• createdtimestamp

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

• credit_notenullable stringExpandable

  The ID of the credit note (if any) related to the transaction.

• invoicenullable stringExpandable

  The ID of the invoice (if any) related to the transaction.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.