Change VPS billing cycle

POST /api/v2/vps/{id}/actions/billing-cycle

Preview or commit a VPS billing-cycle change. Send dryRun: true first to see the target amount and blocker state. The only accepted fields are billingCycle, dryRun, and cancelExistingInvoice; use canonical cycle words only.

VPS Services Plans & Billing

Authentication

Required API scope: write:billing

Authenticate with an API key in the Authorization: Bearer <token> header.

Context

Path Parameters

id string required Example: vps_01hxa3b4c5d6e7f8g9h0j1k2m3

Public VPS ID. Get it from GET /api/v2/vps data[].id. Do not invent this value; use the exact ID returned by the referenced API response.

Headers

Authorization Bearer <token>
Accept application/json
Content-Type application/json

Body

required
application/json
billingCycle string · enum required · Example: monthly
monthly
quarterly
semiannually
annually
biennially
triennially
free
dryRun boolean · Example: true
cancelExistingInvoice boolean · Example: false

Responses

200 Billing-cycle preview or committed change.
Variant 1
dryRun boolean required · Example: true
changed boolean required · Example: false
currentBillingCycle string · enum required · Example: monthly
monthly
quarterly
semiannually
annually
biennially
triennially
free
targetBillingCycle string · enum required · Example: monthly
monthly
quarterly
semiannually
annually
biennially
triennially
free
targetAmount number required · Example: 999
currencyCode string required · Example: SEK
wouldBlock boolean required · Example: false
Variant 2
changed boolean required · Example: true
currentBillingCycle string · enum required · Example: monthly
monthly
quarterly
semiannually
annually
biennially
triennially
free
currencyCode string required · Example: SEK
renewalInvoice object | null · Example: null
renewalInvoice.id string required · Example: inv_01hxa3b4c5d6e7f8g9h0j1k2m3
renewalInvoice.number string · nullable required · Example: 10001

Nullable: may be null when not applicable.

renewalInvoice.amount number required · Example: 99
renewalInvoice.currencyCode string required · Example: SEK
renewalInvoice.dueAt string · nullable required · Example: 2026-05-27T00:00:00.000Z

Nullable: may be null when not applicable.

renewalInvoice.status string · enum required · Example: unpaid
unpaid
paid
cancelled
refunded
collections
unknown
renewalInvoice.paymentUrl string · nullable required · Example: /billing?invoice=10001

Nullable: may be null when not applicable.

cancelledInvoiceIds array<string>
400 Invalid request. The response body is an RFC 7807 Problem Details document.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
401 Unauthorized. Authentication is required.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
403 Forbidden. The caller lacks a required scope or does not own the resource.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
404 Not found. The resource does not exist or is not owned by the caller.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
429 Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
500 Internal error. Retry later or contact support if the issue persists.
type string · Example: https://developer.hostup.se/errors/invalid_request
title string · Example: Validation failed
status integer · Example: 400
detail string · Example: The request body failed validation.
code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders
requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3
timestamp string · Example: 2026-04-27T12:34:56.000Z
errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode
errors[].detail string required · Example: `eppCode` is required for this transfer.
errors[].code string required · Example: missing_required
extensions object
POST https://cloud.hostup.se/api/v2/vps/{id}/actions/billing-cycle
For AI assistants
View as Markdown
cURL 
curl -X POST "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/billing-cycle" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "billingCycle": "annually",
    "dryRun": true
  }'
Response 
// Variant 1
{
  "dryRun": true,
  "changed": false,
  "currentBillingCycle": "monthly",
  "targetBillingCycle": "monthly",
  "targetAmount": 999,
  "currencyCode": "SEK",
  "wouldBlock": false
}

// Variant 2
{
  "changed": true,
  "currentBillingCycle": "monthly",
  "currencyCode": "SEK",
  "renewalInvoice": null,
  "cancelledInvoiceIds": [
    "inv_01hxa3b4c5d6e7f8g9h0j1k2m3"
  ]
}
Request Body Preview annual billing 
{
  "billingCycle": "annually",
  "dryRun": true
}