Skip to main content
GET
Get your credit balance

Authorizations

Authorization
string
header
required

API key issued from the developer dashboard. Pass as Authorization: Bearer vq_key_... (preferred).

Response

Current spendable balance for the calling key's account.

Spendable credit balance for the calling API key's account.

creditsRemaining
number
required

Credits you can actually spend right now, the same field name metered responses return. Derived from your live credit buckets under the billing path's expiry rule, so it never promises credits a call would refuse to spend.

Example:

103039

usdRemaining
number
required

creditsRemaining in USD, at the published conversion rate (1 credit = $0.01). Provided so you do not have to hardcode the rate; GET /api/v1/api-credits/pricing is its source of truth.

Example:

1030.39

totalPurchased
number
required

Lifetime credits added to this account.

Example:

150000

totalConsumed
number
required

Lifetime credits spent by this account.

Example:

46961

asOf
string<date-time>
required

When this balance was computed. The value is live, not cached, so this is the instant the buckets were read.

bySource
CreditSourceBreakdown · object[]

creditsRemaining split by funding source; always sums to it. subscription credits are use-it-or-lose-it at the period end, while payg credits you bought persist and burn last.

nextExpiry
CreditExpiry · object | null

The soonest expiry across your credits, or null if none expire: what is about to be forfeited and when, which a balance alone cannot show.

plan
string | null

Active API subscription tier, or null on pay-as-you-go. Also determines your rate-limit multiplier. Briefly cached, so a subscription change made seconds ago may not be reflected yet; creditsRemaining is always live.

Example:

"business"

rateLimit
CreditRateLimit · object | null

How fast this key may call, with your plan already applied, so you can size a client before issuing a request. Independent of credits: a healthy balance does not exempt you from these. The X-RateLimit-* headers on every response report the same ceilings plus your live headroom.