Credit Balance API

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

0 credits per request

Try in Playground Get your API key — free Read 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, and rateLimitPerMinute. snake_case aliases (monthly_quota, …) are emitted for one release — prefer camelCase. Free — does not consume credits. Use for low-balance alerts and dashboards.

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

API keyoptionalPaste your key to get a ready-to-run snippet. It stays in your browser.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": null,
    "monthly_quota": 100,
    "subscription_credits": 0,
    "topup_credits": 9599,
    "total_credits": 9599,
    "subscription_renews_at": null
  }
}

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, cached, creditsUsed, and a data object with the following fields:

Top-level fields

planPlan. Example: "free".
monthlyQuotaPlan monthly subscription credit allotment (e.g. free=100).
subscriptionCreditsRemaining subscription credits (reset at quotaResetsAt / subscriptionRenewsAt).
topupCreditsRemaining purchased top-up credits (never expire).
totalCreditssubscriptionCredits + topupCredits.
subscriptionRenewsAtSubscription renews at.
usedThisMonthSum of creditsUsed on requests since the current billing window (or last 30 days).
quotaResetsAtWhen subscription credits renew — same value as subscriptionRenewsAt when set.
keyNameDisplay name of the calling API key when set; null for session JWT calls.
rateLimitPerMinutePlan RPM ceiling enforced by Captapi (not GitHub/etc.).
rateLimitRemainingAlways null on this endpoint — RPM remaining is per Redis window, not snapshotted here.
monthly_quotaDeprecated snake_case alias of monthlyQuota — prefer camelCase.
subscription_creditsDeprecated snake_case alias of subscriptionCredits.
topup_creditsDeprecated snake_case alias of topupCredits.
total_creditsDeprecated snake_case alias of totalCredits.
subscription_renews_atDeprecated snake_case alias of subscriptionRenewsAt.

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. Sign up — get 100 free credits, no card required.
2. Create a key from your dashboard.
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.

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 API Daily Usage API Most Used Routes API

Ready to use the Credit Balance API?

Get started free