Skip to main content
GET
Get the credit wallet

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Response

Success

The credit balance. Amounts are decimal strings, not numbers, so they survive a round trip without floating-point drift.

account_id
integer

The account.

available_credits
string

Credits free to spend now.

held_credits
string

Credits reserved against work in flight and not yet settled.

total_credits
string

Available plus held.

peg_dollars
string

What one credit is worth in dollars.

resolution_reference_dollars
string

The reference price a resolution is quoted against.

dollar_anchor
string

Dollar anchor used to convert the balance for display.

resolution_anchor
string

Resolution anchor used for the same conversion.

source_state
string

Whether the provider had a balance to report.

fetched_at
string

ISO-8601 time the balance was read.

dunning_state
string | null

Set when the account is in collections.

pending_top_up
boolean

True while a top-up is still settling.

pending_outbox_events
boolean

True when usage events have not yet reached the balance, so it may read low.

top_up_limits
object

Accepted range for a manual top-up, in cents.

buckets
object[]

The balance split by where the credits came from — free_ai, purchased and so on. Free buckets are spent first.