Get current plan and usage
curl --request GET \
--url https://api.sitespy.app/api/v1/plan \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sitespy.app/api/v1/plan"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sitespy.app/api/v1/plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"plan": "free",
"limits": {
"max_watches": 5,
"history_retention_days": 30,
"max_snapshots_per_watch": 5,
"min_check_interval_seconds": 21600,
"default_check_interval_seconds": 3600,
"max_fast_watches": 0,
"max_check_interval_seconds": 604800,
"label": "Free",
"price_monthly": 0
},
"usage": {
"watches": 3,
"fast_watches": 0
},
"billing": {
"subscription_status": "active",
"ls_subscription_id": "<string>",
"ls_customer_portal_url": "<string>",
"current_period_end": "<string>"
},
"trial": {
"trial_ends_at": 123,
"trial_active": true,
"days_remaining": 123
},
"email_verified": true,
"created_at": 123,
"pmf_submitted": true,
"has_detected_change": true
}Plan
Get current plan and usage
Returns the subscription plan, limits, and watch usage for the authenticated API key.
GET
/
plan
Get current plan and usage
curl --request GET \
--url https://api.sitespy.app/api/v1/plan \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sitespy.app/api/v1/plan"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sitespy.app/api/v1/plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"plan": "free",
"limits": {
"max_watches": 5,
"history_retention_days": 30,
"max_snapshots_per_watch": 5,
"min_check_interval_seconds": 21600,
"default_check_interval_seconds": 3600,
"max_fast_watches": 0,
"max_check_interval_seconds": 604800,
"label": "Free",
"price_monthly": 0
},
"usage": {
"watches": 3,
"fast_watches": 0
},
"billing": {
"subscription_status": "active",
"ls_subscription_id": "<string>",
"ls_customer_portal_url": "<string>",
"current_period_end": "<string>"
},
"trial": {
"trial_ends_at": 123,
"trial_active": true,
"days_remaining": 123
},
"email_verified": true,
"created_at": 123,
"pmf_submitted": true,
"has_detected_change": true
}Authorizations
API key for authentication. You can find your API key in the Site Spy dashboard under Settings → API.
Response
Plan and usage information
Available options:
free, starter, pro, business, pro_trial Example:
"free"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Whether the account email has been verified
Unix timestamp of account creation (null for guest API keys)
Whether the user has already submitted the PMF survey
Whether at least one of the user's watches has fired a change notification

