Create Plan

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
codestringRequired

Optional: Plan code - string, max 100 chars - “GOLD-MAINT”

namestringRequired

Required: Plan name - string, max 255 chars - “Gold Maintenance Plan”

is_activestringRequired

Optional: Whether plan is active - boolean 0|1 - default true

pricing[]stringRequired

Optional: Array of pricing tiers (JSON) - billing_frequency, base_price, per_equipment_price, setup_fee, trial_days

benefits[]stringRequired

Optional: Array of benefit objects (JSON) - benefit_type, label, visit_credits_per_cycle, visit_discount_percentage

sort_orderstringRequired

Optional: Display sort order - integer, min 0

descriptionstringRequired

Optional: Plan description - string

duration_typestringRequired

Required: Duration type - ongoing|fixed

priority_booststringRequired

Optional: Priority boost value - integer, min 0

is_equipment_basedstringRequired

Optional: Whether plan is equipment-based - boolean 0|1 - default false

sla_response_hoursstringRequired

Optional: SLA response time in hours - integer, min 0

fixed_duration_monthsstringRequired

Required if duration_type=fixed: Number of months - integer, min 1 - “12”

visit_scheduling_modestringRequired

Optional: Visit scheduling mode - auto_generate|on_demand|both

Response

Successful response