Skip to main content
POST
/
v1
/
benefit
/
plans
Create a benefit plan
curl --request POST \
  --url https://api.plane.com/v1/benefit/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "program": "<string>",
  "provider": "<string>",
  "name": "<string>",
  "type": "<string>",
  "coverages": [
    {}
  ],
  "country": {},
  "network": {},
  "status": "<string>",
  "starts": {},
  "ends": {},
  "eligibility": {},
  "contribution": {},
  "terms": {},
  "resources": {},
  "metadata": {}
}
'
{
  "program": "bprog_R8mK2pQ9xL4s",
  "provider": "benpr_8oWZpQ2rL4sk",
  "name": "UnitedHealthcare PPO — Gold",
  "type": "medical",
  "coverages": ["employee_only", "family"]
}

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

​
program
string
required
ID of the program the plan belongs to.
​
provider
string
required
ID of the carrier (benefit provider).
​
name
string
required
Human-readable plan name.
​
type
string
required
Benefit category. One of medical, dental, vision, life, disability, retirement, or other.
​
coverages
array
Coverage tiers the plan offers, e.g. ["employee_only", "family"].
​
country
string | null
ISO-3166 country the plan is offered in. Omit for a global plan.
​
network
string | null
Network name or type (e.g. ppo, hmo).
​
status
string
Plan status. One of draft, active, or inactive. Defaults to draft.
​
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. Omit to offer it to anyone eligible for the program.
​
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 created Benefit plan object. 
{
  "program": "bprog_R8mK2pQ9xL4s",
  "provider": "benpr_8oWZpQ2rL4sk",
  "name": "UnitedHealthcare PPO — Gold",
  "type": "medical",
  "coverages": ["employee_only", "family"]
}