Skip to main content
A benefit program is an employer’s curated benefits menu for a plan year — the set of plans that enrollment opens into. A workspace can run more than one program for the same entity, scoped to different eligibility groups.

​
Attributes

​
id
string
Unique identifier for the program, e.g. bprog_R8mK2pQ9xL4s.
​
object
string
The object type. Always benefit.program.
​
entity
string
ID of the entity (employer) that offers the program.
​
name
string
Human-readable program name.
​
year
integer
Human renewal label for the program.
​
starts
string | null
Start date for the program year.
​
ends
string | null
End date for the program year.
​
status
string
Program status. One of draft, open, or closed.
​
eligibility
string | null
CEL expression deciding which workers the program is offered to, evaluated against the worker shape (e.g. worker.type == "employee" && worker.employment.location.address.country == "US"). Null means the program is assigned manually.
​
metadata
object
Set of key-value pairs attached to the program.
​
created
string
Timestamp of when the program was created.
​
updated
string
Timestamp of when the program was last updated.