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 your numlookupapi account (team).
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 and a grace bucket.
Name
quotas.month
Type
object
Description
Your monthly request quota: total (the quota included in your plan), used (requests consumed this month) and remaining (requests left this month, always total - used).
Name
quotas.grace
Type
object
Description
Your grace quota with the same total, used and remaining fields. The grace quota is a temporary allowance we grant while there is an issue with your subscription payment, so your integration keeps working until the payment is completed. While a grace quota is active, requests count against it instead of your monthly quota. If no grace period is active, all values are 0.
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.numlookupapi.com/v1/status \
    -H "apikey: YOUR-API-KEY"

Response

{
    "account_id": 313373133731337,
    "account_id_str": "313373133731337",
    "quotas": {
        "month": {
            "total": 100,
            "used": 72,
            "remaining": 28
        },
        "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.numlookupapi.com/upgrade?utm_source=agent&utm_campaign=status&team=313373133731337",
        "plans_url": "https://api.numlookupapi.com/v1/agent/plans"
    }
}