Skip to main content
PATCH
Update a benefit plan

Parameters

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

Returns

Returns the updated Benefit plan object.