Skip to main content
PATCH
/
v1
/
benefit
/
plans
/
{id}
Update a benefit plan
curl --request PATCH \
  --url https://api.plane.com/v1/benefit/plans/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "status": "<string>",
  "coverages": [
    {}
  ],
  "country": {},
  "network": {},
  "starts": {},
  "ends": {},
  "eligibility": {},
  "contribution": {},
  "terms": {},
  "resources": {},
  "metadata": {}
}
'

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

​
id
string
required
ID of the benefit plan.
​
name
string
Human-readable plan name.
​
type
string
Benefit category. One of medical, dental, vision, life, disability, retirement, or other.
​
status
string
Plan status. One of draft, active, or inactive.
​
coverages
array
Coverage tiers the plan offers.
​
country
string | null
ISO-3166 country the plan is offered in.
​
network
string | null
Network name or type.
​
starts
date | null
First day the plan is in effect.
​
ends
date | null
Last day the plan is in effect.
​
eligibility
string | null
CEL expression deciding which workers may elect this plan, evaluated against the worker shape.
​
contribution
object
Employer cost-sharing policy, by coverage tier.
​
terms
object
Display summary of plan terms.
​
resources
object
Plan materials — links and document references.
​
metadata
object
Set of key-value pairs attached to the plan.

​
Returns

Returns the updated Benefit plan object.