🔄 Subscriptions

Manage recurring billing and subscription services for your customers.

The Subscriptions endpoints enable you to manage recurring billing relationships with your customers.
You can create subscription products, manage customer subscriptions, and provide self-service options through the customer portal.

This section covers:

  • Creating and managing subscription products with pricing plans
  • Setting up customer subscriptions with Stripe price IDs
  • Providing customer billing portal access for self-service
  • Listing subscriptions with filtering and pagination
  • Canceling subscriptions immediately or at period end

Available Endpoints

MethodEndpointDescription
GET/public/subscriptionsList subscriptions with filtering
POST/public/subscriptionsCreate new subscription
GET/public/subscriptions/:idGet subscription details
DELETE/public/subscriptions/:idCancel subscription
POST/public/subscriptions/billing-portalCreate customer billing portal session
POST/public/subscriptions/productsCreate subscription product with plans
GET/public/subscriptions/productsGet subscription products
📘

Pro tip

All subscription endpoints now use Stripe price IDs (starting with price_) instead of internal plan IDs. The paymentMethod field is required when creating subscriptions to determine fee structures.

📘

API Refs