Skip to main content
POST
/
plans
/
{public_id}
/
premiums
cURL
curl --request POST \
  --url https://sandbox.withclasp.com/plans/{public_id}/premiums \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "amount": "<string>",
    "tobacco_usage": true,
    "age": "<string>"
  }
]
'
import requests

url = "https://sandbox.withclasp.com/plans/{public_id}/premiums"

payload = [
{
"amount": "<string>",
"tobacco_usage": True,
"age": "<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([{amount: '<string>', tobacco_usage: true, age: '<string>'}])
};

fetch('https://sandbox.withclasp.com/plans/{public_id}/premiums', 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/plans/{public_id}/premiums",
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([
[
'amount' => '<string>',
'tobacco_usage' => true,
'age' => '<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/plans/{public_id}/premiums"

payload := strings.NewReader("[\n {\n \"amount\": \"<string>\",\n \"tobacco_usage\": true,\n \"age\": \"<string>\"\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/plans/{public_id}/premiums")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"amount\": \"<string>\",\n \"tobacco_usage\": true,\n \"age\": \"<string>\"\n }\n]")
.asString();
require 'uri'
require 'net/http'

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

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 {\n \"amount\": \"<string>\",\n \"tobacco_usage\": true,\n \"age\": \"<string>\"\n }\n]"

response = http.request(request)
puts response.read_body
[
  {
    "amount": "<string>",
    "tobacco_usage": true,
    "age": "<string>"
  }
]

Authorizations

Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Path Parameters

public_id
string
required

Body

amount
string<decimal>
required

The amount of the premium. For example '100' to define a rate of $100.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
coverage_type
enum<string> | null

The coverage type to which this premium applies. For example 'member' to define a rate for a member-only enrollment.

Available options:
member,
member_spouse,
member_child,
member_children,
member_family
tobacco_usage
boolean | null

Whether this rate depends on tobacco usage. Leave null when not applicable.

relationship_category
enum<string> | null

The relationship category to which this premium applies. For example 'member' to define a rate for a member and 'child' to define a rate for a child.

Available options:
member,
spouse,
child
age
string<decimal> | null

The age to which this premium applies. For example '18' to define a rate for a 18-year-old.

Pattern: ^\d{0,2}$

Response

200 - application/json
amount
string<decimal>
required

The amount of the premium. For example '100' to define a rate of $100.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
coverage_type
enum<string> | null

The coverage type to which this premium applies. For example 'member' to define a rate for a member-only enrollment.

Available options:
member,
member_spouse,
member_child,
member_children,
member_family
tobacco_usage
boolean | null

Whether this rate depends on tobacco usage. Leave null when not applicable.

relationship_category
enum<string> | null

The relationship category to which this premium applies. For example 'member' to define a rate for a member and 'child' to define a rate for a child.

Available options:
member,
spouse,
child
age
string<decimal> | null

The age to which this premium applies. For example '18' to define a rate for a 18-year-old.

Pattern: ^\d{0,2}$