List credit balances for a customer

GET {{baseUrl}}/customers/:customer_id/credit-balances

Returns a list of credit balances for each currency for a customer. Each balance has three totals:

  • available: total available to use.
  • reserved: total temporarily reserved for billed transactions.
  • used: total amount of credit used.

Credit is added to the available total initially. When used, it moves to the used total.

The reserved total is used when a credit balance is applied to a transaction that's marked as billed, like when working with an issued invoice. It's not available for other transactions at this point, but isn't considered used until the transaction is completed. If a billed transaction is canceled, any reserved credit moves back to available.

Credit balances are created automatically by Paddle when you take an action that results in Paddle creating a credit for a customer, like making prorated changes to a subscription. An empty data array is returned where a customer has no credit balances.

The response is not paginated.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring