Skip to main content
GET
/
plans
/
{public_id}
cURL
curl --request GET \
  --url https://sandbox.withclasp.com/plans/{public_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "plan_name": "<string>",
  "plan_type": "<string>",
  "group": "<string>",
  "effective_start": "2023-12-25",
  "effective_end": "2023-12-25",
  "member_count": 123,
  "dependent_count": 123,
  "requires_primary_care_provider": true,
  "plan_details": "<unknown>",
  "plan_summary_url": "<string>",
  "is_low_cost": true,
  "provides_minimum_value": true,
  "provides_essential_coverage": true,
  "dependent_coverage_excluded": true,
  "spouse_coverage_excluded": true,
  "bundle": "<string>",
  "partner_dependents_eligible": true,
  "child_dependents_eligible": true,
  "voluntary_coverage_options": {},
  "plan_configurations": [
    "<string>"
  ],
  "required_enrollment": true,
  "hsa_eligible": true,
  "is_pre_tax": true,
  "cobra_eligible": true,
  "max_contributing_children": 123,
  "required_regions": [],
  "minimum_hours_worked": 123,
  "base_spouse_age_off_member": 123,
  "newly_available": true,
  "allowed_employment_statuses": [
    "full_time",
    "part_time"
  ],
  "union_eligible": true,
  "seasonal_eligible": true,
  "partner_enrollment_required": true,
  "child_enrollment_required": true,
  "create_payroll_benefits": true,
  "metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.withclasp.com/llms.txt

Use this file to discover all available pages before exploring further.

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
  • healthcare_fsa - Healthcare Flexible Spending Account
  • hospital_indemnity - Hospital Indemnity
  • hsa - Health Savings Account
  • life - Life
  • limited_purpose_fsa - Limited Purpose Flexible Spending Account
  • long_term_disability - Long Term Disability
  • lump_sum_disability - Lump Sum Disability
  • medical - Medical
  • 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_short_term_disability - Voluntary Short Term Disability
Available options:
accident,
accidental_death,
cancer,
commuter_parking,
commuter_transit,
dental,
dependent_care_fsa,
healthcare_fsa,
hospital_indemnity,
hsa,
life,
limited_purpose_fsa,
long_term_disability,
lump_sum_disability,
medical,
short_term_disability,
supplemental,
telemedicine,
vision,
voluntary_critical_illness,
voluntary_life,
voluntary_accidental_death,
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
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
read-only
​
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.