The basis for a Subscription is a Stripe Price object. Subscriptions use parameters from these objects, such as billing cycle recurrence (monthly, yearly, etc.), price structure (per unit, tiered, etc.), and metadata.
There are two main types of Subscriptions available:
- Sponsored Drawers (
sponsoredsds) – the Subscription licenses are attached to Drawers. A Drawer is then called a "sponsored Drawer (sidedrawer)"- To create a Drawer given this Subscription type:
POST/api/v1/subscriptions/subscriptions/subscription-id/{subscriptionId}/sidedrawerOR
POST/api/v2/subscriptions/subscriptions/subscription-id/{subscriptionId}/sidedrawer
- To create a Drawer given this Subscription type:
- Sponsored Users (
sponsoredusers) – the Subscription licenses are attached to Tenant Users. One of the Users given a license is then called a "sponsored User"- To create a Drawer given this Subscription type:
POST/api/v1/tenants/tenant/tenant-id/{tenantId}/subscriptions/subscription-id/{subscriptionId}/sidedrawerOR
POST/api/v2/tenants/tenant/tenant-id/{tenantId}/subscriptions/subscription-id/{subscriptionId}/sidedrawer
- To create a Drawer given this Subscription type:
Summary
| Subscription type | Audience (metadata) | API to use for creating drawers |
|---|---|---|
Sponsored Drawers, sponsoredsds | Pros | Cabinets → Subscriptions |
Sponsored Users, sponsoredusers | Users | Tenants → Subscriptions |