Configure pricing options for your subscription products.
Overview
Plans define pricing and billing configurations for subscription products. Each plan specifies the amount, currency, billing interval, and optional trial period. Plans are associated with products and can include entitlements that grant access to specific content or features.
How It Works
Create a product - Products represent what you're selling (e.g., "Premium Membership")
Add plans - Each product can have multiple plans with different pricing (e.g., monthly, annual)
Subscribe customers - Customers subscribe to plans to gain access to your content
Example: A news publisher creates a "Digital Access" product with three plans: Monthly ($9.99/month), Annual ($99.99/year with 2 months free), and Student ($4.99/month). Each plan grants access to the same digital content but at different price points.
API Endpoints
Method
Endpoint
Description
GET
/api/v1/core/plans
List all plans
POST
/api/v1/core/plans
Create a plan
GET
/api/v1/core/plans/{id}
Get a plan
PUT
/api/v1/core/plans/{id}
Update a plan
DELETE
/api/v1/core/plans/{id}
Delete a plan
Plan Types
Type
Description
regular
Standard subscription plan
membership
Group/institutional subscription with multiple seats
Billing Intervals
Interval
Description
day
Daily billing
week
Weekly billing
month
Monthly billing
year
Annual billing
Use interval_count to specify multiples (e.g., interval: month, interval_count: 3 for quarterly).
