Get Plan
Beta: This endpoint is in beta and may change. Read a single benefit plan by its Finch ID.
Authorizations
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))Path Parameters
The Finch ID of the benefit plan.
Query Parameters
The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.
1 elementResponse
Benefit plan data
A stable Finch ID for the benefit plan.
The name of the benefit plan.
The type of the benefit plan.
commuter, dental, hsa, fsa, life_insurance, long_term_disability, medical, other, short_term_disability, vision, null A description of the benefit plan.
The network type of the benefit plan.
epo, hdhp, hmo, other, pos, ppo, null The insurance carrier associated with the benefit plan.
The start date of the benefit plan in ISO 8601 format (YYYY-MM-DD).
The end date of the benefit plan in ISO 8601 format (YYYY-MM-DD).
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.
The deduction codes associated with the benefit plan.