Status Endpoint

Returns your current quota and the plan of your account.

Quota

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

Request Method: GET
Request URL: https://api.vatcheckapi.com/v2/status

Request Parameters

Parameter	Type	Mandatory	Description
apikey	string	️	Your API Key

Sample Request

curl "https://api.vatcheckapi.com/v2/status" \
    -H "apikey: YOUR-APIKEY"

Sample Response

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

The response also has a plan object after quotas: 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.

The month bucket reflects your plan's monthly request quota. The grace bucket is a temporary allowance we may grant your account (for example while a payment is being completed) so your integration keeps working; it is normally 0, and while a grace quota is active your requests count against it instead of the monthly quota.

The plan object shows the plan of your account, so you can check that an upgrade took effect:

Field	Description
name	The plan, e.g. free, small, medium or large
interval	month or year
price_id	The plan's price id
free	Whether the plan is free
custom	A plan made for your account only. It has no upgrade_url
status	The subscription status, e.g. active or past_due
renews_at	When the current period ends (ISO 8601)
scheduled	A plan change that starts later (name, interval, starts_at), e.g. a downgrade at the end of the period; otherwise null
upgrade_url	Opens the plans of your account. null for a custom plan
plans_url	Every plan as JSON

Fields the API cannot determine are null.