Skip to main content
GET
Get credit status

Authorizations

Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Path Parameters

id
string
required

Organization ID

Response

Credit status retrieved successfully

remainingCredits
number
required

Credits the organization can still spend.

monthlyCredits
number
required

Allowance of the active subscription, or the FREE plan allowance when there is none.

isLowCredits
boolean
required

True when a subscription is active and remainingCredits has reached the organization's warning threshold.

isExhausted
boolean
required