Respond to pending domain renewal

Read full description Hide full description

Accept or decline a pending domain-renewal proposal for one domain. Get {id} from GET /api/v2/domains data[].id. First read GET /api/v2/domains/{id} pendingRenewalOrder or GET /api/v2/domains/{id}/renewal; call this endpoint only when a pending renewal exists. To cancel the renewal, send { "accept": false } or { "decision": "decline" }; this cancels the pending renewal order and its invoice. Declining requires billing write permission in addition to domain write permission. To keep the renewal payable, send { "accept": true } or { "decision": "accept" } and then pay renewalInvoice.paymentUrl or the invoice payment endpoint.

Domains & DNS Domains

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}/renewal Get domain renewal state GET /api/v2/domains/{id} Get domain details POST /api/v2/orders/{id}/actions/cancel Cancel order

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

accept boolean · Example: false

Boolean decision. `false` declines and cancels the pending renewal order; `true` leaves the renewal invoice payable.

decision string · enum · Example: decline

String decision alternative. Prefer sending either `accept` or `decision`; if both are sent, the boolean `accept` value is used.

accept

decline

Responses

200 Renewal response result.

domainId string · Example: dom_01hxa3b4c5d6e7f8g9h0j1k2m3

Public domain ID from `GET /api/v2/domains` `data[].id`.

decision string · enum · Example: declined

`declined` means the pending renewal order was cancelled. `accepted` leaves the renewal invoice payable.

accepted

declined

newExpiresAt stringnull · Example: null

Reserved for future renewal-confirmation flows; currently null for both decisions.

renewalInvoice null · Example: null

Present when the decision leaves a payable renewal invoice. Null after declining because the pending renewal order is cancelled.

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}/actions/respond-to-renewal

For AI assistants

View as Markdown

cURL

curl -X POST "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/actions/respond-to-renewal" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "accept": false
  }'

Response

{
  "domainId": "dom_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "decision": "declined",
  "newExpiresAt": null,
  "renewalInvoice": null
}

{
  "type": "object",
  "properties": {
    "domainId": {
      "type": "string",
      "description": "Public domain ID from `GET /api/v2/domains` `data[].id`."
    },
    "decision": {
      "type": "string",
      "description": "`declined` means the pending renewal order was cancelled. `accepted` leaves the renewal invoice payable.",
      "enum": [
        "accepted",
        "declined"
      ]
    },
    "newExpiresAt": {
      "type": [
        "string",
        "null"
      ],
      "description": "Reserved for future renewal-confirmation flows; currently null for both decisions."
    },
    "renewalInvoice": {
      "type": "null",
      "description": "Present when the decision leaves a payable renewal invoice. Null after declining because the pending renewal order is cancelled."
    }
  }
}

Request Body Cancel pending renewal

{
  "accept": false
}