Plan and usage

This workspace's plan, its usage this period, and whether we are delivering conversions to its destinations.

Authentication

X-Workspace-Idstring
API Key authentication via header

Response

Successful Response
planenum or null

A workspace’s pricing tier.

There is no Free tier: an unsubscribed workspace has no subscription row at all, and its events are tracked and reported but never dispatched.

statusenum or null

Lifecycle state of a workspace subscription. A Free workspace’s row is active with no provider subscription.

billing_intervalenum or null
A subscription's billing cadence.
usageinteger or null
capinteger or null
percentdouble or null
dispatchingboolean
auto_upgradeboolean
current_period_enddatetime or null
trial_enddatetime or null
cancel_at_period_endboolean
pending_planenum or null

A workspace’s pricing tier.

There is no Free tier: an unsubscribed workspace has no subscription row at all, and its events are tracked and reported but never dispatched.

pending_intervalenum or null
A subscription's billing cadence.
pending_downgrade_atdatetime or null

Errors

422
Unprocessable Entity Error