---
title: "Check credit balance and plan status"
method: GET
path: "/quota"
tags: ["Quota"]
---

# Check credit balance and plan status

`GET /quota`

Returns the current plan, remaining credits, and billing status for the authenticated account. Read-only — never consumes a credit.

- **Works even when the credit pool is exhausted.** Unlike other endpoints, `/quota` is exempt from the "insufficient credits" block, so you can always check your balance.
- Response payload is identical to the MCP tool `get_quota_info`.

## Response `200`

Quota returned successfully

- QuotaResponse — Successful quota/credit balance response
  - `success` boolean, required — Always true for 200 responses
  - `data` QuotaData, required — Credit balance and plan status for the authenticated account
    - `plan` string, required — Current plan name, or "unknown" if the account has no active subscription
    - `remainingCredits` integer, required — Credits available for new lookups in the current billing period
    - `billingStatus` 'active' | 'free', required — Billing status of the account
    - `userId` string, uuid, required — Unique identifier of the user
    - `email` string, email, required — Email address associated with the account

## Other responses

- `401` — Missing or invalid API Key
- `403` — Inactive user account
- `500` — Internal server error (subscription lookup failed)

---

[API](https://skmtc.dev/cpfhub/apis/cpfhub-io-api.md) · [All operations](https://skmtc.dev/cpfhub/apis/cpfhub-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cpfhub/cpfhub-io-api/revisions/b3a713b2361a/schema)
