Update a customer credit balance transaction
POST / v1 / customers /:id / balance_transactions /:id
Most credit balance transaction fields are immutable, but you may update its description and metadata.
Parameters
- description string An arbitrary string attached to the object. Often useful for displaying to users. The maximum length is 350 characters.
- metadata map 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.
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": { "order_id": "6735" }, "type": "adjustment"}
Retrieve a customer balance transaction
GET / v1 / customers /:id / balance_transactions /:id
Retrieves a specific customer balance transaction that updated the customer’s balances.
Parameters
No parameters.
Returns
Returns a customer balance transaction object if a valid identifier was provided.
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"}
List customer balance transactions
GET / v1 / customers /:id / balance_transactions
Returns a list of transactions that updated the customer’s balances.
Parameters
No parameters.
More parameters
- created object
- ending _ before string
- invoice string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit customer balance transactions, starting after item starting_after. Each entry in the array is a separate customer balance transaction object. If no more items are available, the resulting array will be empty.
Response