Plans
Create Plan
API Reference
- Authentication
- Carriers
- Components (Embeddable UI)
- Connections
- Dependents
- Employer Documents
- Employers
- Enrollments
- Group Connections
- Members
- Pay Rates
- Payroll Benefits
- Groups
- Plans
- Plan Configurations
- Subclasses
- Tasks
- Reports
Plans
Create Plan
POST
/
plans
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",
"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>"
}
Authorizations
API Key authentication with required prefix "Bearer"
Body
Response
201 - application/json
The response is of type object
.
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",
"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>"
}