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(enrollment_id) -> EnrollmentListPlansResponse { id, costs, name, 5 more }

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

ReturnsExpand Collapse

Array[{ id, costs, name, 5 more}]

id: String

Unique plan identifier (plan_*)

costs: Array[{ 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: Integer

Employee's monthly contribution in cents

employer_contribution_cents: Integer

Employer's monthly contribution in cents

total_monthly_premium_cents: Integer

Total monthly premium in cents

name: String

Display name of the plan

carrier_name: String

Name of the insurance carrier

deductible_cents: Integer

Annual deductible in cents

description: String

Plan description

out_of_pocket_max_cents: Integer

Annual out-of-pocket maximum in cents

tier: PlanTier

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

Accepts one of the following:

:Bronze

:Silver

:Gold

:Platinum

List eligible plans

Ruby

HTTP

TypeScript

Python

Ruby

require "vitable_connect_api"

vitable_connect_api = VitableConnectAPI::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

response = vitable_connect_api.enrollments.list_plans("enrl_abc123def456")

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