API Reference

Enrollments

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List eligible plans

enrollments.list_plans(strenrollment_id) -> EnrollmentListPlansResponse

get/v1/enrollments/{enrollment_id}/plans

Retrieves all insurance plans eligible for selection for a specific enrollment. Returns available plan options with coverage tiers, premium costs, deductibles, and carrier info. Use during enrollment process to show employees their plan choices.

ParametersExpand Collapse

enrollment_id: str

ReturnsExpand Collapse

EnrollmentListPlansResponse = List[EnrollmentListPlansResponseItem]

id: str

Unique plan identifier (plan_*)

costs: List[EnrollmentListPlansResponseItemCost]

Cost breakdown by coverage tier

coverage_tier: CoverageTier

• Unspecified - Unspecified
• EE - Ee
• ES - Es
• EC - Ec
• EF - Ef

Accepts one of the following:

"Unspecified"

"EE"

"ES"

"EC"

"EF"

employee_contribution_cents: int

Employee's monthly contribution in cents

employer_contribution_cents: int

Employer's monthly contribution in cents

total_monthly_premium_cents: int

Total monthly premium in cents

name: str

Display name of the plan

carrier_name: Optional[str]

Name of the insurance carrier

deductible_cents: Optional[int]

Annual deductible in cents

description: Optional[str]

Plan description

out_of_pocket_max_cents: Optional[int]

Annual out-of-pocket maximum in cents

tier: Optional[PlanTier]

• Bronze - Bronze
• Silver - Silver
• Gold - Gold
• Platinum - Platinum

Accepts one of the following:

"Bronze"

"Silver"

"Gold"

"Platinum"

List eligible plans

Python

HTTP

TypeScript

Python

Ruby

from vitable_connect_api import VitableConnectAPI

client = VitableConnectAPI(
    api_key="My API Key",
)
response = client.enrollments.list_plans(
    "enrl_abc123def456",
)
print(response)

200 example

[
  {
    "id": "id",
    "costs": [
      {
        "coverage_tier": "Unspecified",
        "employee_contribution_cents": 0,
        "employer_contribution_cents": 0,
        "total_monthly_premium_cents": 0
      }
    ],
    "name": "name",
    "carrier_name": "carrier_name",
    "deductible_cents": 0,
    "description": "description",
    "out_of_pocket_max_cents": 0,
    "tier": "Bronze"
  }
]

Returns Examples

200 example

[
  {
    "id": "id",
    "costs": [
      {
        "coverage_tier": "Unspecified",
        "employee_contribution_cents": 0,
        "employer_contribution_cents": 0,
        "total_monthly_premium_cents": 0
      }
    ],
    "name": "name",
    "carrier_name": "carrier_name",
    "deductible_cents": 0,
    "description": "description",
    "out_of_pocket_max_cents": 0,
    "tier": "Bronze"
  }
]