Skip to main content
GET
Get the AI credit summary

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Response

200 - application/json

Successful Response

contracted
boolean
required

Whether Statisfy has set up your credit contract. When false, usage is counted from the start at the default rates, and the period, allotment and remaining credits are null

is_overused
boolean
required

Whether total_used is more than total_allotted

overused_by
number | null
required

The credits used over the allotment; null when not overused

period_end
string<date-time> | null
required

The end of the current contract period (exclusive)

period_start
string<date-time> | null
required

The start of the current contract period

rates
Rates · object
required

The credits one call costs, per tier

remaining
number | null
required

total_allotted minus total_used; below 0 when overused

total_allotted
number | null
required

The credits the contract gives for the period

total_used
number
required

The credits used in the period