API Reference

Enrollments

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List eligible plans

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.

Path ParametersExpand Collapse

enrollment_id: string

ReturnsExpand Collapse

id: string

Unique plan identifier (plan_*)

costs: array of object { coverage_tier, employee_contribution_cents, employer_contribution_cents, total_monthly_premium_cents }

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

Employee's monthly contribution in cents

employer_contribution_cents: number

Employer's monthly contribution in cents

total_monthly_premium_cents: number

Total monthly premium in cents

name: string

Display name of the plan

carrier_name: optional string

Name of the insurance carrier

deductible_cents: optional number

Annual deductible in cents

description: optional string

Plan description

out_of_pocket_max_cents: optional number

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

HTTP

HTTP

TypeScript

Python

Ruby

curl https://api.vitablehealth.com/v1/enrollments/$ENROLLMENT_ID/plans \
    -H "Authorization: Bearer $VITABLE_connect_API_API_KEY"

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"
  }
]