Spectate API

The team's plan, subscription, notification credits and how much of the plan's limits it uses. Read only: subscriptions and credit packs are bought and changed in the dashboard. Needs billing:read, which only owners and billing members can grant.


Get billing

GET
https://api.spectate.net/v1
/billing

Returns the plan, the subscription and the SMS and voice notification credits.

Get billing › Responses

The billing state.

The team's billing state. Subscriptions are changed in the dashboard.
plan
​Plan · enum · required

The plan whose limits apply now: the trial plan during the trial, none without a plan

none
No paid plan and no trial: monitoring is paused until the team subscribes.
starter
Starter: up to 3 members and 1 status page, the team default escalation path only.
team
Team: unlimited members, 5 status pages, on-call, more escalation paths and private status pages.
business
Business: everything in Team, with unlimited status pages and more subscribers and notification credits.
Enum values:
none
starter
team
business
subscribed
​boolean · required

Whether the team has a paid subscription

on_trial
​boolean · required

Whether the team is on its trial

trial_ends_at
​string | null · date-time · required

When the trial ends; null without one

plan_ends_at
​string | null · date-time · required

End of a plan Spectate granted without a subscription; null without one

​required
​NotificationCredits · required

SMS and voice notification credits


Get plan usage

GET
https://api.spectate.net/v1
/billing/usage

Returns, per plan limit, how much the team uses and the limit. Useful before creating resources in bulk.

Get plan usage › Responses

Usage per plan limit.

How much of the plan's limits the team uses.
​UsageLimit · required

Monitors and hosts together; on paid plans the limit is the quantity paid for

​UsageLimit · required

Monitored domains

​UsageLimit · required

Projects

​UsageLimit · required

Status pages

​UsageLimit · required

Confirmed subscribers of all status pages together; at the limit the pages take no new subscribers

​UsageLimit · required

Escalation paths, including the team default path

​UsageLimit · required

Members plus pending invites