Create Module

View as Markdown

Request

This endpoint expects a multipart form.
keystringRequired

Required: Unique module key - max 50 chars unique - “crm”

namestringRequired

Required: Module name - max 255 chars - “CRM Module”

is_freestringRequired

Optional: Whether module is free - boolean - false

currencystringRequired

Optional: Currency code - 3 chars - “USD”

is_activestringRequired

Optional: Whether module 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: Module description - max 1000 chars

annual_pricestringRequired

Required: Annual price - numeric min:0 - 199.99

monthly_pricestringRequired

Required: Monthly price - numeric min:0 - 19.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