Skip to navigation

List credit ledger

View as Markdown

Paginated credit-ledger transaction history. Ledger reads are served from ClickHouse; a rare storage-tier outage returns an empty transactions array rather than a 5xx.

Window rules

  • from defaults to to - 7 days, to defaults to now.
  • The span between from and to cannot exceed 90 days. A wider span returns 400. Page through longer periods by making multiple calls with shifted from/to.
  • from cannot be earlier than 2026-03-02T00:00:00Z. Older historical data is not available via API; contact support for bulk exports.
  • from > to returns 400.

Filters

  • type filters to a single transaction type. PAYMENTS is a virtual filter that returns both CREDIT_PURCHASE and AUTO_RELOAD rows.
  • scope filters USAGE_DEDUCTION rows by product category.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Query parameters

limitintegerOptional1-100Defaults to 50

Page size (1–100).

offsetintegerOptional>=0Defaults to 0
Offset for pagination.
fromdatetimeOptional

Lower bound of the query window (ISO 8601, Z-suffixed UTC recommended). Defaults to seven days before to. Cannot be earlier than 2026-03-02T00:00:00Z.

todatetimeOptional

Upper bound of the query window (ISO 8601, Z-suffixed UTC recommended). Defaults to now.

typeenumOptional

Filter to a single transaction type. PAYMENTS is a virtual filter that returns purchase-related rows (CREDIT_PURCHASE + AUTO_RELOAD).

scopeenumOptional

Filter by spend category. Applies only to USAGE_DEDUCTION rows.

Allowed values:

Response

Paginated ledger with summary + query window echo.

successboolean
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error