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 enrollment is one worker’s run through an event — the workflow that tracks their progress from “not started” through “submitted” and produces their elections. It’s the container: the elections are the choices it yields. There is one enrollment per worker per event.

Lifecycle

An enrollment moves through these statuses:
StatusMeaning
not_startedThe window is open for the worker; no choices made yet.
in_progressThe worker has begun making choices.
submittedThe worker has submitted their choices; coverage is finalized.
completedThe run is complete — a decision exists for every eligible plan.
waivedThe worker declined coverage entirely.
cancelledThe run was cancelled.

Attributes

id
string
Unique identifier for the enrollment, e.g. bene_X8pR5sT1vA4o.
object
string
The object type. Always benefit.enrollment.
worker
string
ID of the worker whose run this is.
event
string
ID of the event the run is under.
status
string
Workflow status — see the lifecycle table above.
metadata
object
Set of key-value pairs attached to the enrollment.
created
string
Timestamp of when the enrollment was created.
updated
string
Timestamp of when the enrollment was last updated.