Skip to main content
POST
Get a quote for a server order

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

plan_key
string
required

The value of plan_key.

Required string length: 64
billing_cycle
enum<string>

How often the service renews and is billed.

Available options:
monthly,
quarterly,
semiannually,
annually,
biennially,
triennially

Response

The record, as a JSON object. There is no envelope.

plan
object
required

The value of plan.

Example:
plan_key
string
required

The value of plan_key.

Example:

"032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4"

group
object
required

The value of group.

Example:
location
object
required

The value of location.

Example:
location_id
integer | null
required

The location id ID.

Example:

3

product_group_id
integer | null
required

The product group id ID.

Example:

2

amount
string
required

The amount in the currency shown by currency.

Example:

"12.00"

currency
string
required

The three-letter currency code used for monetary amounts.

Example:

"USD"

billing_cycle
string
required

How often the service renews and is billed.

Example:

"monthly"

billing_cycle_months
integer
required

The value of billing_cycle_months.

Example:

1

payment_window_minutes
integer
required

How many minutes the original payment window allowed.

Example:

30

quote_token
string
required

The value of quote_token.

Example:

"eyJ2ZXJzaW9uIjoxLCJub25jZSI6IjNmYWRiNjgyM2ZmZTkyY2Q0ZDkwYzRkNjg4YTdjZWY5ZjBiYjBjZDE1YjVhM2VlMGE2MzMyZmU1YmQ4Njg1YWYiLCJvd25lcl9pZCI6MTg3Mywib3duZXJfZW1haWwiOiJnb3Jkb24uZnJlZW1hbkBibGFja21lc2EuZXhhbXBsZS5jb20iLCJleHBpcmVzX2F0IjoxNzg5NDA0NzI5LCJ3aG1jc19jb25maWd1cmF0aW9uX2ZpbmdlcnByaW50IjoiZTY3ZDIzZTc4MjBjNDlhOCJ9.f84ed5bfb2e3e24710926d5ccf5902fc93d0c9a0a45365dd784e1aa72d4083f0"