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_
that this transaction will apply to. If the customer’scredit_ balance 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.
- metadataobject
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
.
Returns
Returns a customer balance transaction object if the call succeeded.
{ "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"}