Skip to content

by Startups.Studio

Product Domains and access Domain

Domain.renew

POST /{namespace}/domains/{domain}/renew

Renew extends a Domain’s registration by whole years at its renewal price, paid by its owner of record.

Noun: Domain
Mode: do
Event: Domain.renewed

You, to your agent

Renew the latest domain.

curl -X POST https://api.sb/shiftnote.app/domains/domain_1/renew \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const domain = await $.Domain.renew({ domain: 'domain_1' })

npx startup-builder do Domain.renew --json '{"domain":"domain_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Domain.renew({ domain: 'domain_1' })"
  }
}

Inputs

Input	Type	Required	Description
`domain`	Domain	required	The Domain to renew.
`years`	`integer`		Years to add. Defaults to the Domain’s tier in the renewal Setting.

Outputs

Output	Type	Required	Description
`domain`	Domain	required	The Domain, with its new `expiresAt`.

Effects

Emits Domain.renewed.
Performed by the Treasurer.
One-way (money): it waits out its delay window, and runs in the send and do modes.
Runs inside the tier’s renewal window: 90 days for a canonical Domain, 60 for others.
Keeps renewing while the Startup is Dormant, because Domain renewal never stops.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Domain.renew

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (money)
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The spend Limit of the Permission or Mandate it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Domain.release

Previous Page

Domain.search

Next Page