Status Endpoint

The status endpoint returns your account details, plan information, and current API usage for the billing period.

Endpoint

GET /status

Request example

curl -X GET "https://api.usercheck.com/status" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Success response (200)

{
  "status": "success",
  "account": {
    "plan": {
      "name": "Pro 200K",
      "credits": 200000,
      "rate_limit": 5
    },
    "user": {
      "name": "Jane Doe",
      "email": "[email protected]"
    }
  },
  "usage": {
    "limit": 200000,
    "current": 48320,
    "remaining": 151680,
    "reset_at": "2026-04-01T00:00:00.000000Z"
  }
}

Response fields

Field	Type	Description
status	string	Status of the request: "success", or "error" on a failed request.
account.plan.name	string	The name of your current plan (e.g., "Pro 1.5M").
account.plan.credits	integer	Total number of credits included in your plan per billing period.
account.plan.rate_limit	integer	Maximum number of requests per second allowed by your plan. See Rate Limits.
account.user.name	string	The name of the account holder.
account.user.email	string	The email address of the account holder.
usage.limit	integer	Total usage limit for the current billing period.
usage.current	integer	Number of credits used so far in the current billing period.
usage.remaining	integer	Number of credits remaining in the current billing period.
usage.reset_at	string	ISO 8601 timestamp indicating when the usage counter resets for the next billing period.

Error responses

Unauthorized (401)

{
  "status": "error",
  "message": "Unauthorized"
}

message is "Unauthorized" when the request carried no API key, and "Invalid API key" when the key is not recognized.

Rate limit exceeded (429)

The status endpoint has its own limit of 30 requests per minute, separate from your plan's rate limit. Requests beyond it return 429 Too Many Requests.