Create a customer balance transaction
Creates an immutable transaction that updates the customer’s credit balance.
Path parameters
Response
Successful response.
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.
Time at which the object was created. Measured in seconds since the Unix epoch.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
The ID of an Account representing a customer that the transaction belongs to.
An arbitrary string attached to the object. Often useful for displaying to users.
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.
Unique identifier for the object.
If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
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.
String representing the object's type. Objects of the same type share the same value.
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.