Status Endpoint

The status endpoint returns information about your current quota and the plan of your account.

Requests to this endpoint do not count against your quota or rate limit.

GET/v3/status

Check API Status

This status endpoint returns information about your current quota and the plan of your account.

Response Properties

Name
account_id
Type
integer
Description
Your account id.
Name
account_id_str
Type
string
Description
The same id as account_id, as a string for JavaScript clients, whose numbers lose precision above 2^53.
Name
quotas
Type
object
Description
Contains information about your request quota, split into a month bucket (your regular plan quota) and a grace bucket (a temporary buffer granted when a subscription payment fails — while it is active, requests count against it instead of the month bucket; for accounts in good standing it is all zeroes).
Name
quotas.month.total
Type
integer
Description
Your total monthly request quota.
Name
quotas.month.used
Type
integer
Description
Requests used in the current month.
Name
quotas.month.remaining
Type
integer
Description
Requests remaining in the current month.
Name
quotas.grace
Type
object
Description
The grace quota bucket with the same total / used / remaining fields.
Name
plan
Type
object
Description
The plan of the account: name, interval, price_id, free, custom, status (of the subscription, e.g. active), renews_at, scheduled (a plan change that starts later, or null), upgrade_url (null for a custom plan) and plans_url (every plan as JSON). Use it to check that an upgrade took effect.

Request

GET

/v3/status

curl -G https://api.currencyapi.com/v3/status \
    -H "apikey: YOUR-API-KEY"

Response

{
  "account_id": 313373133731337,
  "account_id_str": "313373133731337",
  "quotas": {
    "month": {
      "total": 300,
      "used": 72,
      "remaining": 228
    },
    "grace": {
      "total": 0,
      "used": 0,
      "remaining": 0
    }
  },
  "plan": {
    "name": "free",
    "interval": "month",
    "price_id": "price_1AbCdEfGhIjKlMnOpQrStUvW",
    "free": true,
    "custom": false,
    "status": "active",
    "renews_at": "2026-11-01T00:00:00+00:00",
    "scheduled": null,
    "upgrade_url": "https://app.currencyapi.com/upgrade?utm_source=agent&utm_campaign=status&team=313373133731337",
    "plans_url": "https://api.currencyapi.com/v1/agent/plans"
  }
}