Create a plan for a product
Creates a plan under the product from its composable pricing options[] (charges, billing cycle, tiers, limits, entitlements, trials, discounts, rollovers). Options are validated for cross-option coherence and rejected with 400 if invalid; money fields are integer minor units.
Authorizations
Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer token.
Path Parameters
Product reference or ID
"prd_1A2B3C4D"
Body
2 - 200^[\p{L}\p{N} .,'"&\/()+:\-]*$- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
x > 03500^[\p{L}\p{N}\s.,'"&\/()+:%;?!@#_[\]\-]*$x > 0active, inactive, archived auto, inclusive, exclusive Response
Plan created successfully
Creation timestamp
Whether the plan is active (derived from status)
true
Composable pricing options (money as integer minor units)
Plan reference
"pln_1A2B3C4D"
Plan status
"active"
Derived plan type (read from options)
recurring, one-time, usage-based, hybrid "recurring"
Last update timestamp
Access expiry in days
Currency code (ISO 4217)
"USD"
Currency symbol (derived from currency)
"$"
Plan description
"Best for teams getting started"
Plan features
Maximum number of active users
Plan name
"Starter"
Derived headline price in minor units (the base or one-time charge)
2999
Whether payment is required
true