v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0114775543.6 KB
Billing

List credit ledger

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.
get/payment/v1/credits/ledger

Query parameters

limitinteger

Page size (1–100).

offsetinteger

Offset for pagination.

fromstring date-time
Example:2026-07-01T00:00:00Z

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.

tostring date-time
Example:2026-07-28T00:00:00Z

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

type'SIGNUP_BONUS' | 'CREDIT_PURCHASE' | 'AUTO_RELOAD' | 'USAGE_DEDUCTION' | 'ADMIN_ADJUSTMENT' | 'COUPON_CREDIT' | 'MIGRATION' | 'PAYMENTS'

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

scope'platform' | 'voice_ai' | 'voice_models'

Filter by spend category. Applies only to USAGE_DEDUCTION rows.

Response

Paginated ledger with summary + query window echo.

successboolean required

Example response

{
  "success": true
}