Credit balance and usage log

GET
/v1/me/usage

Authorization

bearerAuth
AuthorizationBearer <token>

Create a key under Account → API. Send it as Authorization: Bearer st_live_…. Keys carry scopes: checks:write (create, cancel, delete), checks:read (list, get) 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,  "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"    }  ]}