Account

Credit Balance API

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

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.

Docs: https://captapi.com/apis/account-balance

get/v1/account/balance

Request

  • Base URL: https://api.captapi.com
  • URL: https://api.captapi.com/v1/account/balance
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Response

Success. The data object for this endpoint.

successunknown required

Changes

No recorded changes to this operation across all 3 revisions of this API.