Skip to main content
POST
/
v1
/
benefit
/
enrollments
/
{id}
/
cancel
Cancel a benefit enrollment
curl --request POST \
  --url https://api.plane.com/v1/benefit/enrollments/{id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "bene_X8pR5sT1vA4o",
  "object": "benefit.enrollment",
  "worker": "wrkr_8oWZpQ2rL4sk",
  "event": "benev_K2mP9qR4xL7s",
  "status": "cancelled",
  "metadata": {},
  "created": "2026-05-29T12:00:00Z",
  "updated": "2026-05-29T12:05:00Z"
}

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.

Cancel the worker’s run. The enrollment moves to cancelled. An enrollment can be cancelled from not_started, in_progress, or submitted.

​
Parameters

​
id
string
required
ID of the benefit enrollment.

​
Returns

Returns the cancelled Benefit enrollment object. 
{
  "id": "bene_X8pR5sT1vA4o",
  "object": "benefit.enrollment",
  "worker": "wrkr_8oWZpQ2rL4sk",
  "event": "benev_K2mP9qR4xL7s",
  "status": "cancelled",
  "metadata": {},
  "created": "2026-05-29T12:00:00Z",
  "updated": "2026-05-29T12:05:00Z"
}