v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB
Credit ledger

Get a list of credit ledger events

Retrieves a paginated list of credit ledger events for a customer.

get/api/v1/credits/ledger

Query parameters

limitinteger

Maximum number of items to return

afterstring

Return items that come after this cursor

beforestring

Return items that come before this cursor

customerIdstring required

Filter by customer ID (required)

resourceIdstring

Filter by resource ID

currencyIdstring

Filter by currency ID

eventTypestring

Filter by event type(s), comma-separated

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Response

A paginated list of credit ledger event objects.