Account2

Addresses4

Adjustments3

API root1

Businesses4

Checkout domains4

Client tokens4

Countries1

Currencies1

Customer portals1

Customers6

Discount groups4

Discounts4

Event types1

Events1

IP addresses1

Metrics9

Notification logs1

Notification settings5

Notifications3

Payment methods3

Prices4

Pricing preview1

Products4

Reports4

Settings18

Simulation run events3

Simulation runs3

Simulation types1

Simulations4

Subscription history1

Subscriptions11

Transactions7

Verifications2

Webhooks

Addresses3

Adjustments2

API keys6

Businesses3

Client tokens3

Customers3

Discount groups2

Discounts3

Payment methods2

Payouts2

Prices3

Products3

Reports2

Subscriptions9

Transactions10

Customers

List credit balances for a customer

Changed on Jul 9, 2026

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.

get/customers/{customer_id}/credit-balances

Request

Base URL
https://sandbox-api.paddle.com
Auth
HTTP bearer

Path parameters

customer_idstring required

Unique Paddle ID for this customer entity, prefixed with ctm_.

Example:ctm_01grnn4zta5a1mf02jjze7y2ys

Paddle ID of the customer entity to work with.

Query parameters

currency_codestring[]

Return entities that match the currency code. Use a comma-separated list to specify multiple currency codes.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "customer_id": "ctm_01grnn4zta5a1mf02jjze7y2ys",
      "balance": {
        "available": "200",
        "reserved": "400",
        "used": "600"
      }
    }
  ],
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes

Jul 9, 2026v1e1ac347eb3c5 Revision changes
- breaking
  added the pattern ^ctm_[a-z\d]{26}$ to the path request parameter customer_id
- warning
  added the new CLP enum value to the /// response property for the response status
- warning
  added the new PEN enum value to the /// response property for the response status
Feb 2, 2026v19ba8be0f2006 Revision changes
- breaking
  added the new path request parameter customer_id
- breaking
  the // response property's maxLength was unset from 3 for the response status
- breaking
  the // response property's minLength was decreased from 3 to 0 for the response status
- breaking
  the // response's property type changed from object to no type for status
- breaking
  the // response's property type changed from string to no type for status
- breaking
  the // response's property type changed from string to no type for status
- breaking
  the response's property type changed from object to no type for status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property /// from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  added to the response property allOf list for the response status
- info
  added to the // response property allOf list for the response status
- info
  added to the // response property allOf list for the response status
- info
  added to the // response property allOf list for the response status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  removed the ARS enum value from the // response property for the response status
- info
  removed the AUD enum value from the // response property for the response status
- info
  removed the BRL enum value from the // response property for the response status
- info
  removed the CAD enum value from the // response property for the response status
- info
  removed the CHF enum value from the // response property for the response status
- info
  removed the CNY enum value from the // response property for the response status
- info
  removed the COP enum value from the // response property for the response status
- info
  removed the CZK enum value from the // response property for the response status
- info
  removed the DKK enum value from the // response property for the response status
- info
  removed the EUR enum value from the // response property for the response status
- info
  removed the GBP enum value from the // response property for the response status
- info
  removed the HKD enum value from the // response property for the response status
- info
  removed the HUF enum value from the // response property for the response status
- info
  removed the ILS enum value from the // response property for the response status
- info
  removed the INR enum value from the // response property for the response status
- info
  removed the JPY enum value from the // response property for the response status
- info
  removed the KRW enum value from the // response property for the response status
- info
  removed the MXN enum value from the // response property for the response status
- info
  removed the NOK enum value from the // response property for the response status
- info
  removed the NZD enum value from the // response property for the response status
- info
  removed the PLN enum value from the // response property for the response status
- info
  removed the RUB enum value from the // response property for the response status
- info
  removed the SEK enum value from the // response property for the response status
- info
  removed the SGD enum value from the // response property for the response status
- info
  removed the THB enum value from the // response property for the response status
- info
  removed the TRY enum value from the // response property for the response status
- info
  removed the TWD enum value from the // response property for the response status
- info
  removed the UAH enum value from the // response property for the response status
- info
  removed the USD enum value from the // response property for the response status
- info
  removed the VND enum value from the // response property for the response status
- info
  removed the ZAR enum value from the // response property for the response status
- info
  the // response's property pattern ^ctm_[a-z\d]{26}$ was removed for the status

Operation history (5 revisions)