Create a customer balance transaction

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

Returns

Returns a customer balance transaction object if the call succeeded.

Parameters

• amount (integer, required) The integer amount in the smallest currency unit to apply to the customer’s credit balance.

• currency (enum, required) 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.

• description (string, optional) An arbitrary string attached to the object. Often useful for displaying to users.

  The maximum length is 350 characters.

• metadata (object, optional) 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.

curl https://api.stripe.com/v1/customers/{{CUSTOMER_ID}}/balance_transactions \
  -u "<<YOUR_SECRET_KEY>>" \
  -d amount=-500 \
  -d currency=usd

Response

{
  "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"
}