Skip to navigation
API ReferenceBilling

Retrieve usage for the current month

View as Markdown

Voice-minute and AI-message consumption for the current monthly usage window. On monthly plans and trials the window is the billing period. On annual plans it is the one-month slice of the yearly period that contains today, so the allowance resets every month.

How to read it:

  • Available minutes = includedMinutes + bonusMinutes. While trialing, includedMinutes is the 15-minute trial allowance.
  • overageMinutes = minutes used beyond the available minutes. overageCostCents = those minutes × 0.45(Enterprise0.45 (Enterprise 0.33), in US cents. Both are always 0 while trialing.
  • Calls are refused once use passes 150% of the included minutes plus bonus minutes. Pending overage is charged immediately when it reaches $25.
  • chatMessagesUsed counts AI replies on WhatsApp, email, Instagram, Messenger and webchat. The allowance is a hard cap with no overage: AI replies stop at the cap until the window resets.

A workspace with no subscription gets zeros (with channels: ["voice"]). To buy headroom, see POST /api/billing/minute-packs or POST /api/billing/change-plan.

Consistency. Cached server-side for 30 seconds. Minutes are recorded when a call ends, so a call in progress is not counted yet.

Access

  • Required scope: full. Signed-in users need the owner, admin or billing role.
  • Rate limit: Billing — 15 requests/min per workspace, shared by every /api/billing route. See Rate limits.
  • Plan: Available on every plan.

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

ScopeGET / HEADPOST / PUT / PATCH / DELETEAdmin-only routes
readYesNoNo
writeYesYesNo
fullYesYesYes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Response

Usage for the current monthly window.
dataobject

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error