Enrollments

Manage benefit enrollments and elections for employees

Get enrollment details

enrollments.retrieve(enrollment_id) -> EnrollmentRetrieveResponse { data }

GET/v1/enrollments/{enrollment_id}

ModelsExpand Collapse

class Enrollment { id, answered_at, benefit, 10 more }

id: String

Unique enrollment identifier (enrl_*)

answered_at: Time

When the employee enrolled or waived

formatdate-time

benefit: { id, category, name, product_code}

Nested benefit product summary

id: String

Benefit product ID (bprd_*)

category: :Medical | :Dental | :Vision | :Hospital

Medical - Medical
Dental - Dental
Vision - Vision
Hospital - Hospital

One of the following:

:Medical

:Dental

:Vision

:Hospital

name: String

Display name of the benefit product

product_code: :EBA | :VPC | :VPC_CORE | 12 more

EBA - Eba Mec
VPC - Vpc Enhanced
VPC_CORE - Vpc Core
MEC - Vpc Mec
MEC2 - Mec2
MEC_PLUS - Mec Plus
MVP - Mvp
MVP2 - Mvp2
MVPSL - Mvpsl
MVPSL2 - Mvpsl2
VD - Dental
VV - Vision
ICHRA - Ichra
ICHRA_PREMIUM_PLUS - Ichra Premium Plus
ICHRA_REIMBURSEMENT_ONLY - Ichra Reimbursement Only

One of the following:

:EBA

:VPC

:VPC_CORE

:MEC

:MEC2

:MEC_PLUS

:MVP

:MVP2

:MVPSL

:MVPSL2

:VD

:VV

:ICHRA

:ICHRA_PREMIUM_PLUS

:ICHRA_REIMBURSEMENT_ONLY

coverage_end: Date

Coverage period end date

formatdate

coverage_start: Date

Coverage period start date

formatdate

created_at: Time

When the enrollment was created

formatdate-time

employee_deduction_in_cents: Integer

Employee monthly payroll deduction in cents

employee_id: String

Employee ID (empl_*)

employer_contribution_in_cents: Integer

Employer monthly contribution in cents

employer_id: String

Employer ID (empr_*)

status: EnrollmentStatus

pending - Pending
enrolled - Enrolled
waived - Waived
inactive - Inactive

One of the following:

:pending

:enrolled

:waived

:inactive

terminated_at: Time

When coverage was terminated

formatdate-time

updated_at: Time

When the enrollment was last updated

formatdate-time

EnrollmentStatus = :pending | :enrolled | :waived | :inactive

pending - Pending
enrolled - Enrolled
waived - Waived
inactive - Inactive

One of the following:

:pending

:enrolled

:waived

:inactive