Skip to content

Knowledgebase

Build a renewal action list from the renewal-risk endpoint

domain-nexus, development

The renewal-risk endpoint helps a reseller prioritise upcoming domain renewals using the domain rows, prices and balances available to the service. Treat its output as a planning forecast. It is not a fixed registrar quote, a payment commitment or proof that auto-renew has completed.

01 Build the planning report

Method Resource Scope Idempotency-Key
GET /v2/domains/renewal-risk domains:read Not required by this route
  1. Choose a window_days value from 1 to 365. The default planning window is 90 days.
  2. Request the report with an appropriate page and page_size. The supported page size is 1 to 250, with a default of 25.
  3. Read the returned summary and metadata as well as the visible domain rows.
  4. Check completeness indicators, including any pricing-truncation flag. The analysis is built from up to 5,000 current domain rows, so a large portfolio needs an explicit completeness review.
  5. Prioritise owner confirmation, current expiry reconciliation, funding and final quotes for the domains that need action.

How should my dashboard display the result?

Show the report's scope and fetch time, the selected window and any incomplete-pricing indicator. Keep currencies labelled. Distinguish forecasted requirements from available funds and from renewals already submitted. This helps an operator avoid treating the same domain as both an unpaid risk and an already pending paid operation.

Can I automatically renew everything in the report?

Only through a separately authorised renewal workflow with current eligibility, pricing and idempotency. The report itself is read-only analysis. It does not establish customer consent or replace the account's renewal policy.

Why might the forecast differ from the final amount?

Prices, terms, premium status, promotions and domain lifecycle can change. A stale domain row can also have an outdated expiry. Reconcile the specific domain and use the supported quote process before placing a priced order.

For a missing domain or price, preserve the report metadata and compare the account's owned domain inventory. Do not silently treat an unknown amount as zero or assume an unlisted domain is safe to let expire.

Was this answer helpful?

Need a little more help?

Our support team can help you find the next step.

Contact support