VAvaquill
Credits

Get your credit balance

Changed on

Returns the credits this API key's account can spend right now, derived from your live credit buckets under the same expiry rule the billing path applies. Free, never charged, and open to any valid vq_key_ key (no scope required), so you can poll it for alerting or a pre-flight check. It is rate limited like every other key-authenticated route; see the rate-limit docs for the X-RateLimit-* headers.

creditsRemaining is the same field name metered responses use. Credits are how much you may spend and rateLimit is how fast you may call; the two are independent. Read bySource and nextExpiry before assuming a balance is durable.

get/api/v1/credits/balance

Request

Response

Current spendable balance for the calling key's account.

creditsRemainingnumber 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.

usdRemainingnumber 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.

planstring nullable

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.

totalPurchasednumber required

Lifetime credits added to this account.

totalConsumednumber required

Lifetime credits spent by this account.

asOfstring date-time required

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

Example response

{
  "creditsRemaining": 103039,
  "usdRemaining": 1030.39,
  "bySource": [
    {
      "source": "payg",
      "credits": 1030.43
    }
  ],
  "nextExpiry": {
    "at": "2026-10-01T00:00:00Z",
    "credits": 500
  },
  "plan": "business",
  "totalPurchased": 150000,
  "totalConsumed": 46961,
  "rateLimit": {
    "perMinute": 150,
    "perHour": 2000,
    "perDay": 10000
  }
}

Changes