Skip to main content
GET
Get the current 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"

Response

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

A plan change, as the customer who bought it is shown one.

uuid
string
required

The uuid UUID.

Example:

"2946b7c6-1b8d-4279-880f-629c9dd8f48c"

status
enum<string>
required

The value of status.

Available options:
pending_payment,
queued,
stopping,
migrating,
resizing,
networking,
finalizing,
completed,
failed,
expired,
payment_review,
cancelled
Example:

"pending_payment"

status_label
string
required

The value of status_label.

Example:

"Paying from account credit"

stage
string | null
required

The value of stage.

Example:

"awaiting_billing"

progress
integer
required

The value of progress.

Example:

0

progress_message
string | null
required

The value of progress_message.

Example:

"Paying for the change from your account credit."

location_change_fee
string | null
required

The value of location_change_fee.

Example:

"0.00"

billing
BillingData · object
required

The value of billing.

Example:
source_location
string | null
required

The value of source_location.

Example:

"Kansas City, MO"

target_location
string | null
required

The value of target_location.

Example:

"Kansas City, MO"

requires_migration
boolean
required

Whether this action requires migration.

Example:

false

crosses_location
boolean
required

The value of crosses_location.

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

plan_name
string | null
required

The value of plan_name.

Example:

"Standard 8 GB"

product_group_name
string | null
required

The value of product_group_name.

Example:

"Standard VPS"

source_cpu
integer | null
required

The plan the customer bought, spelled out against what the server has today. These are the snapshot taken at checkout, so they keep describing the change even after the feed moves on.

Example:

4

source_memory
integer | null
required

The value of source_memory.

Example:

4294967296

source_disk
integer | null
required

The value of source_disk.

Example:

85899345920

source_bandwidth
integer | null
required

The value of source_bandwidth.

Example:

5497558138880

target_cpu
integer | null
required

The value of target_cpu.

Example:

6

target_memory
integer | null
required

The value of target_memory.

Example:

8589934592

target_disk
integer | null
required

The value of target_disk.

Example:

171798691840

target_bandwidth
integer | null
required

The value of target_bandwidth.

Example:

10995116277760

transferred_bytes
integer | null
required

The value of transferred_bytes.

Example:

null

total_bytes
integer | null
required

The value of total_bytes.

Example:

null

can_cancel
boolean
required

Whether the customer can cancel.

Example:

true

error
string | null
required

A customer-safe explanation of the failure. Internal billing diagnostics are never published here.

Example:

null

support_reference
string | null
required

The value of support_reference.

Example:

null

created_at
string | null
required

The date and time for created at, in UTC.

Example:

"2026-09-14T16:42:09+00:00"

started_at
string | null
required

The date and time for started at, in UTC.

Example:

null

completed_at
string | null
required

The date and time for completed at, in UTC.

Example:

null