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 dictionary

  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, or unapplied_from_invoice. 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.

  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.

  Show 1 more

More attributes

Expand all

• objectstring

• createdtimestamp

• credit_notenullable stringExpandable

• invoicenullable stringExpandable

• livemodeboolean

Creates an immutable transaction that updates the customer’s credit balance.

Parameters

• amountintegerRequired

  The integer amount in cents to apply to the customer’s credit balance.

• currencyenumRequired

  Three-letter ISO currency code, in lowercase. Must be a supported currency. Specifies the invoice_credit_balance that this transaction will apply to. If the customer’s currency is not set, it will be updated to this value.

• descriptionstring

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

• metadatadictionary

  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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Most credit balance transaction fields are immutable, but you may update its description and metadata.

Parameters

• descriptionstring

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

• metadatadictionary

  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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

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

Parameters

No parameters.