Skip to navigation

List credit transactions

List credit ledger transactions (grants, spends, and pending grants) for the organization, newest first. Filter by customer, credit currency, type, order, or date range.

Authentication

AuthorizationBearer
API Key authentication using Bearer token

Query parameters

limitintegerOptional1-100Defaults to 10
offsetintegerOptional
customerIdstringOptional>=1 character
Filter by customer ID.
externalCustomerIdstringOptional>=1 character
Filter by customer external ID.
creditsCurrencyIdstringOptional>=1 character
Filter by credit currency ID.
creditCurrencyKeystringOptional>=1 character

Filter by the stable machine-readable key of the credit currency.

typeenumOptional
Filter by transaction type.
Allowed values:
orderIdstringOptional>=1 character
Filter by the order this transaction is linked to.
eventNamestringOptional>=1 character

Filter by the usage event that produced the transaction (exact match, untrimmed). Transactions with no event (grants, invoice-void clawbacks, manual adjustments) never match.

createdAtFromstringOptional

Only transactions recorded on or after this date. Accepts an ISO 8601 date or date-time. Date-only values (e.g. 2026-06-30) are treated as UTC; date-times without an explicit timezone offset are ambiguous, so include one (e.g. 2026-06-30T00:00:00-05:00) when precision matters.

createdAtTostringOptional

Only transactions recorded on or before this date. Accepts an ISO 8601 date or date-time. Date-only values (e.g. 2026-06-30) are treated as UTC; date-times without an explicit timezone offset are ambiguous, so include one (e.g. 2026-06-30T00:00:00-05:00) when precision matters.

Response

200
datalist of objects
Credit transactions, newest first.
paginationobject

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error