Skip to main content
GET
Get credit balance
Returns your team’s credit position for the current billing period. This is the endpoint to poll if you want to alert before your team runs out.

Endpoint

Example Request

Response

Fields

credits_remaining can be negative. A run that overshoots the remaining balance is not rolled back mid-execution, so a team can finish a period slightly below zero.

Alerting Example

To see what consumed the credits, use List credit logs.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Balance returned.

credits_limit
integer
required

Credits included in the plan for the current period.

credits_used
integer
required

Credits consumed so far this period.

credits_remaining
integer
required

credits_limit minus credits_used. Can be negative: a run that overshoots is not rolled back.

tier
string
required

Current plan.

billing_period_end
integer<int64> | null

When the period ends and usage resets, in Unix seconds.