Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Enrollments

Manage benefit enrollments and elections for employees

Get enrollment details
enrollments.retrieve(strenrollment_id) -> EnrollmentRetrieveResponse
GET/v1/enrollments/{enrollment_id}
Reissue an enrollment
enrollments.reissue(strenrollment_id, EnrollmentReissueParams**kwargs) -> EnrollmentReissueResponse
POST/v1/enrollments/{enrollment_id}/reissue
Terminate an enrollment
enrollments.terminate(strenrollment_id, EnrollmentTerminateParams**kwargs)
POST/v1/enrollments/{enrollment_id}/terminate
ModelsExpand Collapse
class Enrollment: …

One enrollment as it appears in a list row.

id: str

Unique enrollment identifier (enrl_*)

answered_at: Optional[datetime]

When the employee enrolled or waived

formatdate-time
benefit: Benefit

Nested benefit product summary

id: str

Benefit product ID (bprd_*)

category: Literal["Medical", "Dental", "Vision", "Hospital"]
  • Medical - Medical
  • Dental - Dental
  • Vision - Vision
  • Hospital - Hospital
One of the following:
"Medical"
"Dental"
"Vision"
"Hospital"
name: str

Display name of the benefit product

product_code: Literal["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: Optional[date]

Coverage period end date

formatdate
coverage_start: date

Coverage period start date

formatdate
created_at: datetime

When the enrollment was created

formatdate-time
employee_deduction_in_cents: Optional[int]

Employee monthly payroll deduction in cents

employee_id: str

Employee ID (empl_*)

employer_contribution_in_cents: Optional[int]

Employer monthly contribution in cents

employer_id: str

Employer ID (empr_*)

status: EnrollmentStatus
  • pending - Pending
  • enrolled - Enrolled
  • waived - Waived
  • inactive - Inactive
One of the following:
"pending"
"enrolled"
"waived"
"inactive"
terminated_at: Optional[datetime]

When coverage was terminated

formatdate-time
updated_at: datetime

When the enrollment was last updated

formatdate-time
Literal["pending", "enrolled", "waived", "inactive"]
  • pending - Pending
  • enrolled - Enrolled
  • waived - Waived
  • inactive - Inactive
One of the following:
"pending"
"enrolled"
"waived"
"inactive"
class EnrollmentRetrieveResponse: …

Response containing a single enrollment resource.

data: Data

A single enrollment, including the enrolled plan’s documents.

The plan documents are resolved one enrollment at a time and are therefore not part of the list row.

id: str

Unique enrollment identifier (enrl_*)

answered_at: Optional[datetime]

When the employee enrolled or waived

formatdate-time
benefit: DataBenefit

Nested benefit product summary

id: str

Benefit product ID (bprd_*)

category: Literal["Medical", "Dental", "Vision", "Hospital"]
  • Medical - Medical
  • Dental - Dental
  • Vision - Vision
  • Hospital - Hospital
One of the following:
"Medical"
"Dental"
"Vision"
"Hospital"
name: str

Display name of the benefit product

product_code: Literal["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: Optional[date]

Coverage period end date

formatdate
coverage_start: date

Coverage period start date

formatdate
created_at: datetime

When the enrollment was created

formatdate-time
employee_deduction_in_cents: Optional[int]

Employee monthly payroll deduction in cents

employee_id: str

Employee ID (empl_*)

employer_contribution_in_cents: Optional[int]

Employer monthly contribution in cents

employer_id: str

Employer ID (empr_*)

status: EnrollmentStatus
  • pending - Pending
  • enrolled - Enrolled
  • waived - Waived
  • inactive - Inactive
One of the following:
"pending"
"enrolled"
"waived"
"inactive"
terminated_at: Optional[datetime]

When coverage was terminated

formatdate-time
updated_at: datetime

When the enrollment was last updated

formatdate-time
sbc_url: Optional[str]

Summary of Benefits and Coverage (SBC) document URL for the enrolled plan; null when not on file. Only individual (ICHRA) plans carry an SBC — group plans have no SBC on record and always resolve to null.

class EnrollmentReissueResponse: …

Response containing a single reissue enrollment resource.

data: Data
enrollment_id: str

Opaque identifier for the new unanswered enrollment