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

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

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}$