Skip to main content
GET
Get a workspace's plan and usage

Authorizations

Authorization
string
header
required

A session token from subscriber login, used by subscriber.dev's own apps. Requests about an environment also need its ID in the x-environment-id header. From your own code, use an API key.

Path Parameters

workspaceId
string
required

Response

enabled
boolean
required

False when billing is off, e.g. on a self-hosted install.

plan
enum<string>
required

The current plan, e.g. "growth".

Available options:
free,
starter,
growth,
scale,
pro,
business
interval
enum<string> | null
required
Available options:
month,
year
status
string | null
required

Stripe subscription status, e.g. "active" or "past_due".

currentPeriodEnd
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
cancelAtPeriodEnd
boolean
required
usage
object
required
overLimit
boolean
required
ceiling
number
required

Sends to subscribers past this aren't sent until an upgrade: the free plan's limit, or one plan up for paid plans.

movesUpOn
string<date-time> | null
required

When an over-limit paid workspace moves up one plan (3 days after going over); null when not over.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
planAtRenewal
string | null
required

The plan this workspace moves to at its next renewal, from its subscriber count; "custom" above the largest plan; null when it stays the same.