Domain

Names for sale built from query (a word, or a whole name like acmebooking.com), in tlds or a common set, with close alternatives.

Register offer (a DomainOffer or a name) in the person's name: yours, or inside as_user the user's. years is the term, between the offer's min_years and max_years; left out, it's the TLD's minimum (two years for .ai), and a term the TLD doesn't offer raises noclick.InvalidRequest naming years, with the terms it does. It's charged to your account, never to the user, and refused (noclick.PriceExceeded) if it costs more than max_price_usd.

registrant is the person it's registered to, with the agreement_accepted_at that says when they accepted Domain.agreement(). A user's domain is registered to that user, so inside as_user it's required: without it, noclick.InvalidRequest names registrant and nothing is sent. A domain your account buys for itself, outside as_user, uses the account's default registrant when you pass none (Domain.set_default_registrant); with none set, it raises noclick.ActionRequired whose next_step links to the console page where it's set, and nothing is bought.

accept_claims=True says the registrant has been shown the offer's claims_notice and still wants the name. A name with a notice is refused without it (noclick.ActionRequired whose details carry claims_notice), and nothing is bought.

NoClick checks your account can pay before registering (noclick.PaymentRequired otherwise) and charges it when the registry confirms the registration; a registration that fails is never charged. When your policy holds purchases for a person to approve, it waits in awaiting_human until the approver answers; nobody answering within 24 hours (the approval's life) expires it, and nothing is charged. The price is checked against max_price_usd again when it runs.

NoClick's domain registration agreement, which every registrant accepts. Its page names the sponsoring registrar, as ICANN requires, and carries the fee schedule (registration, renewal, renewal after expiry, restore) and ICANN's registrant rights and responsibilities. Show it to the person, and record when they accept it as agreement_accepted_at on their DomainContact: a registration needs it.

The registrant your account's own domains are registered to when a purchase names none.

Set (or with None clear) the registrant your account's own domains use when a purchase names none: set it once, and Domain.buy or Domain.from_name(..., create_if_missing=True) outside as_user needs no contact in code. Until one is set, such a purchase raises noclick.ActionRequired whose next_step links to the console page that sets it. A user's domain is still registered to that user: pass their details as registrant. Like any registrant, it needs agreement_accepted_at: when the person accepted Domain.agreement() for your account.

Connect a domain the person already owns (acme.com, or a subdomain like book.acme.com). Connecting it again returns the same domain; one another account has connected raises noclick.Conflict.

On a bare domain, www is the primary address and the bare name needs your DNS host's CNAME flattening (ALIAS or ANAME) or a forward to www.

wildcard=True adds the *.<name> records to records too, so once they're set every subdomain can serve an app (Project.add_domain) or send an app's email without a record of its own: the way to give each of your users an address under yours. Each subdomain goes live once its certificate is issued, usually within minutes of its first use.

Whether name, registered elsewhere, can move to NoClick now, and what moving it costs. Nothing is charged. NoClick works it out from the domain's public registration data (its registrar lock, its transfer lock, whether NoClick registers the TLD) and the registrar's price, so it's a best answer until transfer_in is accepted. A domain already with NoClick's registrar under another account isn't eligible: reason says moving it between accounts isn't supported yet.

Move name (a name, a TransferQuote, or a domain you connected) to NoClick from its current registrar, with the auth_code that registrar gives for it. It's charged to your account like a purchase: the quote, which adds the quote's years to the registration, charged once the transfer completes; refused (noclick.PriceExceeded) above max_price_usd; held in awaiting_human while your policy holds purchases. It's registered to registrant on the same rule as Domain.buy, agreement_accepted_at included: required for a user's domain (noclick.InvalidRequest naming registrant without it, and nothing is sent), else your account's default registrant. A name the registry won't move now raises noclick.NotAvailable with the reason (transfer_quote says so first).

Its nameservers don't change during the move, so its DNS keeps working where it's hosted. Once it's active, use_noclick_dns() moves the DNS to NoClick, or it stays where it is like a connected domain. A connected domain keeps its id and what it serves, and passed as a Domain the transfer acts in that domain's own scope (its user, else your account); a name acts for the current user, or user=.

A lazy reference to your domain called name, bought or connected. With create_if_missing=True your code owns it idempotently: the first time it's used with no such domain, it's bought as Domain.buy would (max_price_usd is required and years is the TLD's minimum when left out; inside as_user the user's registrant is required too, and outside it defaults to your account's own default registrant: with none set, the first use raises noclick.ActionRequired whose next_step links to where it's set), and an existing one whose auto_renew differs is updated. A name someone else holds raises noclick.NotAvailable.

A lazy reference to a domain by id.

Load a domain by id now; an unknown id raises noclick.NotFound.

Your domains, bought and connected (the current user's inside as_user, or those user_filter covers).

One page of domains; pass next_cursor back as cursor.

Check the domain's DNS now, rather than waiting for NoClick's own checks (every few minutes while records are pending).

Change a bought domain's settings; one you leave out is unchanged.

registrant replaces the details of the person it's registered to. ICANN requires accurate details, so update them when the person's change. Changing the registrant's name, organization or email asks the new registrant to confirm their email again (the domain is registrant_unverified meanwhile) and may start the registry's transfer lock (see transfer_locked_until).

Extend a bought domain's registration now, instead of waiting for auto-renew, by years, or left out the TLD's minimum term (renewal_years, which renewal_usd prices). It's charged to your account when the renewal lands, refused (noclick.PriceExceeded) above max_price_usd, and like a purchase it may wait in awaiting_human for your policy's approver.

An expired domain renews until renewable_until. After that it raises noclick.NotAvailable: renewing past the guaranteed renewal window, or restoring a domain the registry is about to delete, isn't an API call (NoClick support may be able to restore it, at the registry's restore fee).

Move a transferred domain's DNS hosting to NoClick. The records NoClick can read where its DNS is hosted now are copied first, then its nameservers change, so it keeps answering throughout. On a domain whose DNS NoClick already hosts, it copies nothing; a connected domain raises noclick.NotAvailable (transfer it in first).

Unlock a bought or transferred domain to move it to another registrar. Inside the registry's transfer lock after a domain is registered, transferred in or its registrant changes (transfer_locked_until) it raises noclick.NotAvailable, and a connected domain has nothing to transfer.

Disconnect a connected domain: it stops serving your apps, and its DNS stays as it is where it's hosted. It raises noclick.Conflict while an inbox still uses the domain, and on a bought domain, which can only lapse or be transferred out.