## List an employer's benefit plan years

`employers.list_benefit_plan_years(employer_id) -> EmployerListBenefitPlanYearsResponse`

**get** `/v1/employers/{employer_id}/benefit-plan-years`

Returns the employer's benefit plan years (all years, or one when `year` is given), each with its benefits, offered states, benefit families, and the year-level enrollment roll-up. The caller must be authorized for the employer; an unknown or unauthorized employer returns 404.

### Parameters

- `employer_id: String`

  Unique employer identifier (empr_*)

### Returns

- `class EmployerListBenefitPlanYearsResponse`

  - `data: Array[{ benefit_id, benefit_plan_year_id, carrier, 15 more}]`

    - `benefit_id: String`

      Prefixed benefit identifier (`bprd_*`).

    - `benefit_plan_year_id: String`

      Prefixed plan-year identifier (`plyr_*`).

    - `carrier: String`

      Carrier name, or null (e.g. ICHRA).

    - `coverage_end: Date`

      Coverage end.

    - `coverage_start: Date`

      Coverage start.

    - `employee_contribution: { max_cents, min_cents}`

      Employee contribution range.

      - `max_cents: Integer`

        Highest per-tier contribution in cents.

      - `min_cents: Integer`

        Lowest per-tier contribution in cents.

    - `employer_contribution: { max_cents, min_cents}`

      Employer contribution range.

      - `max_cents: Integer`

        Highest per-tier contribution in cents.

      - `min_cents: Integer`

        Lowest per-tier contribution in cents.

    - `enrollment_rate: { eligible, enrolled, percentage}`

      Enrolled/eligible rate for this plan year.

      - `eligible: Integer`

        Employees eligible for this plan year.

      - `enrolled: Integer`

        Employees enrolled in this plan year.

      - `percentage: Integer`

        `enrolled / eligible` whole-number percent (0 when none).

    - `family: :mec | :mvp | :ichra | 3 more`

      * `mec` - Mec
      * `mvp` - Mvp
      * `ichra` - Ichra
      * `vpc` - Vpc
      * `dental` - Dental
      * `vision` - Vision

      - `:mec`

      - `:mvp`

      - `:ichra`

      - `:vpc`

      - `:dental`

      - `:vision`

    - `is_current: bool`

      Whether this is the current plan year.

    - `network_names: Array[String]`

      Displayed networks: ["multi"] for ICHRA, otherwise the plan year's distinct network names.

    - `offered_states: Array[String]`

      Distinct offered state codes.

    - `open_enrollment_end: Date`

      Open-enrollment end.

    - `open_enrollment_start: Date`

      Open-enrollment start.

    - `premium_in_cents: Integer`

      Monthly premium in cents; only for an ICHRA benefit with effective coverage.

    - `product_name: String`

      Benefit/product display name.

    - `status: :active | :upcoming | :open_enrollment | :inactive`

      * `active` - Active
      * `upcoming` - Upcoming
      * `open_enrollment` - Open Enrollment
      * `inactive` - Inactive

      - `:active`

      - `:upcoming`

      - `:open_enrollment`

      - `:inactive`

    - `year: Integer`

      Calendar coverage year.

### Example

```ruby
require "vitable_connect"

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

response = vitable_connect.employers.list_benefit_plan_years("empr_abc123def456")

puts(response)
```

#### Response

```json
{
  "data": [
    {
      "benefit_id": "benefit_id",
      "benefit_plan_year_id": "benefit_plan_year_id",
      "carrier": "carrier",
      "coverage_end": "2019-12-27",
      "coverage_start": "2019-12-27",
      "employee_contribution": {
        "max_cents": 0,
        "min_cents": 0
      },
      "employer_contribution": {
        "max_cents": 0,
        "min_cents": 0
      },
      "enrollment_rate": {
        "eligible": 0,
        "enrolled": 0,
        "percentage": 0
      },
      "family": "mec",
      "is_current": true,
      "network_names": [
        "string"
      ],
      "offered_states": [
        "string"
      ],
      "open_enrollment_end": "2019-12-27",
      "open_enrollment_start": "2019-12-27",
      "premium_in_cents": 0,
      "product_name": "product_name",
      "status": "active",
      "year": 0
    }
  ]
}
```