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/v1/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
The ID of the account the API key belongs to.
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. The month bucket reflects your regular monthly quota; the grace bucket is only relevant while a grace quota is active on your account.
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

/v1/status

curl -G "https://api.zipcodestack.com/v1/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.zipcodestack.com/upgrade?utm_source=agent&utm_campaign=status&team=313373133731337",
        "plans_url": "https://api.zipcodestack.com/v1/agent/plans"
    }
}