Skip to content

Usage

Returns the authenticated account’s message count and plan limits for the current billing period.

GET /v1/usage

Authentication: Required (API key or JWT).

Terminal window
curl https://api.skytale.sh/v1/usage \
-H "Authorization: Bearer sk_live_a1b2c3d4..."
{
"account_id": "550e8400-e29b-41d4-a716-446655440000",
"period": "2026-02-01",
"token_exchanges": 42,
"messages_relayed": 0,
"plan_tier": "free",
"limits": {
"messages_per_month": 100000
}
}
FieldTypeDescription
account_idstringYour account UUID
periodstringFirst day of the current billing month (YYYY-MM-DD)
token_exchangesnumberNumber of POST /v1/tokens calls this period
messages_relayednumberMessages relayed through channels this period
plan_tierstringCurrent plan (free, pro, enterprise)
limits.messages_per_monthnumber | nullMonthly message cap, or null for unlimited
TierMessages/month
free100,000
pro1,000,000
enterpriseUnlimited
  • Returns zeros for accounts with no activity in the current period.
  • token_exchanges maps 1:1 to SDK sessions — each SkytaleClient does one token exchange on connect.
StatusErrorCause
401missing authorization headerNo auth header provided
401invalid or revoked api keyAPI key not found or revoked