latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Plan

company plan

Create a new plan for a company.<p>Scopes: import_plan</p>

post/v{version}/companies/{company_id}/plans

Path parameters

company_idstring required

Id of the company.

versionstring required

Request body

plan_idstring required

The plan id.

previous_plan_idstring

The Ease previous plan id. A Plan of type 'Legal' cannot have a Previous Plan. Any previous plan must be from the current company, must be of the same type, must not be deleted, and must have the start date before the current plan start date.

carrierstring

The plan carrier name.

namestring required

The plan name.

admin_namestring

The plan admin name.

typestring required

The plan type. Please see <a href="/api/docs/v2#section/Plan-Types">Plan Types</a> for a complete list of supported values.

start_datestring required

The plan start date.

end_datestring

The plan end date. The date is inclusive.

instructionsstring

The plan instructions.

deduction_periodsinteger

The number of deduction cycles for the plan per year. Accepted values are 1-52.

cobra_eligibility'Not Eligible' | 'Eligible - 100%' | 'Eligible - 102%' | 'Eligible - 110%' | 'Eligible - 105%'

The Cobra eligibility setting. The default is "Not Eligible".

form_idsstring[]

The plan ease form ids, for example "ca_anthem_sg_202101".

Example request

{
  "start_date": "yyyy-MM-dd",
  "end_date": "yyyy-MM-dd",
  "eligibilities": [
    {
      "entry_date": "yyyy-MM-dd"
    }
  ]
}

Response

Success

company_idstring

The id of the company, whether new or existing.