Skip to main content
GET
Get current plan and usage

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Site Spy dashboard under Settings → API.

Response

Plan and usage information

plan
enum<string>
Available options:
free,
starter,
pro,
business,
pro_trial,
pro_legacy
Example:

"free"

check_budget
object | null

Check credits spent this period. A check costs the heaviest fetch stage it needed: 1 for a plain fetch, 2 for a browser, 5 for an anti-bot solver. Reliability retries and system rechecks are free. budget and percent_used appear only once budgets are announced.

features
object

Which plan-gated features this account has

next_plan
string | null

The plan an upgrade would move this account to, or null at the top

limits
object
usage
object
billing
object
trial
object | null
email_verified
boolean

Whether the account email has been verified

created_at
integer | null

Unix timestamp of account creation (null for guest API keys)

pmf_submitted
boolean

Whether the user has already submitted the PMF survey

has_detected_change
boolean

Whether at least one of the user's watches has fired a change notification