Skip to main content
GET
Get credit balance

Authorizations

X-API-Key
string
header
required

Response

Current credit state.

auto_recharge_enabled
boolean
required
auto_recharge_monthly_limit
integer
required
Required range: x >= 0
auto_recharge_pack
string
required
auto_recharge_threshold
integer
required
Required range: x >= 0
credits
integer
required
Required range: x >= 0
current_period_end
string | null
required
has_subscription
boolean
required
is_unlimited
boolean
required
monthly_credits
integer | null
required
Required range: x >= 0
plan
string
required
purchased_credits
integer
required
Required range: x >= 0
subscription_credits
integer
required
Required range: x >= 0
updated_at
string
required
used_credits
integer
required
Required range: x >= 0
used_purchased_credits
integer
required
Required range: x >= 0
used_subscription_credits
integer
required
Required range: x >= 0
builds_allowance
integer | null

Builds, revisions and rebuilds included in the current period. Null when volume is agreed by contract.

Required range: x >= 0
builds_remaining
integer | null

builds_allowance minus builds_used, or null when builds_allowance is null.

Required range: x >= 0
builds_used
integer

Builds, revisions and rebuilds counted in the current period.

Required range: x >= 0
daily_run_cap
integer | null

Runs allowed per UTC day, or null for no cap.

Required range: x >= 1
payment_status
enum<string>
Available options:
ok,
past_due,
action_required
period_start
string | null

Start of the current metering period.

plan_id
enum<string>

Stable plan identifier. The enterprise id is shown as Business in the plan label.

Available options:
free,
pro,
enterprise
runs_allowance
integer | null

Runs included per period; same value as monthly_credits.

Required range: x >= 0
runs_remaining
integer

Runs available now, including purchased run packs; same value as credits.

Required range: x >= 0
runs_today
integer

Runs counted against the daily cap this UTC day.

Required range: x >= 0
usage_alerts
integer[]
Required range: 1 <= x <= 100
monthly_summary
boolean