curl 'https://api.serialized.xyz/v1/usage' \
-H 'Authorization: YOUR_API_KEY'
{
"data": {
"keyId": "7c21e4b09d5a",
"tenant": "acc_5d1e9b2a7c40f316",
"plan": "payg",
"month": "202609",
"scope": "account",
"credits": {
"used": 14530,
"limit": 1000000,
"remaining": 985470
},
"requests": 5020
},
"meta": {
"asOf": 1788980722243
}
}
Account usage
Usage
Current billing cycle of the calling key: plan, credits used, limit and remaining, request count. Free.
GET
/
v1
/
usage
curl 'https://api.serialized.xyz/v1/usage' \
-H 'Authorization: YOUR_API_KEY'
{
"data": {
"keyId": "7c21e4b09d5a",
"tenant": "acc_5d1e9b2a7c40f316",
"plan": "payg",
"month": "202609",
"scope": "account",
"credits": {
"used": 14530,
"limit": 1000000,
"remaining": 985470
},
"requests": 5020
},
"meta": {
"asOf": 1788980722243
}
}
GET /v1/usage
Current billing cycle of the calling key: plan, credits used, limit and remaining, request count. The programmatic view of your own key and account, the data behind a usage dashboard. Free: never billed, and still reachable when the monthly credit allowance is exhausted (when billable endpoints answer 402), so you can always inspect your own state. A key only ever sees its own account.
month is the current billing cycle (YYYYMM, calendar month, UTC). For keys created in the portal, scope is "account": credits and requests cover the whole account (all its keys share one allowance), tenant is the account id and credits.limit is what the account can use this month (free credits left plus what the spend cap allows). Contract keys report scope: "key" and their own figures; on an unlimited contract, credits.limit and credits.remaining are null.The same figure is on every billable response: the
X-Credits-Remaining header carries the credits left in the current cycle.curl 'https://api.serialized.xyz/v1/usage' \
-H 'Authorization: YOUR_API_KEY'
{
"data": {
"keyId": "7c21e4b09d5a",
"tenant": "acc_5d1e9b2a7c40f316",
"plan": "payg",
"month": "202609",
"scope": "account",
"credits": {
"used": 14530,
"limit": 1000000,
"remaining": 985470
},
"requests": 5020
},
"meta": {
"asOf": 1788980722243
}
}
Authorizations
Your raw API key (not needed on the demo server).
Response
200
Standard { data, meta } envelope.