Skip to main content
GET
cURL

Authorizations

​
X-API-Key
string
header
required

Response

200 - application/json

Successful Response

Information about the current balance of Credits and usage.

​
remaining
integer
required

Remaining credits not yet used.

​
expiring
integer
required

Credits that will expire in the future.

​
used
integer
required

Credits used in the current billing period.

​
workspace_credits
Workspace Credits · object | null

DEPRECATED: use workspace_credit_pool[id].available instead. Available credits for each workspace mapped by workspace_id. Only included if user is in a workspace.

​
workspace_credit_pool
Workspace Credit Pool · object | null

Per-workspace credit pool usage (used/allocated/available) keyed by workspace_id. Only included if user is in a workspace.