ArgorantDocs

Turn a domain's renewal off or on

posthttps://app.argorant.com/api/v1/inboxes/orders/{order_id}/domains/{domain}/renewal
POST
/api/v1/inboxes/orders/{order_id}/domains/{domain}/renewal

true: renew. false: stop renewal.

on: false stops the renewal. The domain then works until its expiry date and is never deleted early. on: true turns the renewal back on, so it renews at its expiry, billed shortly before. Nothing is charged now either way.

CostWhat it doesKey scopes
FreeWritesargorant:manage_lists

Authorization

BearerAuth
AuthorizationBearer <token>

Your API key from app.argorant.com/profile, sent as Authorization: Bearer <key>. A connector sign-in token (ag_mcp_...) works the same way.

In: header

Path Parameters

order_id*string

The order id.

Formatuuid
domain*string

One domain of the order.

Header Parameters

Idempotency-Key?string

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

Lengthlength <= 128
X-Request-Id?string

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Match^[A-Za-z0-9._-]{8,64}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Shell
curl -X POST "https://app.argorant.com/api/v1/inboxes/orders/b345aa96-059d-47e7-b733-c1899f843a00/domains/trynorthgate.co/renewal" \  -H "Idempotency-Key: 6f1c2e7a-run-42" \  -H "Content-Type: application/json" \  -d '{    "on": false  }'
JSON
{  "domain": "trynorthgate.co",  "renewal": "off",  "auto_renew": false,  "expires_at": "2027-09-27T10:33:00+00:00",  "message": "Nothing is charged now. trynorthgate.co will not renew. It keeps working until September 27, 2027, then its mailboxes stop.",  "next_action": "Turn renewal back on"}