Skip to main content
A benefit plan is a specific offering within a program — one carrier’s plan, with its eligibility, offered coverage tiers, and employer contribution. Each metal level (e.g. Gold, Silver) is its own plan.

Attributes

string
Unique identifier for the plan, e.g. benpl_V6nP3qR9tY2m.
string
The object type. Always benefit.plan.
string
ID of the program the plan belongs to.
string
ID of the carrier (benefit provider).
string
ID of the entity (employer) — inherited from the program.
string
Human-readable plan name.
string
Benefit category. One of medical, dental, vision, life, disability, retirement, or other.
string | null
ISO-3166 country the plan is offered in. Null means global.
string | null
Network name or type (e.g. ppo, hmo) when applicable.
string
Plan status. One of draft, active, or inactive.
array
Coverage tiers the plan offers (e.g. employee_only, family). Offering a tier above employee_only is what makes dependents eligible.
string | null
CEL expression deciding which workers may elect this plan, evaluated against the worker shape. Null means anyone eligible for the program may elect it.
object
Employer cost-sharing policy, by coverage tier.
object
Display summary of plan terms (deductible, out-of-pocket max, premium).
object
Plan materials — links and document references.
string | null
First day the plan is in effect.
string | null
Last day the plan is in effect. Null means ongoing.
object
Set of key-value pairs attached to the plan.
string
Timestamp of when the plan was created.
string
Timestamp of when the plan was last updated.