Skip to main content
POST
/
v1
/
benefit
/
programs
Create a benefit program
curl --request POST \
  --url https://api.plane.com/v1/benefit/programs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": "<string>",
  "name": "<string>",
  "year": 123,
  "starts": "<string>",
  "ends": "<string>",
  "status": "<string>",
  "eligibility": "<string>",
  "metadata": {}
}
'
{
  "entity": "ent_8oWZpQ2rL4sk",
  "name": "2027 Benefits",
  "year": 2027,
  "starts": "2027-01-01",
  "ends": "2027-12-31"
}

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.

​
Parameters

Programs are created as drafts and opened when enrollment should begin.
​
entity
string
required
ID of the entity (employer) the program belongs to.
​
name
string
required
Human-readable program name.
​
year
integer
required
Human renewal label for the program.
​
starts
date
Start date for the program year.
​
ends
date
End date for the program year.
​
status
string
Program status. One of draft, open, or closed. Defaults to draft.
​
eligibility
string
CEL expression deciding which workers the program is offered to, evaluated against the worker shape. Omit for manual assignment.
​
metadata
object
Set of key-value pairs attached to the program.

​
Returns

Returns the created Benefit program object. 
{
  "entity": "ent_8oWZpQ2rL4sk",
  "name": "2027 Benefits",
  "year": 2027,
  "starts": "2027-01-01",
  "ends": "2027-12-31"
}