Credit balance and usage log
Authorization
bearerAuth Create a key under Account → API. Send it as Authorization: Bearer st_live_…. Keys carry scopes: checks:write (create, cancel, delete; add, change and delete source rules), checks:read (list, get; list source rules) and usage:read (credit position).
In: header
Response Body
application/json
curl -X GET "https://example.com/v1/me/usage"{ "plan": "string", "wordsPerPeriod": 0, "wordsUsed": 0, "wordsPending": 0, "wordsRemaining": 0, "creditsPerPeriod": 0, "creditsUsed": 0, "creditsPending": 0, "creditsRemaining": 0, "creditsSpentThisPeriod": 0, "checksPerPeriod": null, "checksUsed": null, "checksRemaining": null, "balanceCredits": 0, "balanceHeldCredits": 0, "balanceAvailableCredits": 0, "expiring": [], "periodStart": "string", "periodEnd": "string", "log": [ { "date": "string", "type": "string", "credits": 0, "words": 0, "details": "string", "checkId": "string" } ]}Delete a source rule DELETE
Previous Page
Capabilities and price schedule GET
What the API can do and what it charges, live: the credit meter (`credits`: per started `wordsPerCredit` words a check costs `passes.base` plus the rate of each pass that is on; `styleEnabled` says whether the style pass runs at all), the document limits and accepted file types and languages, the vocabulary `options` accepts, the source-rule limits, and the per-key rate limits. No key needed; cache it for a few minutes.