Skip to main content
Subscription order endpoints allow you to create recurring billing orders and manage their lifecycle. Subscriptions are created through checkout sessions (with productType: "subscription") and managed via cancellation and status transitions.

​
Subscription Status Values

StatusDescription
pendingSubscription created, awaiting first payment
activeActive and billing normally
trialingIn free trial period
cancelingCancellation requested, active until period end
past_duePayment failed, retrying
canceledSubscription ended, no further billing
expiredSubscription expired

​
Endpoints

Create Subscription Order

Create a subscription order using a checkout session.

Cancel Subscription

Cancel an active or pending subscription.

​
Coming Soon

The following endpoints are planned but not yet implemented (currently return 501 Not Implemented):
  • Change Product (POST /v1/actions/subscription-order/change-product) — Upgrade or downgrade a subscription to a different product.
  • Reactivate Subscription (POST /v1/actions/subscription-order/reactivate-order) — Reactivate a canceled subscription.