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

Enrollments

Get enrollment details
enrollments.retrieve(strenrollment_id) -> Enrollment
get/v1/enrollments/{enrollment_id}
List eligible plans
enrollments.list_plans(strenrollment_id) -> EnrollmentListPlansResponse
get/v1/enrollments/{enrollment_id}/plans
Reissue enrollment with QLE
enrollments.reissue(strenrollment_id, EnrollmentReissueParams**kwargs) -> Enrollment
post/v1/enrollments/{enrollment_id}/reissue
ModelsExpand Collapse
CoverageTier = Literal["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"
class Enrollment: …

Serializer for Enrollment entity in public API responses.

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

id: str

Unique enrollment identifier with 'enrl_' prefix

benefit_product_id: str

ID of the benefit product (bprd_*)

created_at: datetime

Timestamp when the enrollment was created

formatdate-time
employee_id: str

ID of the employee (empl_*)

plan_year_id: str

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: datetime

Timestamp when the enrollment was last updated

formatdate-time
coverage_end_date: Optional[date]

Date when coverage ends

formatdate
coverage_start_date: Optional[date]

Date when coverage begins

formatdate
coverage_tier: Optional[CoverageTier]
  • Unspecified - Unspecified
  • EE - Ee
  • ES - Es
  • EC - Ec
  • EF - Ef
Accepts one of the following:
"Unspecified"
"EE"
"ES"
"EC"
"EF"
decision: Optional[str]

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

employee_contribution_cents: Optional[int]

Employee's monthly contribution in cents

employer_contribution_cents: Optional[int]

Employer's monthly contribution in cents

enrolled_dependents: Optional[List[EnrolledDependent]]

List of dependents included in this enrollment

dependent_id: str

ID of the dependent (dpnd_*)

first_name: str

Dependent's first name

last_name: str

Dependent's last name

relationship: Relationship
  • Spouse - Spouse
  • Child - Child
Accepts one of the following:
"Spouse"
"Child"
selected_plan_id: Optional[str]

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

selected_plan_name: Optional[str]

Name of the selected plan

PlanTier = Literal["Bronze", "Silver", "Gold", "Platinum"]
  • Bronze - Bronze
  • Silver - Silver
  • Gold - Gold
  • Platinum - Platinum
Accepts one of the following:
"Bronze"
"Silver"
"Gold"
"Platinum"