Skip to content

Get VPS cancellation status

GET /api/v2/vps/{id}/cancellation

Get the cancellation of one VPS: its status, when it takes effect and whether it can still be withdrawn. A VPS without a cancellation returns 200 with status: "none", not 404. When revokable is true, DELETE /api/v2/vps/{id}/cancellation withdraws it. To cancel a VPS, use POST /api/v2/vps/{id}/actions/cancel.

Authentication: An API key with the scope read:vm. About keys and scopes

Request

Path parameters

idstringrequired
The VPS ID (vps_…).

Example

GET /api/v2/vps/{id}/cancellation
curl "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/cancellation" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 The VPS’s cancellation. status: "none" when there is none.

Response 200
{
"vpsId": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3",
"status": "pending",
"cancelledAt": "2026-10-20T09:12:00.000Z",
"scheduledAt": "2026-11-27T00:00:00.000Z",
"reason": "Moving the site to another server",
"cancelType": "end_of_period",
"revokable": true
}
Response fields
vpsIdstring
The VPS ID (vps_…).
statusstring
none means there is no cancellation. The status endpoint still returns 200 with the same shape. One of pending, scheduled, completed, revoked, none.
cancelledAtstring or null
When the cancellation was requested, if known.
scheduledAtstring or null
When the cancellation takes effect, if known. For end_of_period it is the end of the paid period. For immediate it equals cancelledAt, the time of the request.
reasonstring or null
The cancellation reason. Null when there is no cancellation.
cancelTypestring or null
When the cancellation takes effect. Null when there is no cancellation or the timing was not recorded. One of immediate, end_of_period.
revokableboolean
True while the cancellation is pending or scheduled. Remove it with DELETE /api/v2/vps/{id}/cancellation.
cancelledPendingOrderboolean
Present only when the VPS was still a pending order. The order was then cancelled instead of the service.
cancelledOrderIdstring
The order ID when cancelledPendingOrder is true.
cancellationLookupPendingboolean
Present only when the request was accepted but the cancellation could not be read back yet. Call GET /api/v2/vps/{id}/cancellation again shortly.
submissionAcceptedboolean
Present with cancellationLookupPending. Confirms that the request was accepted.
noticeobject
codestring
One of pending_order_cancelled, cancellation_record_pending.
detailstring

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404Not found. The resource does not exist or is not owned by the caller; code is vps_not_found.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.