Change domain billing cycle

POST /api/v2/domains/{id}/billing-cycle

Change the renewal period for one domain.

Get {id} from GET /api/v2/domains data[].id and read GET /api/v2/domains/{id}/billing-cycle immediately first.

Send only a period that appears in that GET response's options[]; supported year counts vary by TLD/product and clients must not invent 1-9 year periods.

Send billingCycle for canonical 1, 2, or 3 year rows (annually, biennially, triennially) or periodYears for a returned longer row where billingCycle is null.

If both are sent, they must refer to the same period.

The route returns 409 existing_invoice_blocking when a pending renewal order, pending domain order, or outstanding invoice blocks the change; use the pendingRenewalOrder, pendingOrder, and existingInvoice fields in the Problem Details extensions to resolve that blocker.

Domains & DNS Billing

Authentication

Required API scopes: write:domainswrite:billing

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

Context

Related endpoints

GET /api/v2/domains/{id}/billing-cycle Get domain billing cycle options GET /api/v2/domains/{id} Get domain details GET /api/v2/domains/{id}/renewal Get domain renewal state

Path Parameters

id string required Example: dom_01hxa3b4c5d6e7f8g9h0j1k2m3

Public domain ID from GET /api/v2/domains 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 · Example: biennially

Canonical period slug for 1, 2, or 3 years.

annually

biennially

triennially

periodYears integer | string · min: 1 · max: 9 · Example: 5

Domain renewal period in years. Use this only for a row returned by GET where billingCycle is null; not every TLD offers every 1-9 year period.

Responses

200 Updated billing object. 1 field

billing object

billing.amount number required · Example: 159

billing.currencyCode string required · Example: SEK

billing.billingCycle string · nullable · enum required · Example: annually

Canonical cycle slug for 1-3 year periods. Four- to nine-year domain periods return null and use periodYears.

annually

biennially

triennially

billing.periodYears integer · nullable · min: 1 · max: 9 required · Example: 1

Nullable: may be null when not applicable.

billing.initialAmount number · Example: 99

First-period amount when it differs from the recurring amount.

400 Invalid request. The response body is an RFC 7807 Problem Details document. 10 fields

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. 10 fields

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. 10 fields

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; code is domain_not_found. 10 fields

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

409 An existing order or invoice blocks the change. Inspect the Problem Details code. No body

No response body

429 Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. 10 fields

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. 10 fields

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/domains/{id}/billing-cycle

For AI assistants

View as Markdown

cURL

curl -X POST "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/billing-cycle" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "billingCycle": "biennially"
  }'

Response

{
  "billing": {
    "amount": 318,
    "currencyCode": "SEK",
    "billingCycle": "biennially",
    "periodYears": 2
  }
}

{
  "type": "object",
  "properties": {
    "billing": {
      "type": "object",
      "properties": {
        "amount": {
          "type": "number"
        },
        "currencyCode": {
          "type": "string"
        },
        "billingCycle": {
          "type": "string",
          "description": "Canonical cycle slug for 1-3 year periods. Four- to nine-year domain periods return null and use periodYears.",
          "nullable": true,
          "enum": [
            "annually",
            "biennially",
            "triennially"
          ]
        },
        "periodYears": {
          "type": "integer",
          "nullable": true,
          "minimum": 1,
          "maximum": 9
        },
        "initialAmount": {
          "type": "number",
          "description": "First-period amount when it differs from the recurring amount."
        }
      }
    }
  }
}

Request Body Change to two-year renewal

{
  "billingCycle": "biennially"
}