List credit ledger

GET

https://api.smallest.ai/payment/v1/credits/ledger

GET

/payment/v1/credits/ledger

1 import requests
2 
3 url = "https://api.smallest.ai/payment/v1/credits/ledger"
4 
5 payload = {}
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.get(url, json=payload, headers=headers)
12 
13 print(response.json())

1 {
2   "success": true,
3   "data": {
4     "transactions": [
5       {
6         "id": "a3f1c9d2-7b4e-4f8a-9d3e-2b5f6c7d8e9f",
7         "transactionType": "SIGNUP_BONUS",
8         "amount": 10,
9         "balanceAfter": 10,
10         "createdAt": "2026-07-01T12:00:00Z",
11         "featureId": null,
12         "referenceId": "signup_bonus_2026_07",
13         "description": "Welcome bonus credits for new account",
14         "callId": null,
15         "agentId": null,
16         "requestId": null
17       }
18     ],
19     "total": 1,
20     "hasMore": false,
21     "summary": {
22       "totalCreditsConsumed": 0,
23       "totalCreditsAdded": 10
24     },
25     "period": {
26       "from": "2026-07-01T00:00:00Z",
27       "to": "2026-07-08T00:00:00Z"
28     }
29   }
30 }

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.

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