Sign in
latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Plan

plan renewal

Duplicates and pushes enrollments for an existing plan onto a new one using the original plan as a template.<p>Scopes: import_plan</p>

post/v{version}/plans/{id}/renew

Path parameters

idstring required
versionstring required

Request body

admin_namestring required

The plan name displayed to the administrators.

display_namestring required

The plan name displayed to the enrollees.

start_datestring required

The effective date of the plan.

end_datestring required

The end date of the plan.

available_start_datestring required

The Available Start Date is the first date that employees are able to see the plan. This should not be confused with open enrollment dates. If an employee logs in during this time period AND they are eligible for the plan they would be given the option to enroll.

optionsstring[] required

The options for the renewal.

Example request

{
  "start_date": "yyyy-MM-dd",
  "end_date": "yyyy-MM-dd",
  "available_start_date": "yyyy-MM-dd"
}

Response

Success

idstring

The Ease plan id.

group_numberstring

The plan group number.

contribution_typestring

The plan contribution type.

namestring

The plan name.

admin_namestring

The plan admin name.

import_idstring

The plan import id.

typestring

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

The plan start date.

end_datestring

The plan end date. The date is inclusive.

createdstring

The plan created date / time.

cobra_eligibilitystring

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

provides_minimum_valueboolean

Does this plan provide minimum value?

provides_creditable_coverageboolean

Does this plan provide creditable coverage?

self_fundedboolean

Is this plan self-funded?

is_open_enrollment_planboolean

Is this plan a current Open Enrollment option?

connect_status'Not Connected' | 'Pending' | 'Pending (New)' | 'Ease Review' | 'Ease Review (New)' | 'Carrier Review' | 'Connected' | 'Self-Bill' | 'EOI' | 'EOI & Self-Bill' | 'Disabled' | 'Broker Submitted' | 'Suspended'

The plan connect status.

external_plan_idstring

The plan external id.

previous_plan_idstring

The previous plan id.

Example response

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