## POST /api/v2/vps/{id}/actions/cancel

**Cancel VPS**

Submit a cancellation request for a VPS. Get `{id}` from `GET /api/v2/vps` `data[].id`. Use `GET /api/v2/vps/{id}/cancellation` to read the current cancellation status and `DELETE /api/v2/vps/{id}/cancellation` to remove a pending or scheduled cancellation. The body accepts only `reason`, optional `cancelType`, and optional `otherReason`; unknown fields are rejected. If the response has `cancellationLookupPending: true`, the request was accepted and the caller should poll the status endpoint shortly. Cancellation can return 409 when an overdue invoice blocks the request.

### Related Endpoints

- `GET /api/v2/vps/{id}/cancellation`: Get VPS cancellation status
- `DELETE /api/v2/vps/{id}/cancellation`: Remove VPS cancellation
- `GET /api/v2/vps/{id}`: Get VPS details

### Headers

- `Accept`: application/json
- `Authorization`: Bearer YOUR_API_KEY
- Required API scope: `write:billing`
- `Content-Type`: application/json

### Parameters

- `id` (path, string, required): Public VPS ID from `GET /api/v2/vps` `data[].id`. Do not invent this value; use the exact ID returned by the referenced API response. Example: `vps_01hxa3b4c5d6e7f8g9h0j1k2m3`

### Request Body

- `reason` (string, optional): Cancellation reason. The customer portal currently sends values such as `No longer needed`, `Found a better alternative`, `Too expensive`, `Poor performance`, `Technical issues`, `Moving to different provider`, `Business closure`, or `other`. The API accepts any non-empty string up to 500 characters. Example: `Moving to different provider`
- `cancelType` (string, optional): `end_of_period` requests cancellation at the end of the current billing period. `immediate` requests cancellation as soon as processing completes. Example: `end_of_period`
  Allowed values: immediate, end_of_period
- `otherReason` (string, optional): Free-text explanation when `reason` is `other`. Omit this field for standard reason values. Example: `Consolidating services into another account.`

### Request Examples

#### Cancel at billing period end

```bash
curl -X POST "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/cancel" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Moving to different provider",
    "cancelType": "end_of_period"
  }'
```

```json
{
  "reason": "Moving to different provider",
  "cancelType": "end_of_period"
}
```

#### Cancel immediately with free-text reason

```bash
curl -X POST "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/cancel" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "other",
    "otherReason": "Consolidating workloads into another environment.",
    "cancelType": "immediate"
  }'
```

```json
{
  "reason": "other",
  "otherReason": "Consolidating workloads into another environment.",
  "cancelType": "immediate"
}
```

### Response Schema

- `vpsId` (string, optional): Public VPS ID from `GET /api/v2/vps` `data[].id`. Example: `vps_01hxa3b4c5d6e7f8g9h0j1k2m3`
- `status` (string, optional): `none` means no cancellation record exists; the status endpoint still returns 200 with the stable cancellation shape. Example: `scheduled`
  Allowed values: pending, scheduled, completed, revoked, none
- `cancelledAt` (string,null, optional): When the cancellation request was recorded, if known. Example: `2026-04-27T12:00:00.000Z`
- `scheduledAt` (string,null, optional): Effective cancellation date if known. For immediate cancellation this may match `cancelledAt`. Example: `2026-05-27T00:00:00.000Z`
- `reason` (string,null, optional): Stored cancellation reason, or null when no cancellation exists. Example: `Moving to different provider`
- `cancelType` (string,null, optional): Requested cancellation timing, or null when no cancellation exists or the stored record did not expose timing. Example: `end_of_period`
  Allowed values: immediate, end_of_period, 
- `revokable` (boolean, optional): True while the cancellation is pending or scheduled and can be removed with DELETE `/api/v2/vps/{id}/cancellation`. Example: `true`
- `cancelledPendingOrder` (boolean, optional): Present only when the service was still a pending order and the API cancelled the pending order instead of creating a service cancellation. Example: `true`
- `cancelledOrderId` (string, optional): Public order ID when `cancelledPendingOrder` is true. Example: `ord_01hxa3b4c5d6e7f8g9h0j1k2m3`
- `cancellationLookupPending` (boolean, optional): Present only when the cancellation request was accepted but the stored cancellation record was not readable yet. Poll GET `/api/v2/vps/{id}/cancellation` shortly after receiving this state. Example: `true`
- `submissionAccepted` (boolean, optional): Present with `cancellationLookupPending` to confirm the cancellation request was accepted. Example: `true`
- `notice` (object, optional)
- `notice.code` (string, required) Example: `cancellation_record_pending`
  Allowed values: pending_order_cancelled, cancellation_record_pending
- `notice.detail` (string, required) Example: `Cancellation request accepted, but the stored cancellation record is not available yet. Re-read the cancellation status shortly.`

### Responses

#### 200 - Cancellation request accepted, but there is no readable service cancellation record yet.
```json
{
  "vpsId": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "status": "none",
  "cancelledAt": null,
  "scheduledAt": null,
  "reason": null,
  "cancelType": null,
  "revokable": false,
  "cancellationLookupPending": true,
  "submissionAccepted": true,
  "notice": {
    "code": "cancellation_record_pending",
    "detail": "Cancellation request accepted, but the stored cancellation record is not available yet. Re-read the cancellation status shortly."
  }
}
```

#### 201 - Cancellation created and readable.
```json
{
  "vpsId": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "status": "pending",
  "cancelledAt": "2026-04-27T12:00:00.000Z",
  "scheduledAt": "2026-05-27T00:00:00.000Z",
  "reason": "Moving to different provider",
  "cancelType": "end_of_period",
  "revokable": true
}
```

#### 400 - Invalid request. The response body is an RFC 7807 Problem Details document.
```json
{
  "type": "https://developer.hostup.se/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request body failed validation.",
  "code": "invalid_request",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "errors": [
    {
      "pointer": "/items/0/domainName",
      "detail": "`domainName` is required.",
      "code": "invalid_request"
    }
  ]
}
```

#### 401 - Unauthorized. Authentication is required.
```json
{
  "type": "https://developer.hostup.se/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required.",
  "code": "unauthorized",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 403 - Forbidden. The caller lacks a required scope or does not own the resource.
```json
{
  "type": "https://developer.hostup.se/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The caller lacks a required scope or does not own the resource.",
  "code": "forbidden",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 404 - Not found. The resource does not exist or is not owned by the caller.
```json
{
  "type": "https://developer.hostup.se/errors/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource could not be found.",
  "code": "not_found",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 409 - Conflict. See the Problem Details `code` for the route-specific blocker and recovery fields.
```json
{
  "status": 409,
  "instance": "/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/cancel",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "type": "https://developer.hostup.se/errors/cancellation_blocked_overdue_invoice",
  "title": "Cancellation blocked",
  "detail": "Pay the overdue invoice before requesting cancellation for this service.",
  "code": "cancellation_blocked_overdue_invoice",
  "actions": {
    "canCancel": {
      "allowed": false,
      "reason": "Pay the overdue invoice before requesting cancellation for this service."
    }
  }
}
```

#### 429 - Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
```json
{
  "type": "https://developer.hostup.se/errors/rate_limit_exceeded",
  "title": "Too many requests",
  "status": 429,
  "detail": "Too many requests. Retry after the limit resets.",
  "code": "rate_limit_exceeded",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 500 - Internal error. Retry later or contact support if the issue persists.
```json
{
  "type": "https://developer.hostup.se/errors/internal_error",
  "title": "Internal server error",
  "status": 500,
  "detail": "An unexpected error occurred. Retry later or contact support if the issue persists.",
  "code": "internal_error",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```