CaptapiCaptapi
CaptAPICaptAPI Account
GET /v1/account/balance

Credit Balance API

Plan, subscription vs top-up credits, monthly quota, and renewsAt — 0 credits.

0 credits per request
Try in PlaygroundGet your API key — freeRead the docs
TL;DR
Plan, subscription vs top-up credits, monthly quota, and renewsAt — 0 credits. The Credit Balance API (CaptAPI Account) is a single authenticated GET request to /v1/account/balance that responds with clean JSON and costs 0 credits. Account endpoints are always live (never cached). Start with 100 free credits — no credit card.

What is the Credit Balance API?

Live (never cached) credit balance for the calling Captapi key as camelCase JSON: plan, monthlyQuota, subscriptionCredits, topupCredits, totalCredits, subscriptionRenewsAt / quotaResetsAt, usedThisMonth, keyName, rateLimitPerMinute, and rateLimitRemaining. usedThisMonth is all spend (subscription + top-up) — not comparable to monthlyQuota, which is the plan's subscription allotment only. Remaining subscription is subscriptionCredits; remaining top-up is topupCredits. Free — does not consume credits.

What you get

  • Live data for your Captapi API key (never cached)
  • No credit charge for account endpoints
  • Clean JSON ready for dashboards and low-balance alerts
  • Useful for monitoring usage and spend

Try it

Open in Playground

Fill in the parameters below and copy a ready-to-run request, or open the live Playground to run it against your account (no API key paste).

Parameters

Sign in to run live
curl "https://api.captapi.com/v1/account/balance" \
  -H "Authorization: Bearer capt_live_..."
# or: -H "x-api-key: capt_live_..."

Edit the parameters and the code updates instantly. Switch languages and hit copy.

Example response

{
  "success": true,
  "data": {
    "plan": "free",
    "monthlyQuota": 100,
    "subscriptionCredits": 0,
    "topupCredits": 9599,
    "totalCredits": 9599,
    "subscriptionRenewsAt": null,
    "usedThisMonth": 498,
    "quotaResetsAt": null,
    "keyName": "production",
    "rateLimitPerMinute": 40,
    "rateLimitRemaining": 39
  }
}

Billing metadata is returned in response headers: X-Captapi-Credits (credits charged), X-Captapi-Cache (hit or miss), and X-Captapi-Source. Failed requests (4xx/5xx) are never charged. See the full list of error codes in the error reference.

Response structure

A successful call returns success and a data object with the following fields:

Top-level fields

  • planPlan. Example: "free".
  • monthlyQuotaPlan monthly subscription allotment (e.g. free=100). Not a cap on usedThisMonth, which also counts top-up spend.
  • subscriptionCreditsRemaining subscription credits (reset at quotaResetsAt / subscriptionRenewsAt). This is the quota account — not monthlyQuota − usedThisMonth.
  • topupCreditsRemaining purchased top-up credits (never expire).
  • totalCreditssubscriptionCredits + topupCredits.
  • subscriptionRenewsAtSubscription renews at.
  • usedThisMonthAll credits spent this billing window (subscription + top-up). Different account from monthlyQuota — do not subtract the two.
  • quotaResetsAtWhen subscription credits renew — same value as subscriptionRenewsAt when set. Null on plans with no renewal timestamp.
  • keyNameDisplay name of the calling API key when set; null for session JWT calls.
  • rateLimitPerMinutePlan RPM ceiling enforced by Captapi (not GitHub/etc.).
  • rateLimitRemainingRequests left in the current 60s window after this call. Null only when the limiter is unreachable.

Parameters

None — authenticate with your Captapi API key only.

Authentication: send your key as Authorization: Bearer capt_live_.... A typical call costs 0 credits. Always live — account endpoints are never cached.

Using an AI agent? This endpoint is the MCP tool account_balance via @captapi/mcp. Set it up →

How it works

  1. 1. Sign up — get 100 free credits, no card required.
  2. 2. Create a key from your dashboard.
  3. 3. Send one request to /v1/account/balance and parse the JSON response.

Use cases

Low-balance alerts

Poll totalCredits / usedThisMonth and page when subscriptionCredits approach zero.

Subscription vs top-up

Tell time-boxed subscriptionCredits apart from permanent topupCredits before auto-buy logic.

Key identity

Read keyName + rateLimitPerMinute for the calling key in ops dashboards.

Frequently asked questions

What does the Credit Balance API do?+

The Credit Balance API returns credit balance for your Captapi API key via one GET request to /v1/account/balance. It returns clean JSON and does not charge credits.

How many credits does the Credit Balance API cost?+

Account endpoints are free — they do not consume credits.

Do I need a CaptAPI Account API key or OAuth?+

You only need your Captapi API key (Authorization: Bearer). No third-party OAuth is required.

Can I subtract usedThisMonth from monthlyQuota?+

No. monthlyQuota is the plan's subscription allotment (e.g. free=100). usedThisMonth is all spend in the window — subscription plus top-ups — so the difference can be largely negative. Remaining subscription is subscriptionCredits; remaining top-up is topupCredits; together they equal totalCredits.

Is the Credit Balance API suitable for production use?+

Yes. It is a stable REST endpoint with predictable JSON. Account endpoints are always live (never cached) and do not charge credits.

More CaptAPI Account APIs

Request History APIDaily Usage APIMost Used Routes API

Ready to use the Credit Balance API?

Sign up, grab your key, and make your first call in 60 seconds.

Get started free
Credit Balance API | Captapi — Captapi