Skip to main content
GET
Retrieve credit usage
0 credits Requires logs:read permission. See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Response

Current credit usage

credits_remaining
integer
required

Credits available to your organization right now.

Example:

41250

period
object | null
required

The current monthly credit period, or null when your organization has no monthly credits or billing is paused.

next_refill
object | null
required

The next monthly refill, or null when no refill is scheduled. While billing is paused, this is when billing resumes.

auto_topup
object
required

Auto-Topup settings and spend.

plan
object | null
required

Your current plan and its request limits, or null when your organization has no credit account. Its monthly credit allowance is next_refill.credits.

request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

plans_url
string<uri>

Page that describes the available plans and their prices. Sent only when the request includes the header X-Context-Plan-Offers: include.

Example:

"https://www.context.dev/pricing"

key_metadata
object

Credits this request used and your remaining balance.