Skip to content
Vitable Docs Vitable Docs Vitable Docs
Get started
API Reference

Enrollments

Get enrollment details
client.enrollments.retrieve(stringenrollmentID, RequestOptionsoptions?): Enrollment { id, benefit_product_id, created_at, 13 more }
get/v1/enrollments/{enrollment_id}
List eligible plans
client.enrollments.listPlans(stringenrollmentID, RequestOptionsoptions?): EnrollmentListPlansResponse { id, costs, name, 5 more }
get/v1/enrollments/{enrollment_id}/plans
Reissue enrollment with QLE
client.enrollments.reissue(stringenrollmentID, EnrollmentReissueParams { qle_id, reason } body, RequestOptionsoptions?): Enrollment { id, benefit_product_id, created_at, 13 more }
post/v1/enrollments/{enrollment_id}/reissue
ModelsExpand Collapse
CoverageTier = "Unspecified" | "EE" | "ES" | 2 more
  • Unspecified - Unspecified
  • EE - Ee
  • ES - Es
  • EC - Ec
  • EF - Ef
Accepts one of the following:
"Unspecified"
"EE"
"ES"
"EC"
"EF"
Enrollment { id, benefit_product_id, created_at, 13 more }

Serializer for Enrollment entity in public API responses.

An Enrollment represents an employee's benefit enrollment for a specific plan year.

id: string

Unique enrollment identifier with 'enrl_' prefix

benefit_product_id: string

ID of the benefit product (bprd_*)

created_at: string

Timestamp when the enrollment was created

formatdate-time
employee_id: string

ID of the employee (empl_*)

plan_year_id: string

ID of the plan year (plyr_*)

status: EnrollmentStatus
  • pending - Pending
  • enrolled - Enrolled
  • waived - Waived
  • inactive - Inactive
Accepts one of the following:
"pending"
"enrolled"
"waived"
"inactive"
updated_at: string

Timestamp when the enrollment was last updated

formatdate-time
coverage_end_date?: string | null

Date when coverage ends

formatdate
coverage_start_date?: string | null

Date when coverage begins

formatdate
coverage_tier?: CoverageTier | null
  • Unspecified - Unspecified
  • EE - Ee
  • ES - Es
  • EC - Ec
  • EF - Ef
Accepts one of the following:
"Unspecified"
"EE"
"ES"
"EC"
"EF"
decision?: string | null

Employee's election decision: 'enrolled' (accepted) or 'waived' (declined)

employee_contribution_cents?: number | null

Employee's monthly contribution in cents

employer_contribution_cents?: number | null

Employer's monthly contribution in cents

enrolled_dependents?: Array<EnrolledDependent>

List of dependents included in this enrollment

dependent_id: string

ID of the dependent (dpnd_*)

first_name: string

Dependent's first name

last_name: string

Dependent's last name

relationship: Relationship
  • Spouse - Spouse
  • Child - Child
Accepts one of the following:
"Spouse"
"Child"
selected_plan_id?: string | null

ID of the selected plan (plan_*), if enrolled

selected_plan_name?: string | null

Name of the selected plan

PlanTier = "Bronze" | "Silver" | "Gold" | "Platinum"
  • Bronze - Bronze
  • Silver - Silver
  • Gold - Gold
  • Platinum - Platinum
Accepts one of the following:
"Bronze"
"Silver"
"Gold"
"Platinum"