domorder

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 

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.

Description

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

Parameters

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.

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