Turn this domain's annual renewal on or off

Each Registered domain has its own separately charged renewal period, so this is per domain rather than per workspace. Turning it off means 'do not renew after the current period ends' — the domain keeps working until its expiry date, and nothing is refunded.

Authorization

ApiKey

x-api-key<token>

Workspace-owned API key with per-resource permissions.

In: header

Path Parameters

name*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

enabled*boolean

idempotencyKey?string

Length1 <= length <= 128

Response Body

`application/json`

curl -X POST "https://example.com/domains/string/renewal" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'

{  "name": "string",  "status": "in_progress",  "autoRenew": true,  "privacyMode": "redaction",  "boundProjectId": "string",  "bindStatus": "unbound",  "createdByUserId": "string",  "registeredAt": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z",  "renewal": {    "state": "renewing",    "expiresAt": "2019-08-24T14:15:22Z",    "chargeAt": "2019-08-24T14:15:22Z",    "hardDeadlineAt": "2019-08-24T14:15:22Z",    "serviceEndsAt": "2019-08-24T14:15:22Z",    "amountMicroUsd": -9007199254740991,    "retryPaymentAvailable": true,    "termYears": 1,    "autoRenew": true  }}