Skip to content

The service is extended at your current plan price, with the order's add-ons. If the provider fails, the charge is refunded automatically.

Only services with renewable: true can be renewed: a fully expired service or one suspended by an administrator returns 409. If the price cannot be resolved, nothing is charged and 503 is returned.

Residential and Mobile are pay as you go, so they are not renewed; on these types the request returns 400 invalid_request.

Authorization

Authorizationstringrequired

Sent as Bearer <token>. This endpoint needs the orders:write (Ordering) scope; a token without it gets 403.

Headers

Idempotency-Keystringheaderrequired

A unique value for each renewal attempt. On a timeout, retry with the SAME value; you are not charged twice, and the completed renewal is returned. After a definite failure (4xx, or 502 with details.refunded: true) the key is released and the same value starts a new attempt.

Path parameters

idstringrequired

The service ID. Take it from the id field of the GET /orders response.

Body

monthsintegerrequired

How many months to extend by (1-12).

auto_renewboolean

Turns auto-renewal on or off together with the renewal.

Response

200
application/json
dataobject
metaobject