Skip to main content
POST
Get a quote for a plan change

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.

Path Parameters

server
string
required

The server UUID

Example:

"ecc6f4f1"

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
resize_disk
boolean
required

The value of resize_disk.

Response

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

amount
string
required

The amount in the currency shown by currency.

Example:

"6.00"

refund_amount
string
required

The value of refund_amount.

Example:

"0.00"

location_change_fee
string
required

The value of location_change_fee.

Example:

"0.00"

currency
string
required

The three-letter currency code used for monetary amounts.

Example:

"USD"

days_remaining
integer
required

The value of days_remaining.

Example:

18

total_days
integer
required

The value of total_days.

Example:

30

billing_cycle
string
required

How often the service renews and is billed.

Example:

"Monthly"

current_recurring_amount
string
required

The value of current_recurring_amount.

Example:

"12.00"

target_recurring_amount
string
required

The value of target_recurring_amount.

Example:

"22.00"

quote_token
string
required

The value of quote_token.

Example:

"eyJpdiI6InZVUENaRU81VXMyL1psak9tNS8xTGc9PSIsInZhbHVlIjoib2JiS0ZkbXVmREY0OXBHeXorZEx5Wi81Z3F1UzF0L3RENFBnNTFIZHJ6YUl3RGZYclUrbWoydFpOYkkyT1Q2SklmbVlYdGU4WEVHaWlPRHBQbExSUnp4VkdZbk1ZY0JRZ0U4d0NNbDB1eFVSbVFIZ0xkdkxLdDZzZTZodkFZdEFqV3dBTk1HaTVPNWRpTmpJdjlQSEVNNjZjYWV1UnhGUW1pTEovY2VSQUdPMEg3MDRldWxEN2tBc0Rzd1VEK2pNa01uNEx1bXlLSExZUldobUw0ODVWbWlNZjlKRWIvTFJlaThQd1A0S2kwY3dFejgrZ2NmczZlWGdLVENRL1VoelBJczJ0LzgxMTBXZnlOaFRHSEplRk0zWTQ5cXZHRXhlUGFyV292ZGRHN0FpaWtVVzZhUnFBOGRLcm40TUx3TFIiLCJtYWMiOiJhNmViM2NiYTY0OWI5ZTUxMDkzNGQxYjBkMjRmMWIzZTg2NWE4MWMzYjk2YjIxZDc1NTAyMThjMTliYWQzZGM2IiwidGFnIjoiIn0="

plan_key
string
required

The value of plan_key.

Example:

"84ee2bf7fc22f495e76aead064154e1d5ae66fee1ac71cda7cf48d9e607a60bc"

plan_name
string
required

The value of plan_name.

Example:

"Standard 8 GB"

source_location_id
integer
required

The source location id ID.

Example:

3

target_location_id
integer
required

The target location id ID.

Example:

3

source_location
string
required

The value of source_location.

Example:

"Kansas City, MO"

target_location
string
required

The value of target_location.

Example:

"Kansas City, MO"

requires_migration
boolean
required

Whether this action requires migration.

Example:

false

requires_ip_replacement
boolean
required

Whether this action requires ip replacement.

Example:

false

resize_disk
boolean
required

The value of resize_disk.

Example:

true