Plan and usage | Pivolio Docs

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

X-Workspace-Idstring

API Key authentication via header

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.

Allowed values:

statusenum or null

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

Allowed values:

billing_intervalenum or null

A subscription's billing cadence.

Allowed values:

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.

Allowed values:

pending_intervalenum or null

A subscription's billing cadence.

Allowed values:

pending_downgrade_atdatetime or null

422

Unprocessable Entity Error