Account and integration status
Read your workspace's credits, plan, limits and auto-reload, and whether each part of your integration is working, in one call each.
Two reads tell you where your workspace stands. Account status returns its credits, plan, limits and auto-reload. Integration status checks each part of your integration and says what to do next when something needs attention. Both work with any credential that holds operations:general, API keys included, and neither changes anything.
Examples on this page use a server client:
import { AbuseZero } from "abusezero/server";
const abusezero = new AbuseZero({ key: process.env.ABUSEZERO_SECRET_KEY!, outage: "throw" });The account status object
{
"object": "account_status",
"workspace": "56532404670088059435",
"plan": {
"plan": "pro",
"name": "Pro",
"interval": "month",
"enterprise": false,
"renews_at": "2026-12-01T00:00:00.000Z",
"ends_at": null
},
"credits": {
"available": 3000,
"allowance": 600,
"pay_as_you_go": 2400,
"per_evaluation": 5,
"evaluations_left": 600,
"state": "ok"
},
"limits": {
"protected_benefits": { "used": 3, "limit": 10 },
"custom_policies": { "used": 2, "limit": 100 },
"team_seats": { "used": 2, "limit": 5 },
"retention_days": 90,
"rate": 50
},
"auto_reload": { "enabled": true }
}| Field | Type | Description |
|---|---|---|
object | "account_status" | The object type. |
workspace | string | The workspace ID. |
plan.plan | payg, pro or scale | The plan. payg is Builder. |
plan.name | string | The plan's name: Builder, Pro or Scale. |
plan.interval | month, year or null | How often the plan renews. null on Builder. |
plan.enterprise | boolean | true when an Enterprise plan applies to the workspace as well. |
plan.renews_at | string or null | When the plan renews next. null on Builder, and when the plan is set to end. |
plan.ends_at | string or null | When the plan ends, after a cancellation. null otherwise. |
credits.available | integer | Every credit the workspace can use now. |
credits.allowance | integer | Allowance credits: the part of available that came with a Pro or Scale subscription or an Enterprise plan, for a period. They're used first. |
credits.pay_as_you_go | integer | Pay-as-you-go credits: the part of available the workspace bought, and the other credits that stay with it. |
credits.per_evaluation | integer | Credits each evaluation uses. |
credits.evaluations_left | integer | How many evaluations available covers. |
credits.state | ok, low or exhausted | low when credits are running low, as the dashboard's credits banner shows it. exhausted when there aren't enough for one more evaluation, so new evaluations are skipped. |
limits.protected_benefits | object | Protected benefits: how many the workspace has, and how many its plans allow. |
limits.custom_policies | object | Custom policies: how many the workspace has, and how many it may have. |
limits.team_seats | object | Team seats: how many are in use, the owner included, and how many the plans allow. |
limits.retention_days | integer | The longest data retention the plans allow, in days. |
limits.rate | integer | The workspace's traffic limit, in evaluations a second. |
auto_reload.enabled | boolean | Whether auto-reload is on. |
Read account status
| Method | Path | Scope | Idempotency-Key |
|---|---|---|---|
GET | /v1/account-status | operations:general | Not used |
Also available as abusezero account-status get in the AbuseZero CLI, abusezero_get_account_status on the AbuseZero MCP server and accountStatus() in the AbuseZero Node.js SDK.
Example
const status = await abusezero.accountStatus();Response
Returns 200 with an account status object.
Errors
| Code | Status | Meaning |
|---|---|---|
WORKSPACE_SUSPENDED | 403 | The workspace is suspended. This read is refused like every other request, so the error itself is the status. |
For every other code, see REST API errors.
The integration status object
{
"object": "integration_status",
"status": "attention",
"api_keys": { "state": "ok", "next_step": null },
"browser_script": { "state": "ok", "next_step": null },
"evaluations": { "state": "ok", "next_step": null },
"outcomes": {
"state": "missing",
"next_step": "Some claims never got an outcome report. Report outcomes for the benefits that wait for them."
},
"webhooks": { "state": "not_set_up", "next_step": null },
"credits": { "state": "ok", "next_step": null },
"checked_at": "2026-11-10T09:15:00.000Z"
}| Field | Type | Description |
|---|---|---|
object | "integration_status" | The object type. |
status | ok or attention | attention when at least one part has a next_step. |
api_keys, browser_script, evaluations, outcomes, webhooks, credits | object | Each part's state, below, and its next_step: what to do, in one sentence, or null when there's nothing to do. Read the state in code, and show the next_step to a person. |
checked_at | string | When the status was read. |
States
| Part | State | Meaning |
|---|---|---|
api_keys | ok | The workspace has an active secret or restricted key. |
none | The workspace has no active secret or restricted key. | |
expiring | An active key expires within 14 days. | |
refused | A revoked or expired key was sent in the last 7 days. | |
browser_script | ok | The browser script is seen on your sites, with no issue. |
not_set_up | No site is listed, and the script hasn't been seen. | |
not_passed_on, site_not_listed, sdk_outdated, script_missing | The browser collection issue to fix. | |
evaluations | ok | Evaluations are arriving. |
none_yet | The workspace hasn't evaluated a claim yet. | |
stopped | Evaluations arrived every day, then none in the last 24 hours. | |
idle | No evaluations in the last 7 days. | |
outcomes | ok | Outcome reports are arriving for the benefits that wait for them. |
not_needed | No benefit waits for outcome reports. | |
missing | In the last 7 days, some claims passed their due_at without a report. | |
webhooks | ok | Every endpoint is delivering. |
not_set_up | The workspace has no webhook endpoint. Nothing to do unless you want one. | |
failing | An endpoint's recent deliveries are failing. | |
disabled | Webhook delivery is unavailable for the workspace, or an endpoint was disabled after repeated failures. Read next_step for the reason. | |
unavailable | Webhook status could not be checked. Try again in a moment; the other status checks still apply. | |
daily_limit | Today's deliveries reached the daily limit. | |
credits | ok | Credits are fine. |
low | Credits are running low. | |
exhausted | There aren't enough credits for one more evaluation. | |
payment_overdue | A payment didn't go through. |
New states can be added within v1. Treat a state you don't recognize like any state other than ok, and show its next_step.
Read integration status
| Method | Path | Scope | Idempotency-Key |
|---|---|---|---|
GET | /v1/integration-status | operations:general | Not used |
Also available as abusezero integration-status get in the AbuseZero CLI, abusezero_get_integration_status on the AbuseZero MCP server and integrationStatus() in the AbuseZero Node.js SDK.
Example
const status = await abusezero.integrationStatus() as { status: string };
if (status.status === "attention") {
// Each part with a next_step needs attention.
}Response
Returns 200 with an integration status object.
Errors
| Code | Status | Meaning |
|---|---|---|
WORKSPACE_SUSPENDED | 403 | The workspace is suspended. |
For every other code, see REST API errors.
Related
How is this guide?
Last updated on