Create Plan

View as Markdown

Request

This endpoint expects a multipart form.
namestringRequired

Required: Plan name - max 255 chars - “Pro Plan”

currencystringRequired

Optional: Currency code - 3 chars - “USD”

is_activestringRequired

Optional: Whether plan is active - boolean - true

sort_orderstringRequired

Optional: Display sort order - integer min:0 - 1

trial_daysstringRequired

Optional: Trial period in days - integer min:0 - 14

descriptionstringRequired

Optional: Plan description - max 1000 chars - “Full featured plan”

annual_pricestringRequired

Required: Annual price - numeric min:0 - 499.99

module_ids[0]stringRequired

Required: Module UUIDs to include - array min:1 - exists in saas_modules

module_ids[1]stringRequired

Optional: Additional module UUID

monthly_pricestringRequired

Required: Monthly price - numeric min:0 - 49.99

external_product_idstringRequired

Optional: Stripe product ID - string - “prod_xxx”

external_annual_price_idstringRequired

Optional: Stripe annual price ID - string - “price_xxx”

external_monthly_price_idstringRequired

Optional: Stripe monthly price ID - string - “price_xxx”

Response

Successful response