## GET /api/v2/domains/{id}/renewal

**Get domain renewal state**

Return renewal state for one domain: pending renewal order or invoice, current renewal billing snapshot, renewal period, auto-renew state, days until expiry, and action gates. `actions.canRenewNow` is the source of truth for whether `POST /api/v2/domains/{id}/actions/renew` should be called. If `hasPendingOrder` is true and the customer wants to cancel the renewal proposal, call `POST /api/v2/domains/{id}/actions/respond-to-renewal` with `{ "accept": false }`.

### Related Endpoints

- `POST /api/v2/domains/{id}/actions/respond-to-renewal`: Respond to pending domain renewal
- `POST /api/v2/domains/{id}/actions/renew`: Renew a domain
- `GET /api/v2/domains/{id}`: Get domain details

### Headers

- `Accept`: application/json
- `Authorization`: Bearer YOUR_API_KEY
- Required API scope: `read:domains`

### Parameters

- `id` (path, string, required): 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. Example: `dom_01hxa3b4c5d6e7f8g9h0j1k2m3`

### Request Example

```bash
curl -X GET "https://cloud.hostup.se/api/v2/domains/dom_01hxa3b4c5d6e7f8g9h0j1k2m3/renewal" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
```

### Response Schema

- `hasPendingOrder` (boolean, optional) Example: `false`
- `orderId` (string,null, optional) Example: `null`
- `orderNumber` (string,null, optional) Example: `null`
- `invoiceId` (string,null, optional) Example: `null`
- `invoiceNumber` (string,null, optional) Example: `null`
- `proformaId` (string,null, optional) Example: `null`
- `invoiceStatus` (string,null, optional) Example: `null`
- `billing` (object, optional)
- `billing.amount` (number,null, required) Example: `159`
- `billing.currencyCode` (string, required) Example: `SEK`
- `billing.billingCycle` (string, required) Example: `annually`
- `renewsFor` (object, optional)
- `renewsFor.billingCycle` (string, required) Example: `annually`
  Allowed values: annually
- `renewsFor.months` (integer, required) Example: `12`
- `createdAt` (string,null, optional) Example: `null`
- `renewalInvoice` (null, optional) Example: `null`
- `autoRenew` (boolean,null, optional) Example: `true`
- `daysUntilExpiry` (integer,null, optional) Example: `365`
- `hasUpcomingRenewal` (boolean, optional) Example: `false`
- `actions` (object, optional)
- `actions.canEnableAutoRenew` (object, optional)
- `actions.canEnableAutoRenew.allowed` (boolean, required) Example: `true`
- `actions.canEnableAutoRenew.reason` (string,null, required) Example: `null`
- `actions.canEnableAutoRenew.code` (string,null, optional): Machine-readable reason code when an action is blocked. Example: `pending_order`
- `actions.canRenewNow` (object, optional)
- `actions.canRenewNow.allowed` (boolean, required) Example: `true`
- `actions.canRenewNow.reason` (string,null, required) Example: `null`
- `actions.canRenewNow.code` (string,null, optional): Machine-readable reason code when an action is blocked. Example: `pending_order`
- `options` (array<object>, optional): Compatibility alias for integrations that still expect a renewal-options array. New clients should read `renewsFor` and `billing`. Example: `[]`

### Responses

#### 200 - Domain renewal state.
```json
{
  "hasPendingOrder": true,
  "orderId": "ord_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "orderNumber": "1500276215",
  "invoiceId": "inv_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "invoiceNumber": "202664206",
  "proformaId": "inv_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "invoiceStatus": "Paid",
  "billing": {
    "amount": 7,
    "currencyCode": "EUR",
    "billingCycle": "annually"
  },
  "renewsFor": {
    "billingCycle": "annually",
    "months": 12
  },
  "createdAt": "2026-04-27T12:00:00.000Z",
  "renewalInvoice": {
    "id": "inv_01hxa3b4c5d6e7f8g9h0j1k2m3",
    "number": "202664206",
    "amount": 7,
    "currencyCode": "EUR",
    "dueAt": "2026-05-11T23:59:59.000Z",
    "status": "paid",
    "paymentUrl": "/billing?invoice=202664206"
  },
  "autoRenew": true,
  "daysUntilExpiry": 30,
  "hasUpcomingRenewal": true,
  "actions": {
    "canEnableAutoRenew": {
      "allowed": false,
      "reason": "Auto-renew already enabled."
    },
    "canRenewNow": {
      "allowed": false,
      "reason": "Already renewed this period; next renewal available in 30 days."
    }
  }
}
```

#### 400 - Invalid request. The response body is an RFC 7807 Problem Details document.
```json
{
  "type": "https://developer.hostup.se/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request body failed validation.",
  "code": "invalid_request",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "errors": [
    {
      "pointer": "/items/0/domainName",
      "detail": "`domainName` is required.",
      "code": "invalid_request"
    }
  ]
}
```

#### 401 - Unauthorized. Authentication is required.
```json
{
  "type": "https://developer.hostup.se/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required.",
  "code": "unauthorized",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 403 - Forbidden. The caller lacks a required scope or does not own the resource.
```json
{
  "type": "https://developer.hostup.se/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The caller lacks a required scope or does not own the resource.",
  "code": "forbidden",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 404 - Not found. The resource does not exist or is not owned by the caller.
```json
{
  "type": "https://developer.hostup.se/errors/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource could not be found.",
  "code": "not_found",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 429 - Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
```json
{
  "type": "https://developer.hostup.se/errors/rate_limit_exceeded",
  "title": "Too many requests",
  "status": 429,
  "detail": "Too many requests. Retry after the limit resets.",
  "code": "rate_limit_exceeded",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 500 - Internal error. Retry later or contact support if the issue persists.
```json
{
  "type": "https://developer.hostup.se/errors/internal_error",
  "title": "Internal server error",
  "status": 500,
  "detail": "An unexpected error occurred. Retry later or contact support if the issue persists.",
  "code": "internal_error",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```