Skip to main content

Create Insurer Plan

POST 
/v1/plans

Create a new insurer plan in the authenticated user's organization.

Request​

Body

required
    name string
    description string

    Freeform description of the plan.

    color string

    Optional UI color tag (e.g. "#2E86AB").

    id_from_hmo string

    External identifier/code for the plan in the HMO’s ERP.

    price double

    Commercial price/premium of the plan.

    has_all_providers boolean

    If true, plan is available to all providers.

    parent_id integer

    Parent plan id. Must belong to the authenticated HMO.

    tariff_band_id integer

    Default tariff band id. Must belong to the authenticated HMO.

    meta object

    Arbitrary JSON metadata for extensibility.

    dependant_limit integer

    Maximum number of dependants covered by this plan.

    cover_dependants boolean

    Requires HMO feature access. If provided without dependant_limit, defaults to 1 when true and 0 when false.

    amount_limit double

    Plan-level total amount limit/cap.

    co_payment_value double

    Copayment value (amount or percent based on product rules).

    vat_value double

    VAT value (amount or percent based on product rules).

Responses​

Plan created successfully

Schema
    saved object

    The created plan

    id integer
    hmo_id integer
    name string
    description string
    color string
    id_from_hmo string
    price double
    has_all_providers boolean
    parent_id integernullable
    tariff_band_id integernullable
    meta object
    dependant_limit integer
    cover_dependants boolean
    amount_limit double
    co_payment_value double
    vat_value double
    created_at date-time
    updated_at date-time
    message string
Loading...