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 election is a worker’s choice to enroll in a specific plan — the coverage they hold. An election is the durable record of “this worker is covered by this plan”; it is created when the worker enrolls and terminated when the coverage ends. To change a plan, terminate the existing election and create a new one rather than editing in place.

Attributes

id
string
Unique identifier for the election, e.g. bele_W7oQ4rS0uZ3n.
object
string
The object type. Always benefit.election.
worker
string
ID of the worker holding the coverage.
plan
string
ID of the elected plan.
enrollment
string | null
ID of the enrollment run that produced this election, if any. Null for an election created directly.
coverage
string
The coverage tier in effect, e.g. employee_only or family. Derived from the covered dependents — family when any are covered, otherwise employee_only.
dependents
array
IDs of the worker dependents this election covers.
status
string
Election status. One of active, waived, or terminated.
contribution
object
Employer and worker cost split for this election, materialized from the plan’s contribution policy at the time of enrollment.
starts
string | null
First day the coverage is in effect.
ends
string | null
Last day the coverage is in effect. Null while active.
metadata
object
Set of key-value pairs attached to the election.
created
string
Timestamp of when the election was created.
updated
string
Timestamp of when the election was last updated.