Renew a domain

POST /api/v2/domains/{id}/actions/renew

Trigger a manual domain renewal.

First call GET /api/v2/domains/{id}/renewal and require actions.canRenewNow.allowed: true; if it is false, show its reason instead of calling this endpoint.

The renewal gate includes pending-order checks, registry/TLD-specific blockers, and registrar availability checks for supported registrar-managed domains.

Renewal length comes from the domain's server-side annual billing period, not from caller-supplied periodYears.

The request body must be absent or an empty object.

Successful responses include the public renewal order and invoice reference when available.

Domains & DNS Domains

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}/renewal Get domain renewal state GET /api/v2/domains/{id} Get domain details GET /api/v2/billing/invoices List invoices

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

Responses

200 Renewal order accepted. 8 fields

domainId string · Example: dom_01hxa3b4c5d6e7f8g9h0j1k2m3

renewalScheduled boolean · enum · Example: true

true

newExpiresAt string · nullable · Example: null

billing object

billing.amount number · nullable required · Example: 159

Nullable: may be null when not applicable.

billing.currencyCode string required · Example: SEK

billing.billingCycle string required · Example: annually

renewsFor object

renewsFor.billingCycle string · enum required · Example: annually

annually

renewsFor.months integer required · Example: 12

orderId string · nullable · Example: ord_01hxa3b4c5d6e7f8g9h0j1k2m3

renewalInvoice null

invoiceLookupPending boolean · Example: true

Present only when the renewal order succeeded but the invoice was still being created asynchronously.

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. 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 Conflict. See the Problem Details code for the route-specific blocker and recovery fields. 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

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}/actions/renew

For AI assistants

View as Markdown

cURL

curl -X POST "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/renew" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response

{
  "domainId": "dom_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "renewalScheduled": true,
  "newExpiresAt": null,
  "billing": {
    "amount": 159,
    "currencyCode": "SEK",
    "billingCycle": "annually"
  },
  "renewsFor": {
    "billingCycle": "annually",
    "months": 12
  },
  "orderId": "ord_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "renewalInvoice": {
    "id": "inv_01hxa3b4c5d6e7f8g9h0j1k2m3",
    "number": "202600001",
    "amount": 198.75,
    "currencyCode": "SEK",
    "dueAt": "2026-05-11T23:59:59.000Z",
    "status": "unpaid",
    "paymentUrl": "/billing?invoice=202600001"
  }
}

{
  "type": "object",
  "properties": {
    "domainId": {
      "type": "string"
    },
    "renewalScheduled": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "newExpiresAt": {
      "type": "string",
      "nullable": true
    },
    "billing": {
      "type": "object",
      "properties": {
        "amount": {
          "type": "number",
          "nullable": true
        },
        "currencyCode": {
          "type": "string"
        },
        "billingCycle": {
          "type": "string"
        }
      }
    },
    "renewsFor": {
      "type": "object",
      "properties": {
        "billingCycle": {
          "type": "string",
          "enum": [
            "annually"
          ]
        },
        "months": {
          "type": "integer"
        }
      }
    },
    "orderId": {
      "type": "string",
      "nullable": true
    },
    "renewalInvoice": {
      "type": "null"
    },
    "invoiceLookupPending": {
      "type": "boolean",
      "description": "Present only when the renewal order succeeded but the invoice was still being created asynchronously."
    }
  }
}