Skip to main content
GET
Get a plan (brokers)

Authorizations

Authorization
string
header
required

Partner API key. psk_test_<32 hex> for test mode, psk_live_<32 hex> for live mode. Store them in your secrets manager on issue. Live keys are shown once; the scoped partner portal can show an active sandbox key again.

Path Parameters

planId
enum<string>
required
Available options:
diamond,
value

Response

The plan.

id
enum<string>
required
Available options:
diamond,
value
name
string
required
description
string
required

One plain line on what the plan is.

benefits
object
required
member_terms
string
required

How the member cost-sharing reads. The amounts for a group are in its quote (member_deductible, member_oop_max).

logos
object
required
employer_contribution
object

The share of premium an employer may pay.

selling_guide
object

The selling skill: a zip for Agent Skills, and the SKILL.md.

disclaimers
string[]