Insurer Plans

Create Insurer Plan

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

post/v1/plans

Request

  • Base URL: https://api.health.curacel.co/api
  • URL: https://api.health.curacel.co/api/v1/plans
  • Auth: HTTP bearer

Request body

namestring
descriptionstring

Freeform description of the plan.

colorstring

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

id_from_hmostring

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

pricenumber double

Commercial price/premium of the plan.

has_all_providersboolean

If true, plan is available to all providers.

parent_idinteger

Parent plan id. Must belong to the authenticated HMO.

tariff_band_idinteger

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

metaobject

Arbitrary JSON metadata for extensibility.

dependant_limitinteger

Maximum number of dependants covered by this plan.

cover_dependantsboolean

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

amount_limitnumber double

Plan-level total amount limit/cap.

co_payment_valuenumber double

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

vat_valuenumber double

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

Response

Plan created successfully

messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.