Skip to main content
GET
Get API credit usage

Authorizations

x-api-key
string
header
required

API key (sk-proj-…) from Settings → API Keys. Required for sold API calls outside the Mermail console.

Path Parameters

workspaceId
string
required

Workspace id

Response

Credit usage for the current period

plan
string
Example:

"developer"

plan_name
string
Example:

"Developer"

period_start
string<date-time>
period_end
string<date-time>
limit
number | null

Null when the plan has unlimited API credits

Example:

50000

used
number
Example:

1240

remaining
number | null

Null when unlimited

Example:

48760