Subscription

Tenant subscription management. View the current subscription, subscription history, change packages, and cancel subscriptions. Cancelling ends the current subscription immediately and marks the tenant as cancelled. Choosing a new plan via PUT clears the cancellation. The pricing tier is automatically determined from the tenant's active client count.

OpenAPI Spec

Guides Operations Schemas

GET Get Current Subscription
Returns the current active subscription for the tenant Requires: ViewAll on Subscription.
/tenants/{tenant}/subscription
PUT Change Subscription
Changes the tenant's subscription to a different package. The pricing tier is automatically determined based on the tenant's active client count. If t...
/tenants/{tenant}/subscription
DELETE Cancel Subscription
Cancels the tenant's subscription. During a free trial, this removes the pending package selection (the trial continues and will expire naturally). Ou...
/tenants/{tenant}/subscription
GET Get Subscription History
Returns all subscriptions for the tenant, including historical Requires: ViewAll on Subscription.
/tenants/{tenant}/subscription/history
GET Preview Subscription Prices
Returns the price for each available package based on the tenant's current active client count, including any active discount. Requires: ViewAll on S...
/tenants/{tenant}/subscription/price-preview
GET Get User Billing Summary
Returns the tenant's per-user billing position: how many users are included in the subscription, the current billable user count (active and invited u...
/tenants/{tenant}/subscription/user-billing