Skip to main content
GET
Get the current consumption balance

Authorizations

X-Api-Key
string
header
required

Headers

X-Api-Key
string
required

API key for authentication

Response

Success

Current billing period balance for the company

includedCredits
number<double>

Credits included in the current billing period

consumedCredits
number<double>

Credits consumed so far in the current billing period

remainingCredits
number<double>

Credits remaining in the current billing period. Published as-is, including negative values when consumption exceeds the included credits.

usagePercent
number<double>

Usage as a percentage of the included credits. Published as-is, including values above 100.

periodStart
string<date-time>

Start of the current billing period (UTC)

periodEnd
string<date-time>

End of the current billing period, i.e. the date the credits recharge (UTC)

status
string | null

Subscription status for the current period (e.g. Active, PastDue, Paused, Cancelled)