Skip to main content
GET
Get Usage

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Query Parameters

days
integer
default:30

Days of daily to return, ending today (UTC).

Required range: 1 <= x <= 90

Response

Usage.

Plan, replies this period, wallet and replies per day.

plan
string
required

The workspace's plan.

Example:

"payg"

currency
enum<string>
required

The currency money is stated in.

Available options:
INR,
USD
period
object
required

The period replies.used counts: this calendar month in UTC.

replies
object
required

This period's replies against the plan's allowance.

billedTo
enum<string>
required

developer when this workspace is a developer's customer and its usage is billed to the developer; otherwise self.

Available options:
self,
developer
wallet
object | null
required

The balance. null on Free (which has no wallet) and for a developer's customer (its developer pays).

daily
object[]
required

Replies per UTC day for the last days.