Support

Renew the specified Domain

View as Markdown

Renews the domain for the specified period, extending the expiration date.

Full description

Renews the domain for the specified period, extending the expiration date. Charges the account's billing method.

POST
/v1/domains/{domain}/renew

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Path Parameters

domain*string

Domain to renew

Header Parameters

X-Shopper-Id?string

Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account.

Request Body

Options for renewing existing Domain

Response Body

curl -X POST "https://example.com/v1/domains/string/renew" \  -H "Content-Type: application/json" \  -d '{}'
{  "currency": "USD",  "itemCount": 0,  "orderId": 0,  "total": 0}

Agent & Automation Notes

Scopesdomains.domain:read, domains.domain:create, domains.domain:delete, domains.domain:update, domains.contact:update, domains.dns:update, domains.transfer:execute
Rate limit60 req/min per credential
On failureGET operations are safe to retry. PUT/PATCH DNS are idempotent by shape. POST purchase is NOT idempotent — verify state before retrying.

Last updated on

How is this guide?