---
title: "Credit Balance API"
method: GET
path: "/v1/account/balance"
tags: ["Account"]
---

# Credit Balance API

`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`

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

## Response `200`

Success. The data object for this endpoint.

- object
  - `success` unknown, required
  - `data` object, required
    - `plan` string: Plan. Example: "free".
    - `monthlyQuota` integer: Plan monthly subscription allotment (e.g. free=100). Not a cap on usedThisMonth, which also counts top-up spend.
    - `subscriptionCredits` integer: Remaining subscription credits (reset at quotaResetsAt / subscriptionRenewsAt). This is the quota account — not monthlyQuota − usedThisMonth.
    - `topupCredits` integer: Remaining purchased top-up credits (never expire).
    - `totalCredits` integer: subscriptionCredits + topupCredits.
    - `subscriptionRenewsAt` unknown
    - `usedThisMonth` integer: All credits spent this billing window (subscription + top-up). Different account from monthlyQuota — do not subtract the two.
    - `quotaResetsAt` unknown
    - `keyName` string: Display name of the calling API key when set; null for session JWT calls.
    - `rateLimitPerMinute` integer: Plan RPM ceiling enforced by Captapi (not GitHub/etc.).
    - `rateLimitRemaining` integer: Requests left in the current 60s window after this call. Null only when the limiter is unreachable.

## Other responses

- `400`: Bad request: wrong platform URL, unknown endpoint, or an invalid parameter value. Not billed.
- `401`: Missing, invalid or revoked API key. Not billed.
- `402`: Not enough credits for this request. Not billed.
- `404`: The resource does not exist or is not public. Not billed.
- `422`: A required parameter is missing or has the wrong type. Not billed.
- `429`: Rate limit reached. Wait for Retry-After seconds. Not billed.
- `502`: The platform could not be reached or returned nothing usable. Retryable, not billed. 503 and 504 use the same envelope.

---

[API](https://skmtc.dev/captapi/apis/captapi-api.md) · [All operations](https://skmtc.dev/captapi/apis/captapi-api/llms.txt) · [OpenAPI document](https://skmtc.dev/captapi/apis/captapi-api/revisions/c9b9ac5ff1bd?raw)