Create Subscription Plan

View as Markdown

Creates a new subscription plan (admin only).

Request

This endpoint expects an object.
plan_typeenumRequired
The type of pricing plan to create
Allowed values:
product_namestringRequired

The name of the product/plan

amountdoubleRequired

The base amount for fixed/per-unit plans

currencystringOptionalDefaults to usd
The currency for the plan
intervalstringOptionalDefaults to month

The billing interval (month, year, etc.)

tierslist of objectsOptional
Required for tiered plans, list of tier configurations

Response

Plan created successfully
idintegerRead-only
product_idstring<=255 characters
price_idstring<=255 characters
amountstringformat: "decimal"
currencystring<=3 characters
intervalstring<=20 characters
descriptionstring<=255 characters

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error