Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.plane.com/llms.txt

Use this file to discover all available pages before exploring further.

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

id
string
Unique identifier for the plan, e.g. benpl_V6nP3qR9tY2m.
object
string
The object type. Always benefit.plan.
program
string
ID of the program the plan belongs to.
provider
string
ID of the carrier (benefit provider).
entity
string
ID of the entity (employer) — inherited from the program.
name
string
Human-readable plan name.
type
string
Benefit category. One of medical, dental, vision, life, disability, retirement, or other.
country
string | null
ISO-3166 country the plan is offered in. Null means global.
network
string | null
Network name or type (e.g. ppo, hmo) when applicable.
status
string
Plan status. One of draft, active, or inactive.
coverages
array
Coverage tiers the plan offers (e.g. employee_only, family). Offering a tier above employee_only is what makes dependents eligible.
eligibility
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.
contribution
object
Employer cost-sharing policy, by coverage tier.
terms
object
Display summary of plan terms (deductible, out-of-pocket max, premium).
resources
object
Plan materials — links and document references.
starts
string | null
First day the plan is in effect.
ends
string | null
Last day the plan is in effect. Null means ongoing.
metadata
object
Set of key-value pairs attached to the plan.
created
string
Timestamp of when the plan was created.
updated
string
Timestamp of when the plan was last updated.