Latest Live API
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Taxes
- Usage
Version 2024-07-30
- Account
- Billing
- Prices
- Discounts
- Credits
- Billing Schedules
- Collections
- Customer
- Invoices
- Notifications
- Product
- Taxes
- Usage
List Credit Balances for a customer
List all Credit Balances including their grants and transactions
Your API credentials. Eg. Basic {credentials}
.
Use this header to select an API version
Customer ID
Headers
Your API credentials. Eg. Basic {credentials}
.
Use this header to select an API version
2024-07-30
Path Parameters
Customer ID
Response
Indicates the ID of Credit target, either a currency code or a metric id
Type of the Credit - will either be CASH or USAGE
CASH
, USAGE
Name of the Credit - will either be the currency or name of the metric
Amount remaining of Credits Granted
Related credit grants
Credit Grant ID
Sequence account ID
Customer ID
Type of the Credit - will either be CASH or USAGE
CASH
, USAGE
Currency
ARS
, AUD
, BRL
, CAD
, CHF
, CNY
, COP
, CZK
, DKK
, EUR
, GBP
, HKD
, ILS
, JPY
, KRW
, MXN
, NOK
, NZD
, PLN
, SEK
, SGD
, THB
, USD
, UYU
, ZAR
Usage metric ID (if type is USAGE)
Name of the Credit - will either be the currency or name of the metric
Amount of credits originally granted
Amount remaining of Credits Granted
Last Day Credit Grant can be consumed
Cost of credit grant
Tax Rate ID for Credit Purchase
First Day Credit Grant can be consumed
The created at
Related credit transactions
Credit Transaction ID
Credit Grant ID
Transaction Reason
Invoice ID where Credit was consumed
Billing Run ID where Credit was consumed
Credit Transaction Type
Number of units added or consumed
Date of transaction