Change domain billing period

Read full description Hide full description

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 the blocker.

Domains & DNS Billing

Authentication

Required API scopes: write:domainswrite:billing

Use Authorization: Bearer <token> for API keys. Dashboard sessions may also use hostup_session.

Context

Related endpoints

GET /api/v2/domains/{id}/billing-cycle Get domain billing-period 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

Accept Example

Content-Type Example

Body

required

application/json

billingCycle string · enum · Example: biennially

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

annually

biennially

triennially

periodYears integer | string · 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.

billing object

billing.amount number required · Example: 159

billing.currencyCode string required · Example: SEK

billing.billingCycle stringnull · 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 integernull required · Example: 1

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.

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/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",
            "null"
          ],
          "description": "Canonical cycle slug for 1-3 year periods. Four- to nine-year domain periods return null and use periodYears.",
          "enum": [
            "annually",
            "biennially",
            "triennially",
            null
          ]
        },
        "periodYears": {
          "type": [
            "integer",
            "null"
          ],
          "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"
}