Skip to main content
GET
Get Plan

Authorizations

Authorization
string
header
required

Please use your Access Token

Headers

Finch-API-Version
string<date>
default:2020-09-17
required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))

Path Parameters

plan_id
string
required

The Finch ID of the benefit plan.

Query Parameters

entity_ids
string<uuid>[]

The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.

Required array length: 1 element
Example:

Response

Benefit plan data

id
string
required

A stable Finch ID for the benefit plan.

name
string
required

The name of the benefit plan.

type
enum<string> | null
required

The type of the benefit plan.

Available options:
commuter,
dental,
hsa,
fsa,
life_insurance,
long_term_disability,
medical,
other,
short_term_disability,
vision,
null
description
string | null
required

A description of the benefit plan.

network_type
enum<string> | null
required

The network type of the benefit plan.

Available options:
epo,
hdhp,
hmo,
other,
pos,
ppo,
null
carrier
object | null
required

The insurance carrier associated with the benefit plan.

start_date
string
required

The start date of the benefit plan in ISO 8601 format (YYYY-MM-DD).

end_date
string | null
required

The end date of the benefit plan in ISO 8601 format (YYYY-MM-DD).

coverage_tiers
string[] | null
required

The available coverage tiers for the benefit plan. Known values: employee_only, employee_spouse, employee_children, employee_family. Provider-specific values outside this list may also be returned.

A coverage tier available on the benefit plan. Known values: employee_only, employee_spouse, employee_children, employee_family. Provider-specific values outside this list may also be returned.

deduction_codes
string[] | null
required

The deduction codes associated with the benefit plan.