Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Path Parameters

public_id
string
required

Response

200 - application/json
id
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
plan_name
string
required
read-only
plan_type
string | null
required
read-only
line_of_coverage
enum<string>
required
  • accident - Accident
  • accidental_death - Accidental Death and Dismemberment
  • cancer - Cancer
  • commuter_parking - Commuter Parking
  • commuter_transit - Commuter Transit
  • dental - Dental
  • dependent_care_fsa - Dependent Care Flexible Spending Account
  • employee_assistance_program - Employee Assistance Program
  • healthcare_fsa - Healthcare Flexible Spending Account
  • hospital_indemnity - Hospital Indemnity
  • hsa - Health Savings Account
  • legal_services - Legal Services
  • life - Life
  • limited_purpose_fsa - Limited Purpose Flexible Spending Account
  • long_term_disability - Long Term Disability
  • lump_sum_disability - Lump Sum Disability
  • medical - Medical
  • pet_insurance - Pet Insurance
  • short_term_disability - Short Term Disability
  • supplemental - Supplemental
  • telemedicine - Telemedicine
  • vision - Vision
  • voluntary_critical_illness - Voluntary Critical Illness
  • voluntary_life - Voluntary Life
  • voluntary_accidental_death - Voluntary Accidental Death
  • voluntary_long_term_disability - Voluntary Long Term Disability
  • voluntary_ltd - Voluntary LTD
  • voluntary_short_term_disability - Voluntary Short Term Disability
Available options:
accident,
accidental_death,
cancer,
commuter_parking,
commuter_transit,
dental,
dependent_care_fsa,
employee_assistance_program,
healthcare_fsa,
hospital_indemnity,
hsa,
legal_services,
life,
limited_purpose_fsa,
long_term_disability,
lump_sum_disability,
medical,
pet_insurance,
short_term_disability,
supplemental,
telemedicine,
vision,
voluntary_critical_illness,
voluntary_life,
voluntary_accidental_death,
voluntary_long_term_disability,
voluntary_ltd,
voluntary_short_term_disability
group
string
required
effective_start
string<date>
required
read-only
effective_end
string<date>
required
read-only
member_count
integer
required
read-only
dependent_count
integer
required
read-only
requires_primary_care_provider
boolean
required
read-only
plan_details
any
required
plan_summary_url
string | null
required
read-only
is_low_cost
boolean | null
provides_minimum_value
boolean | null
provides_essential_coverage
boolean | null
dependent_coverage_excluded
boolean | null
spouse_coverage_excluded
boolean | null
bundle
string | null
premium_type
enum<string> | null
Available options:
composite,
age_banded,
volume_based
partner_dependents_eligible
boolean
read-only
child_dependents_eligible
boolean
read-only
voluntary_coverage_options
object | null
read-only
plan_configurations
string[]
read-only
required_enrollment
boolean
read-only
hsa_eligible
boolean
is_pre_tax
boolean
read-only
cobra_eligible
boolean
read-only
max_contributing_children
integer | null
deprecated
read-only

Deprecated: use max_contributing_entities and max_contributing_type.

max_contributing_entities
integer | null

Maximum number of dependents charged a premium on age-banded and volume-based plans. Dependents are charged oldest first; dependents beyond the cap add no premium. Null if the plan has no cap. Must be set together with max_contributing_type.

max_contributing_type
enum<string> | null

Which dependents count toward max_contributing_entities. children caps only child dependents; all_dependents caps spouses, partners, and children together. Must be set together with max_contributing_entities.

Available options:
children,
all_dependents
max_contributing_child_age
integer | null

The maximum age at which a covered child counts toward the max contributing children cap. Children older than this are charged the premium for their own age and do not count toward the cap. If not set, all children count toward the cap. Can only be set when max_contributing_type is children.

required_regions
enum<string>[]
read-only
  • AL - AL
  • AK - AK
  • AZ - AZ
  • AR - AR
  • CA - CA
  • CO - CO
  • CT - CT
  • DE - DE
  • DC - DC
  • FL - FL
  • GA - GA
  • HI - HI
  • ID - ID
  • IL - IL
  • IN - IN
  • IA - IA
  • KS - KS
  • KY - KY
  • LA - LA
  • ME - ME
  • MD - MD
  • MA - MA
  • MI - MI
  • MN - MN
  • MS - MS
  • MO - MO
  • MT - MT
  • NE - NE
  • NV - NV
  • NH - NH
  • NJ - NJ
  • NM - NM
  • NY - NY
  • NC - NC
  • ND - ND
  • OH - OH
  • OK - OK
  • OR - OR
  • PA - PA
  • RI - RI
  • SC - SC
  • SD - SD
  • TN - TN
  • TX - TX
  • UT - UT
  • VT - VT
  • VA - VA
  • WA - WA
  • WV - WV
  • WI - WI
  • WY - WY
Available options:
AL,
AK,
AZ,
AR,
CA,
CO,
CT,
DE,
DC,
FL,
GA,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VA,
WA,
WV,
WI,
WY
minimum_hours_worked
integer | null
read-only
base_spouse_age_off_member
integer | null
read-only
age_calculation_method
enum<string> | null
read-only
Available options:
coverage_start_date,
plan_start_date
newly_available
boolean
allowed_employment_statuses
enum<string>[]
  • full_time - Full Time
  • part_time - Part Time
  • variable_hours - Variable Hours
Available options:
full_time,
part_time,
variable_hours
union_eligible
boolean | null
seasonal_eligible
boolean | null
partner_enrollment_required
boolean
child_enrollment_required
boolean
create_payroll_benefits
boolean
metadata
object

Up to 50 key-value pairs. Keys max 40 characters, values max 500 characters. Set a value to empty string to remove a key. On PATCH, metadata is merged with existing values.