---
title: "View insurance plan (beta)"
method: GET
path: "/insurance_plans/{id}"
tags: ["Insurance"]
---

# View insurance plan (beta)

`GET /insurance_plans/{id}`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/insurance_plans/{id}`
- Auth: API key in header `Authorization`

> 🚧 Beta
>
> Send `Nex-Api-Version: v3.1.0` to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

> **Changed from v3.0.0:** Adds response fields `data.annual_max_individual`, `data.annual_max_individual.amount`, `data.annual_max_individual.currency`, `data.benefit_year_renewal_month`.

This endpoint returns a single insurance plan by its NexHealth ID, with optional sideloading of `patient_coverages`, `subscribers`, and `fee_schedule`.

## Path parameters

- `id` integer, required

## Query parameters

- `subdomain` string, required
- `include[]` string[]

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV31EntitiesInsuranceEhrPlanResponse: API_V31_Entities_Insurance_EhrPlan_Response model
  - `code` boolean: Indicates the success or failure of the request
  - `description` string: Additional context on the request to help with debugging.
  - `error` string[]: Any errors that occur during the execution of the request.
  - `data` APIV31EntitiesInsuranceEhrPlan
    - `id` integer: Plan ID
    - `payer_id` string, nullable: A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically
    - `name` string, nullable: Plan name
    - `address` string, nullable: Street address
    - `address2` string, nullable: Street address 2
    - `city` string, nullable: City
    - `state` string, nullable: 2 letter state code
    - `zip_code` string, nullable: Zip code
    - `country_code` string, nullable: 2 letter country code
    - `group_num` string, nullable: Group number
    - `employer_name` string, nullable: Employer name
    - `foreign_id` string, nullable: Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.
    - `updated_at` string, date-time: Insurance Plan update date in UTC
    - `deleted_at` string, date-time, nullable: The UTC date and time the insurance plan was deleted. Null unless the plan is soft-deleted; deleted plans are only returned when include_deleted is true
    - `patient_coverages` APIV2EntitiesInsurancePatientCoverage[]: List of patient coverages
      - `id` integer: Coverage ID
      - `subscription_relation` 'self' | 'spouse' | 'child' | 'employee' | 'handicap_dep' | 'signif_other' | 'injured_plaintiff' | 'life_partner' | 'dependent' | 'other': The relationship of this patient to the subscriber
      - `patient_id` integer, nullable: The ID of the covered patient
      - `priority` integer, nullable: The relative priority of this insurance coverage where the lowest value is the patient's primary insurance and higher values represent secondary and tertiary policies
      - `plan_id` integer, nullable: The ID of the insurance plan this coverage subscribes to
      - `subscriber_num` string, nullable: The subscriber's identification number for the plan
      - `effective_date` string, date, nullable: The date the coverage takes effect
      - `expiration_date` string, date, nullable: The date the coverage expires
    - `subscribers` APIV2EntitiesInsuranceSubscriber[]: List of individuals who hold subscriptions to this plan.
      - `id` integer: The subscriber's ID
      - `name` string: The subscriber's full name
      - `date_of_birth` string, nullable: The subscriber's date of birth in YYYY-MM-DD format
    - `fee_schedule` APIEntitiesFeeSchedule
      - `id` integer: Fee schedule ID
      - `name` string: The name of the fee schedule
      - `active` boolean, nullable: Indicates if the fee schedule is active
      - `location_id` integer, nullable: The NexHealth ID of the location this fee schedule belongs to
      - `updated_at` string, date-time: Fee Schedule update date in UTC
    - `annual_max_individual` APIV2EntitiesPrice
      - `amount` string: The currency value, in whole units (e.g. dollars)
      - `currency` string: The ISO currency code
    - `benefit_year_renewal_month` integer: Month (1-12) when the benefit year resets. Null if not provided by the EHR.
  - `count` integer: Number of total objects, in case of collection.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/revisions/93cb4af790a5?raw)