Last updated
Credits
Every workspace has a credit wallet that refills each billing period. API calls and dashboard reads draw from the same wallet; the reference lists the class of each operation.
What an operation costs
| Class | Credits per call | Covers |
|---|---|---|
| Cached read | 1 | Every read of stored data: rankings, creators, videos, trends, LIVE sessions. |
| Live refresh | 1,250 | POST /v1/live/creators/{uid}/refresh: ask the workers to check a creator now. |
| Export | 2,500 | POST /v1/exports: build a CSV or Excel file. |
| Free | 0 | Alert rules, listing and downloading exports, plan and usage. |
Each operation in the reference shows its class next to its scope. The monthly allotment comes with the plan; see pricing.
When the wallet is empty
A metered call that the wallet cannot cover answers 402 with the usual error envelope. Free operations keep working. The wallet refills at the start of the next period, or when the plan is upgraded.
A failed call is not charged
Credits are reserved when the call starts and refunded if it fails, so a
4xx or 5xx answer costs nothing.Read the wallet
GET /v1/entitlements returns the plan, limits and the wallet of the current period; GET /v1/usage breaks spending down by operation. Both are free and need the keys:manage scope.
bash
curl "https://api.roomscope.io/v1/entitlements" \ -H "Authorization: Bearer $ROOMSCOPE_API_KEY" # data.credits: { "period": "2026-11-01", "monthlyAllotment": …, "hardCap": …, "spent": …, "remaining": … }Was this page helpful?