Skip to main content
POST
/
v1
/
benefit
/
events
Create a benefit event
curl --request POST \
  --url https://api.plane.com/v1/benefit/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "program": "<string>",
  "type": "<string>",
  "date": "<string>",
  "entity": "<string>",
  "worker": "<string>",
  "subtype": "<string>",
  "starts": "<string>",
  "ends": "<string>",
  "metadata": {}
}
'
{
  "program": "bprog_R8mK2pQ9xL4s",
  "entity": "ent_8oWZpQ2rL4sk",
  "type": "open_enrollment",
  "date": "2027-01-01",
  "starts": "2026-11-01",
  "ends": "2026-11-30"
}

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.

Open an enrollment window against a program. Provide an entity for an entity-wide open enrollment, or a worker for a new-hire or QLE event — exactly one is required.

​
Parameters

​
program
string
required
ID of the program the window opens into.
​
type
string
required
What opens the window. One of open_enrollment, new_hire, qle, or termination.
​
date
string
required
The event point — the hire or QLE date, or the open-enrollment effective date.
​
entity
string
ID of the entity, for an entity-wide open enrollment. Required unless worker is set.
​
worker
string
ID of the worker, for a new-hire or QLE event. Required unless entity is set.
​
subtype
string
For a qle, the qualifying reason — e.g. marriage, newborn, divorce, adoption, lost_coverage.
​
starts
string
First day the enrollment window is open.
​
ends
string
Last day the enrollment window is open.
​
metadata
object
Set of key-value pairs attached to the event.

​
Returns

Returns the created Benefit event object. 
{
  "program": "bprog_R8mK2pQ9xL4s",
  "entity": "ent_8oWZpQ2rL4sk",
  "type": "open_enrollment",
  "date": "2027-01-01",
  "starts": "2026-11-01",
  "ends": "2026-11-30"
}