Skip to main content
GET
Get billing subscription status

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

200 - application/json

Billing status

plan
enum<string>

The plan in force (a cancelled subscription keeps its plan until ends_at)

Available options:
free,
starter,
pro,
business,
pro_trial,
pro_legacy
subscription_status
string | null
ls_subscription_id
string | null
current_period_end
string | null
ends_at
string | null

When a cancelled subscription stops being paid for

billing_period
enum<string> | null

How the subscription is billed; null without one

Available options:
monthly,
yearly