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.
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, split into a
monthand agracebucket.
- Name
quotas.month- Type
- object
- Description
Your regular monthly request quota. Resets at the start of each billing month.
- Name
quotas.grace- Type
- object
- Description
A temporary grace quota that keeps your integration running while a subscription payment is still being processed. All values are 0 unless a grace allowance is currently active.
- 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, ornull),upgrade_url(nullfor a custom plan) andplans_url(every plan as JSON). Use it to check that an upgrade took effect.
Each quota bucket contains the same three fields:
- Name
total- Type
- integer
- Description
The total number of requests included in this bucket.
- Name
used- Type
- integer
- Description
The number of requests you have already used in this bucket.
- Name
remaining- Type
- integer
- Description
The number of requests left in this bucket (
total - used).
Request
curl -G https://api.screenshotbase.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.screenshotbase.com/upgrade?utm_source=agent&utm_campaign=status&team=313373133731337",
"plans_url": "https://api.screenshotbase.com/v1/agent/plans"
}
}