domorder

Domain Products

Purchasing / Renewing Privacy Protection

You may purchase Privacy Protection or renew Privacy Protection (if the Privacy Protection expiry date is earlier than the domain name expiry date), for an existing domain name.

Purchasing Privacy Protection

Exceptions 

Note

This feature is not available for the following TLDs (extensions):

  • Due to restrictions imposed by the Registry Operator:

    • .ARCHI


    • .ASIA


    • .AT


    • .AU


    • .BE


    • .BERLIN


    • .BHARAT


    • .BIO


    • .BLOG


    • .BR


    • .CA

      Additional Information

      Hiding/Publishing Contact Details in the Whois of a .CA Domain Name


    • .CN


    • .CO.DE


    • .COOP


    • .CYMRU


    • .DE


    • .EC


    • .ECO


    • .ES


    • .EU


    • .FR


    • .GDN


    • .GI


    • .HN


    • .IN


    • .IST


    • .IT


    • .LAT


    • .LTDA


    • .MX


    • .NGO


    • .NYC


    • .NZ


    • .PH


    • .RU


    • .SKI


    • .SRL


    • .SX


    • .TEL

      Additional Information

      Hiding/Publishing Contact Details in the Whois of a .TEL Domain Name


    • .TIROL


    • .UK

      Additional Information

      .UK Registrants who are non-trading individuals (those who do not use or plan to use their domain name for business, trade [including registration of domain names for monetization purposes] or professional transactions) can choose to opt out of having their Contact Details displayed in the Whois lookup.

      This option can be enabled by the Registrant from within his Nominet control panel.


    • .US


    • .VOTE


    • .VOTO


    • .WALES

  • Due to restrictions enforced through ICANN's contract with the Sponsor/Registry Operator:

    • .COOP

  • Due to other restrictions:

    • .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO

  1. Login to your Control Panel. See details

  2. Search for the domain name and proceed to the Order Information view. See details

  3. Click the Privacy Protection link.

  4. Click the Buy Privacy button.

  5. Proceed to Pay for the Purchase.

Renewing Privacy Protection

  1. Login to your Control Panel. See details

  2. Search for the domain name and proceed to the Order Information view. See details

  3. Click the Renew link, next to Privacy Protection.

  4. Click the Buy Privacy button.

  5. Proceed to Pay for the Purchase.

Purchasing / Renewing Privacy Protection

Description

Adds / Renews the Privacy Protection service for the specified Domain Registration Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required

Order Id of the Domain Registration Order for which the Privacy Protection service needs to be purchased / renewed.

Privacy Protection is not supported for the following TLDs (extensions):

  • .ASIA

  • .AT

  • .AU

  • .CA

  • .CN

  • .ORG.CO, .MIL.CO, .GOV.CO, .EDU.CO

  • .DE

  • .ES

  • .EU

  • .HN

  • .IN

  • .NL

  • .NZ

  • .PRO

  • .RU

  • .SX

  • .TEL

  • .UK

  • .US
invoice-option String Required This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:

  • NoInvoice: This will not raise any Invoice. The Order will be renewed.

  • PayInvoice: This will raise an Invoice and:

    • if there are sufficient funds in the Customer's Debit Account, then the Invoice will be paid and the Order will be renewed.

    • if there are insufficient funds in the Customer's Debit Account, then the Order will remain pending in the system.

  • KeepInvoice: This will raise an Invoice for the Customer to pay later. The Order will be renewed.

  • OnlyAdd: This will raise an Invoice for the Customer to pay later. The purchase/renew action request will remain pending.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/purchase-privacy.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

domainname.com

  • Domain Name (description)

  • Order ID of the Domain Name Order (entityid)

  • Action Type (actiontype)

  • Description of the Privacy Protection Purchase / Renewal Action (actiontypedesc)

  • Action ID of the Privacy Protection Purchase / Renewal Action (eaqid)

  • Privacy Protection Purchase / Renewal Action Status (actionstatus)

  • Description of the Privacy Protection Purchase / Renewal Action Status (actionstatusdesc)

  • Invoice ID of the Privacy Protection Purchase / Renewal Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilized Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the Domain Name Order (customerid)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Paid Privacy Protection Setup

You may offer Privacy Protection as a paid or a free service. If you were previously offering privacy protection as a free service and wish to continue it, no changes are required on your part except setting your Selling Price for Privacy Protection to zero. However, if you wish to start charging for it, you will have to make the below changes to support this change.

Setting your Selling Price (After launch of Paid Privacy Protection)

  1. Login to your Control Panel.

  2. In the Menu, point to Settings and click Manage Products and Pricing.

  3. Click the Domain Registration link

  4. Under the Add-On Services section, click the Manage Prices link next to Privacy Protection.

  5. Mention your Selling Price for your Customers and Sub-Resellers in the appropriate fields.

  6. Click the Update Pricing button.

SuperSite Changes

  • Updates to existing files

    • Products -> Domain -> Domain_registration -> Check_availability_new -> Domain_search_result.html

    • Products -> Domain -> Premium_domain -> Premiumdomain.html

    • Products -> Domain -> Domain_registration -> Check_availibilty -> Includes -> Idn_domain_search_blurb.html

    If you have made any modifications to these files, you need to update them to include the changes related to Paid Privacy Protection service.

  • Newly introduced files

    • Products -> Domain -> Domain_registration -> Check_availibilty -> Privacy_protect_modal.html

    • Products -> Domain -> Common -> Privacy_protect_landing_page.html

API Changes

Below changes to the API calls need to implemented:

  • Domain Registration and Domain Transfer: If you wish to purchase Privacy Protection when registering or transferring a domain name, your Registration or Transfer API call must include an additional parameter purchase-privacy with the value true. This will ensure that the service is purchased for the same term as the domain name. You can continue to use the existing parameter privacy-protect with the value true as long as your Selling Price to Customers in our system is set to zero. However, do keep in mind that your Reseller Account will be charged for the service.

    Sample Registration Call for Paid Privacy Protection (Selling Price to Customers is set to non zero in our system)

    https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=NoInvoice&purchase-privacy=true

    Sample Registration Call for Free Privacy Protection (Selling Price to Customers is set to zero in our system) [Existing API call]

    https://test.httpapi.com/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=NoInvoice&protect-privacy=true

    Sample Transfer Call for Paid Privacy Protection (Selling Price to Customers is set to non zero in our system)

    https://test.httpapi.com/api/domains/transfer.xml?auth-userid=0&api-key=key&domain-name=domain.com&auth-code=auth-code&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=NoInvoice&purchase-privacy=true

    Sample Transfer Call for Free Privacy Protection (Selling Price to Customers is set to zero in our system) [Existing API call]

    https://test.httpapi.com/api/domains/transfer.xml?auth-userid=0&api-key=key&domain-name=domain.com&auth-code=auth-code&ns=ns1.domain.com&ns=ns2.domain.com&customer-id=0&reg-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-option=NoInvoice&protect-privacy=true

  • Domain Renewal: If the Privacy Protection service is expiring before or along with the domain name, it can be extended along with the domain name itself. For this, the Renewal API call must include the additional parameter purchase-privacy with the value true.

    Sample Renewal Call for Paid Privacy Protection (Selling Price to Customers is set to non zero in our system)

    https://test.httpapi.com/api/domains/renew.xml?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036&invoice-option=NoInvoice&purchase-privacy=true

    Sample Renewal Call for Free Privacy Protection (Selling Price to Customers is set to zero in our system) [Existing API call]

    https://test.httpapi.com/api/domains/renew.xml?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036&invoice-option=NoInvoice

  • Purchasing / Renewing Privacy Protection for an existing Domain Name: Before enabling the Privacy Protection service for a domain name, it must be purchased for the domain name. This must be done using the Purchase Privacy API call, which will add and activate the service for the domain name until its expiration date. The same call can be used to renew the Privacy Protection service if it expires before the expiration of the domain name itself.

    Sample Purchase Call for Paid Privacy Protection (Selling Price to Customers is set to non zero in our system)

    https://test.httpapi.com/api/domains/purchase-privacy.xml?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

    Sample Activation Call for Free Privacy Protection (Selling Price to Customers is set to zero in our system) [Existing API call]

    https://test.httpapi.com/api/domains/modify-privacy-protection.xml?auth-userid=0&api-key=key&order-id=0&protect-privacy=true&reason=somereason

New gTLD Wishlist Setup

Following are the steps you need to perform from within your Control Panel for the New gTLD Wishlist Setup:

Sunrise TLD Setup Guide

Following are the steps you need to perform from within your Control Panel to setup your Sunrise TLD(s) for your Customers and Sub-Resellers:

  • Activate the Sunrise TLD(s) for your Reseller Account. See details

    Additional Information

    Identifying New gTLD Extensions

  • Set your Selling Price for the Sunrise TLD(s). See details

  • Buy Flow:

    • SuperSite:

      • The below files have been introduced:

        • Products -> Domain -> Domain_registration -> New_gtlds -> New_gtlds.html

        • Products -> Domain -> Domain_registration -> New_gtlds -> Sunrise.html

        • Products -> Domain -> Domain_registration -> New_gtlds -> Sunrise_result.html

      • The below file has been updated:

        • Misc -> Page_titles.txt

        If you have made any modifications to this file, you need to update it to include the changes related to Sunrise TLDs.

    • API: You need to integrate the following API calls in your website -

      • Sunrise TLDs List: Fetches the list of TLDs currently in the Sunrise Period. See details

      • Check Availability: Performs a domain availability check for the string. See details

        Note

        The string(s) that the Trademark holder can use to register domain names in the Sunrise Period can be found in the SMD file.

        Additional Information

        Signed Mark Data (SMD) File

      • Domain Registration: This will be the Domain Registration API call. See details

Fetching the List of TLDs in Sunrise / Landrush Period

Description

Fetches the list of TLDs currently in the Sunrise / Landrush Period

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
phase String Required Values can be sunrise or landrush.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/domains/tlds-in-phase.xml?auth-userid=0&api-key=key&phase=sunrise

Response

Returns a hash map containing the list of TLDs currently in the Sunrise / Landrush Period:

  • Phase

    • Category

      • TLDs

Subscribe to domorder