Skip to main content
POST
/
plans
cURL
curl --request POST \
  --url https://sandbox.withclasp.com/plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "plan_name": "<string>",
  "plan_type": "<string>",
  "line_of_coverage": "accident",
  "group": "<string>",
  "effective_start": "2023-12-25",
  "effective_end": "2023-12-25",
  "requires_primary_care_provider": true,
  "plan_details": [
    {
      "label": "<string>",
      "tooltip": "<string>",
      "info_lines": [
        "<string>"
      ]
    }
  ],
  "premium_type": "age_banded",
  "hsa_eligible": false,
  "age_rates": [
    {
      "age": 123,
      "amount": "<string>"
    }
  ],
  "composite_rates": {
    "member": "<string>",
    "member_spouse": "<string>",
    "member_child": "<string>",
    "member_children": "<string>",
    "member_family": "<string>"
  }
}'
{
  "id": "<string>",
  "plan_name": "<string>",
  "plan_type": "<string>",
  "line_of_coverage": "accident",
  "group": "<string>",
  "effective_start": "2023-12-25",
  "effective_end": "2023-12-25",
  "member_count": 123,
  "dependent_count": 123,
  "requires_primary_care_provider": true,
  "is_low_cost": true,
  "provides_minimum_value": true,
  "provides_essential_coverage": true,
  "dependent_coverage_excluded": true,
  "spouse_coverage_excluded": true,
  "plan_details": "<any>",
  "plan_summary_url": "<string>",
  "bundle": "<string>",
  "allowed_employment_statuses": [
    "full_time",
    "part_time"
  ],
  "union_eligible": true,
  "seasonal_eligible": true
}

Authorizations

​
Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Body

​
plan_name
string

Human-readable name of the plan

​
plan_type
string

Type of plan (ppo/hmo/dhmo/...)

​
line_of_coverage
enum<string>
  • accident - Accident
  • accidental_death - Accidental Death and Dismemberment
  • cancer - Cancer
  • 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
  • medical - Medical
  • short_term_disability - Short Term Disability
  • 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,
dental,
dependent_care_fsa,
healthcare_fsa,
hospital_indemnity,
hsa,
life,
limited_purpose_fsa,
long_term_disability,
medical,
short_term_disability,
vision,
voluntary_critical_illness,
voluntary_life,
voluntary_accidental_death,
voluntary_short_term_disability
​
group
string

ID of group to create plan under

​
effective_start
string<date>
​
effective_end
string<date>
​
requires_primary_care_provider
boolean

Whether a plan requires employees to select primary care providers during enrollment. (Commonly used for HMO plans)

​
plan_details
object[]

High-level details of plan that is shown during enrollment

​
premium_type
enum<string>

High-level details of plan that is shown during enrollment

Available options:
age_banded,
composite
​
hsa_eligible
boolean
default:false
​
age_rates
object[]

Rates for all covered lives from ages 0 to 99. This should only be present when premium_type is age_banded

​
composite_rates
object

Rates for each coverage tier. This should only be present when premium_type is composite

Response

201 - application/json
​
id
string
required
​
plan_name
string
required
​
plan_type
string | null
required
​
line_of_coverage
enum<string>
required
  • accident - Accident
  • accidental_death - Accidental Death and Dismemberment
  • cancer - Cancer
  • 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
  • medical - Medical
  • short_term_disability - Short Term Disability
  • 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,
dental,
dependent_care_fsa,
healthcare_fsa,
hospital_indemnity,
hsa,
life,
limited_purpose_fsa,
long_term_disability,
medical,
short_term_disability,
vision,
voluntary_critical_illness,
voluntary_life,
voluntary_accidental_death,
voluntary_short_term_disability
​
group
string
required
​
effective_start
string<date>
required
​
effective_end
string<date>
required
​
member_count
integer
required
​
dependent_count
integer
required
​
requires_primary_care_provider
boolean
required
​
plan_details
any
required
​
plan_summary_url
string | null
required
​
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
​
allowed_employment_statuses
enum<string>[]
​
union_eligible
boolean | null
​
seasonal_eligible
boolean | null