List credit balances for a customer
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.
Authorizations
Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.
API keys are assigned permissions, granting them access to entities and operations.
Each endpoint may require one or more permissions, defined with the x-permissions extension.
Values for include parameters may require specific permissions as defined in the x-enum-permissions extension.
See all available permissions in the permission schema or documentation.
Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.
Path Parameters
Paddle ID of the customer entity to work with.
"ctm_01gw1xk43eqy2rrf0cs93zvm6t"
Query Parameters
Return entities that match the currency code. Use a comma-separated list to specify multiple currency codes.