GET
/v1/billing/credit_balance_transactionsList credit balance transactions
Lists credit balance transactions recorded against credit grants. Use credit_grant, customer, or customer_account to scope the transactions, and use cursor parameters to navigate through the results. The response is a paginated list with transaction data and a continuation indicator.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
credit_grantstringoptional
The credit grant for which to retrieve credit balance transactions.
customerstringoptional
The customer whose credit balance transactions to retrieve.
customer_accountstringoptional
The account representing the customer whose credit balance transactions to retrieve.
ending_beforestringoptional
An object ID cursor that retrieves the page preceding the specified transaction.
expandarray<string>optional
Specifies which response fields to expand.
limitintegeroptional
The number of transactions to return, from 1 to 100. Defaults to 10 when omitted.
starting_afterstringoptional
An object ID cursor that retrieves the page following the specified transaction.
200Returns a paginated list containing credit balance transactions, a `has_more` indicator, the list object type, and the list URL.
dataarray<CreditBalanceTransaction>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired
Error handling
limit must be between 1 and 100 when provided, and defaults to 10 when omitted. ending_before and starting_after are pagination cursors that must not exceed 5000 characters; use only a valid object identifier for each cursor.