Skip to main content
POST
/
enrollments
/
{public_id}
/
eligible_plans
cURL
curl --request POST \
  --url https://sandbox.withclasp.com/enrollments/{public_id}/eligible_plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dependents": [
    "<string>"
  ],
  "volume_elections": [
    {
      "plan": "<string>",
      "amount": "<string>",
      "dependent": "<string>"
    }
  ]
}
'
import requests

url = "https://sandbox.withclasp.com/enrollments/{public_id}/eligible_plans"

payload = {
"dependents": ["<string>"],
"volume_elections": [
{
"plan": "<string>",
"amount": "<string>",
"dependent": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dependents: ['<string>'],
volume_elections: [{plan: '<string>', amount: '<string>', dependent: '<string>'}]
})
};

fetch('https://sandbox.withclasp.com/enrollments/{public_id}/eligible_plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.withclasp.com/enrollments/{public_id}/eligible_plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'dependents' => [
'<string>'
],
'volume_elections' => [
[
'plan' => '<string>',
'amount' => '<string>',
'dependent' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sandbox.withclasp.com/enrollments/{public_id}/eligible_plans"

payload := strings.NewReader("{\n \"dependents\": [\n \"<string>\"\n ],\n \"volume_elections\": [\n {\n \"plan\": \"<string>\",\n \"amount\": \"<string>\",\n \"dependent\": \"<string>\"\n }\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sandbox.withclasp.com/enrollments/{public_id}/eligible_plans")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"dependents\": [\n \"<string>\"\n ],\n \"volume_elections\": [\n {\n \"plan\": \"<string>\",\n \"amount\": \"<string>\",\n \"dependent\": \"<string>\"\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.withclasp.com/enrollments/{public_id}/eligible_plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dependents\": [\n \"<string>\"\n ],\n \"volume_elections\": [\n {\n \"plan\": \"<string>\",\n \"amount\": \"<string>\",\n \"dependent\": \"<string>\"\n }\n ]\n}"

response = http.request(request)
puts response.read_body
[
  {
    "plan": {
      "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": {}
    },
    "member_contribution": "<string>",
    "employer_contribution": "<string>",
    "per_pay_period_employer_contribution": "<string>",
    "per_pay_period_member_contribution": "<string>",
    "eligible_dependent_ids": [
      "<string>"
    ],
    "tax_advantaged_account_limit": {
      "limit_type": "<string>",
      "individual_limit": "<string>",
      "family_limit": "<string>",
      "catch_up_limit": "<string>",
      "yearly_contribution_limit": "<string>",
      "monthly_contribution_limit": "<string>"
    },
    "volumes": [
      {
        "amount": "<string>",
        "dependent": "<string>"
      }
    ]
  }
]

Authorizations

Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Path Parameters

public_id
string
required

Body

application/json
dependents
string[]
required
volume_elections
object[] | null

Response

200 - application/json
plan
object
required
member_contribution
string<decimal>
required
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
employer_contribution
string<decimal>
required
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
per_pay_period_employer_contribution
string<decimal>
required
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
per_pay_period_member_contribution
string<decimal>
required
Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
eligible_dependent_ids
string[]
required
read-only
tax_advantaged_account_limit
object | null
volumes
object[] | null