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": {}
}
'
import requests

url = "https://api.plane.com/v1/benefit/events"

payload = {
"program": "<string>",
"type": "<string>",
"date": "<string>",
"entity": "<string>",
"worker": "<string>",
"subtype": "<string>",
"starts": "<string>",
"ends": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
program: '<string>',
type: '<string>',
date: '<string>',
entity: '<string>',
worker: '<string>',
subtype: '<string>',
starts: '<string>',
ends: '<string>',
metadata: {}
})
};

fetch('https://api.plane.com/v1/benefit/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.plane.com/v1/benefit/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'program' => '<string>',
'type' => '<string>',
'date' => '<string>',
'entity' => '<string>',
'worker' => '<string>',
'subtype' => '<string>',
'starts' => '<string>',
'ends' => '<string>',
'metadata' => [

]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.plane.com/v1/benefit/events"

payload := strings.NewReader("{\n \"program\": \"<string>\",\n \"type\": \"<string>\",\n \"date\": \"<string>\",\n \"entity\": \"<string>\",\n \"worker\": \"<string>\",\n \"subtype\": \"<string>\",\n \"starts\": \"<string>\",\n \"ends\": \"<string>\",\n \"metadata\": {}\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.plane.com/v1/benefit/events")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"program\": \"<string>\",\n \"type\": \"<string>\",\n \"date\": \"<string>\",\n \"entity\": \"<string>\",\n \"worker\": \"<string>\",\n \"subtype\": \"<string>\",\n \"starts\": \"<string>\",\n \"ends\": \"<string>\",\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.plane.com/v1/benefit/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"program\": \"<string>\",\n \"type\": \"<string>\",\n \"date\": \"<string>\",\n \"entity\": \"<string>\",\n \"worker\": \"<string>\",\n \"subtype\": \"<string>\",\n \"starts\": \"<string>\",\n \"ends\": \"<string>\",\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "program": "bprog_R8mK2pQ9xL4s",
  "entity": "ent_8oWZpQ2rL4sk",
  "type": "open_enrollment",
  "date": "2027-01-01",
  "starts": "2026-11-01",
  "ends": "2026-11-30"
}
{
  "id": "benev_K2mP9qR4xL7s",
  "object": "benefit.event",
  "program": "bprog_R8mK2pQ9xL4s",
  "entity": "ent_8oWZpQ2rL4sk",
  "worker": null,
  "type": "open_enrollment",
  "subtype": null,
  "date": "2027-01-01",
  "starts": "2026-11-01",
  "ends": "2026-11-30",
  "metadata": {},
  "created": "2026-05-29T12:00:00Z",
  "updated": "2026-05-29T12:00:00Z"
}
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"
}
{
  "id": "benev_K2mP9qR4xL7s",
  "object": "benefit.event",
  "program": "bprog_R8mK2pQ9xL4s",
  "entity": "ent_8oWZpQ2rL4sk",
  "worker": null,
  "type": "open_enrollment",
  "subtype": null,
  "date": "2027-01-01",
  "starts": "2026-11-01",
  "ends": "2026-11-30",
  "metadata": {},
  "created": "2026-05-29T12:00:00Z",
  "updated": "2026-05-29T12:00:00Z"
}