Skip to main content
POST
Create a plan

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
components
object[]
required
currency
string
required
name
string
required
plan_type
enum<string>
required
Available options:
STANDARD,
FREE,
CUSTOM
product_family_id
string<MeteroidId>
required
Example:

"pf_7n42DGM5Tflk9n8mt7Fhc7"

status
enum<string>
required
Available options:
DRAFT,
ACTIVE,
INACTIVE,
ARCHIVED
add_ons
object[]
billing
object | null
description
string | null
self_service_rank
integer<int32> | null
trial
object | null

Response

Plan created

available_parameters
object
required
created_at
string<date-time>
required
currency
string
required
id
string<MeteroidId>
required
Example:

"plan_7n42DGM5Tflk9n8mt7Fhc7"

name
string
required
net_terms
integer<int32>
required
plan_type
enum<string>
required
Available options:
STANDARD,
FREE,
CUSTOM
price_components
object[]
required
product_family
object
required
status
enum<string>
required
Available options:
DRAFT,
ACTIVE,
INACTIVE,
ARCHIVED
version
integer<int32>
required
version_id
string<MeteroidId>
required
Example:

"plv_7n42DGM5Tflk9n8mt7Fhc7"

billing_cycles
integer<int32> | null
description
string | null
entitlements
object[]
minimum_commitment
object | null

Plan-level minimum commitment (period true-up floor). When set, every billing-period invoice for this plan is guaranteed to be at least minimum_commitment.amount after discounts, with a "Minimum commitment" line filling any shortfall.

period_start_day
integer<int32> | null
self_service_rank
integer<int32> | null
trial
object | null