Overview
Subscriptions tie a customer to a plan and drive billing over time. These endpoints create a subscription and manage its lifecycle — changing the plan, cancelling, reactivating, and renewing — plus seat management for memberships and gifting.
How It Works
- Create a subscription for the authenticated customer on a chosen plan.
- Change the plan on an existing subscription (upgrade / downgrade).
- Cancel a subscription (at period end or immediately) and Reactivate one that is set to cancel.
- Renew a subscription, or place an Order for one.
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | /api/v1/sdk/subscription | Create subscription |
POST | /api/v1/sdk/subscription/cancel | Cancel subscription |
POST | /api/v1/sdk/subscription/reactivate | Reactivate subscription |
POST | /api/v1/sdk/subscription/renew | Renew subscription |
POST | /api/v1/sdk/order | Order subscription |
PUT | /api/v1/sdk/subscription/{id} | Update subscription |
POST | /api/v1/sdk/subscription/change | Change subscription |
Related subsections: Members (membership seats) and Gifts (gifting & redemption).
Important Behaviors
- All endpoints are protected (Bearer JWT); the customer is taken from the token.
- Creating or changing a paid subscription requires an active payment gateway; free plans do not.