domorder

Domain Products

Renew

Description

Renews the specified Domain Registration Order for specified number of years.

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 that you want to Renew.
years Integer Required Number of years for which you want to Renew this Order.
exp-date Integer Required Current Expiry Date of the Order in epoch time format.
purchase-privacy Boolean optional

Renews the Privacy Protection service for the domain name.

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

auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the domain name.

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 renewal action request will remain pending.

HTTP Method

POST

Example Test URL Request


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

Example Test URL Request for Renewing a Domain Name with Privacy Protection


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

Example Test URL Request for Registry Premium domain renewal


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

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Name Order (entityid)

  • Action Type (actiontype)

  • Description of the Domain Renewal Action (actiontypedesc)

  • Action ID of the Domain Renewal Action (eaqid)

  • Domain Renewal Action Status (actionstatus)

  • Description of the Domain Renewal Action Status (actionstatusdesc)

  • Invoice ID of the Domain Renewal Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

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

  • Privacy Protection Details (privacydetails)

    • Domain Name (description)

    • Order ID of the Domain Registration Order (entityid)

    • Action Type (actiontype)

    • Description of the Privacy Protection Purchase Action (actiontypedesc)

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

    • Privacy Protection Purchase Action Status (actionstatus)

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

    • Invoice ID of the Privacy Protection Purchase 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 Registration Order (customerid)

Note
  • invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

  • Details under privacydetails will be returned only if purchase-privacy is set to true in the Domain Registration API call

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

Locating the Free Email Service Interface

The Free Email Service comprises of the following services:

  • Email Account: provides you
    Email Account(s) free with every domain purchase, alongwith POP/IMAP access. Each account comes with MB
    space.

  • Email Forwarding: This service is provided free upon purchase of any Product/Service through
    .

In order to view the Free Email Service interface, you need to search for the Product/Service you have purchased and access its Order Information interface.

To List/Search and Manage the Free Email Service

  1. Login to your Control Panel:

    For Resellers: See details

    For Customers: See details

  2. Next, click

    For Resellers: Products -> List All Orders.

    For Customers: Manage Orders -> List/Search Orders.

  3. Search for the Order for which you have activated the Free Email Service.

    Note

    For Resellers: You may search for Orders belonging to your Sub-Resellers by selecting the Include Sub-Reseller's results
    check box.

  4. On the next page, you would see a list of all your Product/Service Orders bought through . Click any domain name to reach its Overview.

  5. Click the Email tab. This will bring up the Free Email Service interface.

    Additional Information

    For Resellers: You can also use the Search Bar on the Control Panel home page to bring up the Free Email Service interface. This Search Bar will also be available on the topmost menu bar, in every page of the Reseller Control Panel.

    1. Provide the domain name in the search field.

    2. Select Order from the drop-down menu.

    3. Click the Search button.

    4. On the next page, click the Email tab.

  6. Clicking the Manage Email link will open up the Email Hosting Management interface.

Note

Upon purchase of a Single Domain Hosting / Multi Domain Hosting / Reseller Hosting Order for a domain name,

  • the Email tab / Free Email Service interface will no longer be available in the Order Details view, if the Free Email Service was not activated (by clicking the Manage Email link) before the Hosting Order was purchased.

  • However, if the Free Email Service was activated initially and then the Hosting Order was purchased, the Email tab / Free Email Service interface will continue to be displayed in the Order Details view.

    You are now required to create and manage email accounts from the Single Domain Hosting / Multi Domain Hosting / Reseller Hosting Management interface itself and not through the Free Email Service.

    You may need to download to your local computer the emails under the email accounts created through the Free Email Service before making the switch.

Server Error Format Description

Any error thrown from the Server for any call will be formatted in a special style as below.

Example 1: com.logicboxes.error.AuthenticationException#~#com.logicboxes.foundation.sfnb.Authentication#~#Invalid
Email/Password, or your User account maybe Inactive or Suspended#~#warn#~#

Example 2: com.logicboxes.error.ValidationException#~#com.logicboxes.foundation.sfnb.order.domcno.DomCnoValidation#~#{ns2=NameServer NS2.YOURDOMAINNAME.COM is not a valid Nameserver, ns1=NameServer NS1.YOURDOMAINNAME.COM is not a valid Nameserver}#~#warn#~#

The Error as you can see above has 4 distinct parts separated by #~#:

  1. The 1st part is the fully.qualified.ExceptionName - This is the name of the Exception that was thrown. Some typical examples as you can see above are
    com.logicboxes.error.AuthenticationException
    , com.logicboxes.error.ValidationException.

  2. The 2nd part is the fully.qualified.ClassThatThrewException - This is the Class on the server side in which the error occurred. For instance the above examples have com.logicboxes.foundation.sfnb.Authentication and com.logicboxes.foundation.sfnb.order.domcno.DomCnoValidation.

  3. The 3rd part is the Exception message - This part is the one which actually tells you what the error was. For instance, in the above two examples you can see the error messages are -
    Invalid Email/Password, or your User account maybe Inactive or Suspended and {ns2=NameServer NS2.YOURDOMAINNAME.COM is not a valid Nameserver, ns1=NameServer NS1.YOURDOMAINNAME.COM is not a valid Nameserver}. As you can see the message is quite self-explanatory as to what the error was.

  4. The 4th part is the ExceptionLevel - This could be debug, info, warn, error or fatal. It signifies the criticality of the error that was received, in ascending Order.

Any error received from the server will always follow the above format. Understanding this format will allow you to easily isolate most errors as well as assist in reporting them to us.

Domain Registration Setup Guide

Following are the steps you need to take within your Control Panel to setup your Domain Registration
Product for your Customers and Sub-Resellers:

  • Select which TLDs you want to
    sell. See details

  • Set your Selling Price for different TLDs that you are
    selling. See details

  • Specify your Default Settings for the Domain Names Service: You may specify which Name Servers are
    pre-filled every time your Customers register a domain
    name. See details

  • Understanding Tax and how you may use the Tax Engine to collect it from your Customers and
    Sub-Resellers. See details

  • Customize your Free Email Service (Anchor: custom):
    You may offer upto 2 Free Email accounts to your Customers.

    • Login to your Control Panel. See details

    • In the Menu, go to Settings -> Manage Products and Pricing.

    • Click Domain Registration.

    • Click the Manage link next to Email Accounts under FREE Services.

    • Select either:

      • Offer Free Email with every domain registration/ transfer: Select this option if you wish to offer
        2 free email accounts with every domain name that your Customers purchase from you.

        Note

        Each email account's space is restricted to 100MB.

      • Don't offer Free Email with domain registration/ transfer: Select this option if you do
        not wish to offer this service.

        Note

        If you disable the Free Email Service, neither your Customers nor your Sub-Resellers
        would be able to get this feature in their Control Panels.

    • Click the Save button to submit your changes.

Note

If you choose to integrate the domain name registration buy process with your website using our API Kit, then you need to
ensure that you display the Registrar Registrant Agreement for Domain Names Legal document within the
domain name registration buy process on your website.

Additional Information

HTTP API integration

It is compulsory to display this document as is to your Customers and get them to agree to the terms mentioned
therein, before buying domain names through you. You can view this agreement from within your
Reseller Control Panel by going to Help -> Legal Agreements
in the Menu.

Domain Registration

allows you flexibility in selecting the domain name extensions (TLDs) that you want to sell and setting the Selling Price for your Customers and Sub-Resellers for your Domain Registration Product. The pricing model allows setting your Selling Price for Customers to suit the needs of your business. For Sub-Resellers, pricing is determined based on the Total Receipts based Slabs.

Select the TLDs that you want to Sell (Anchor: select-tld)

  1. Log in to your Control Panel. See details

  2. In the Menu, navigate to Settings > Manage Products and Pricing.

  3. Click on the Domain Registration link and then click on the Manage TLDs link.

  4. Here, you may choose to either:

    • Sell: To sell this TLD to your Customers and Sub-Resellers.

    • No New Orders: To stop accepting new Orders for this TLD from your Customers and Sub-Resellers. However, existing Orders can continue to be Managed and Renewed.

    • Do Not Sell: To entirely stop offering this TLD to your Customers and Sub-Resellers. However, you may set this status if there are no Orders of this TLD.

  5. Upon setting your TLD Signup Preferences, agree to the applicable Terms and Conditions and click on the Submit button.

Note

You have to compulsorily continue selling at least 1 TLD and can not discontinue selling all TLDs. This implies that at least 1 TLD should be on the Active status.

You will encounter the below error message if you try to discontinue selling all TLDs:

Attention

You can not unsignup for All TLDs.

Setting Selling Prices for Domain Names

Given the  number of domain extensions that  offers, the pricing tool is designed to be flexible and powerful to address various pricing needs you may have like:

  • Setting different prices for end customers and sub-resellers

  • Bulk updating prices for a set of extensions by simply specifying your desired profit margin

  • Setting different prices/profit margins for Registrations, Renewals, Transfers and Restores

  • Giving discounts for the minimum duration, while charging nominal prices for every subsequent duration or

  • Giving price discounts for multi-year registrations/renewals (telescopic pricing)

To Set your Domain Registration Selling Price

  1. Log in to your Control Panel.  See details

  2. In the menu, navigate to Settings > Manage Products and Pricing .

  3. Click on the Domain Registration link and then click on the Manage Prices link.

  4. On the succeeding Domains Pricing Overview page, you will find a list of Top Level Domains (TLDs) that you have chosen to sell.

  5. Here, you can set the price for the TLD / TLDs in any of the following ways.
    • Search and Bulk update prices for a set of TLDs using the profit-based pricing tool

      With the bulk pricing tool, you can do a bulk search for the TLDs, specify your profit margin and the system will calculate and set your selling prices accordingly.

      1. Using the search box, enter the TLDs you wish to monitor/update. You could search for one or multiple TLDs using the search. 
      2. Click on the Set prices using Profit Margin link.
      3. Here, enter your desired profit margins. You could choose to enter values in percentage or absolute.  
      4. You can also round off your prices before or after the decimal to display more commercial values.
      5. Once done, hit the Save button.

      How does Rounding Off work?

      You can round off your calculated Selling Price(s) by specifying the last digit, before or after the decimal. Your Selling Price(s) will be rounded off to the closest number, based on your input.

      Note that profit margins might vary slightly from the specified due to rounding off.

      Attention
         

      Your Selling Price(s) will NOT be updated automatically, should your Cost Price change.

    •  Set prices individually for a TLD

      Click on the icon against the TLD you wish to manage.

      On the next page, set your selling prices as per your business requirements. You could:

      • Set different prices for each action, i.e. Registration, Renewal, Transfer and Restore.
      • Set reducing price for each year to offer multi-year discounts. This way, you can offer increased discounts as and when your Customers register / renew domain names for more than the typical one year.
      • Set discounts for the minimum duration and nominal prices for every subsequent tenure, etc.

      Certain TLDs have a one-time Application Fee for Registrations in the Sunrise Period, apart from the normal Registration charges. Set the Application Cost pricing, wherever required. This amount will appear as a separate component 'Application Fee' in the Invoice.

       

      Additional Information

      Invoices

      Note
      • Enter only Per year selling prices in each field. The system will calculate the final price for every duration for your Customers at the time of purchase.

      • Example:

      • If you wish to charge USD 20 for a 2 year registration, enter USD 10 as your 'per year' price against the 2 years field. At the time of purchase, the system will calculate 10*2, and charge your Customer USD 20 for a 2 year registration.

      • Alternatively, if you wish to give discounts for multi-year registrations, set a reduced 'per year' price in each field. Hence, if you want to offer a 2 year registration for USD 18 and not USD 20, set USD 9 as the reduced 'per year' price in the field against 2 years.

      • Your Customers will not be displayed multi-year prices on your SuperSite, if you set the same per year price for all years.

      • Example:

      • If you have set USD 10 as the 'per year' price for all the years, then your SuperSite will only display USD 10 as your Selling Price. So if your Customer chooses to register a domain name in that TLD for 3 years, he will be charged USD 10*3 = USD 30.

      • Telescopic prices cannot be set for Transfers and Restores.

      • When Specific Pricing is not set, your Customers would get the best of telescopic prices (if any) and promotional prices (if any).

      • Additional Information

      • Understanding Specific Pricing

Setting prices for Sub-Resellers with steps

To Manage your Pricing Slabs

You may set Pricing Slabs depending upon the Total Receipts of your Sub-Resellers or the number of Web Services
(Email Hosting + Windows Web Hosting + Linux Web Hosting + Website Builder) Orders purchased by your Sub-Resellers. The Selling Price to each Sub-Reseller is determined at the
time of purchase depending upon the Total Receipts, the number of Web Services (Email Hosting + Windows Web Hosting + Linux Web Hosting +
Website Builder) Orders, your Slab Pricing and the Sub-Resellers' Specific Pricing.

To Set Pricing Slabs

  1. Log in to your Control Panel. See details

  2. In the Menu, navigate to Settings > Manage Products and Pricing.

  3. Click on the Domain Registration link and then click on the Manage Prices link.

  4. On the succeeding Domains Pricing Overview page, click on the Sub-Reseller Pricing tab.

  5. Now, click on the Manage Slabs link.

  6. On the next page, add a New Slab based on Total Receipts or
    Web Services (Email Hosting + Windows Web Hosting + Linux Web Hosting + Website Builder) Orders and click on the Save Slabs button.

  7. Add as many Slabs as required, in this manner.

To Delete Pricing Slabs

  1. Log in to your Control Panel. See details

  2. In the Menu, navigate to Settings > Manage Products and Pricing.

  3. Click on the Domain Registration link and then click on the Manage Prices link.

  4. On the succeeding Domains Pricing Overview page, click on the Sub-Reseller Pricing tab.

  5. Now, click on the Manage Slabs link.

  6. On the next page, click on Delete appearing under the Action column next to the slab that you need to delete

To Set your Selling Price

  1. Log in to your Control Panel. See details

  2. In the Menu, navigate to Settings > Manage Products and Pricing.

  3. Click on the Domain Registration link and then click on the Manage Prices button.

  4. On the succeeding Domains Pricing Overview page, click on the Sub-Reseller Pricing tab.

  5. Here, you can set the price for the TLD / TLDs in any of the following ways.

    • Search and Bulk update prices for a set of TLDs using the profit-based pricing tool

      With the bulk pricing tool, you can do a bulk search for the TLDs, specify your profit margin and the system will calculate and set your selling prices accordingly for all Slabs.

      1. Using the search box, enter the TLDs you wish to monitor/update. You could search for one or multiple TLDs using the search. 
      2. Click on the Set prices using Profit Margin link.

      3. Set your profit margin for the Base Slab as well as for any Slabs that you have configured, for your Sub-Resellers.

      4. You can also round off your prices before or after the decimal to display more commercial values.

      5. Click on the Save button to save your changes.

    •  Set prices individually for a TLD

      Click on the icon against the TLD you wish to manage.

    Note
    • The Base Selling Price cannot be empty.

    • Each Slab must have a Pricing lower than or equal to the previous Slab.

    • You may enter zero (0) in any field.

      Example:

      If you set the Domain Name Renewal price for .COM domains as 0 for a particular Slab for your Sub-Resellers, then a Sub-Reseller falling under that Slab would be able to Renew .COM
      domain names for free.

    • When you set the Price to zero (0), an Invoice is still raised for the Domain Name Registration Product but its value is zero (0). This is done only from the perspective of recording the
      transaction. Your Sub-Reseller is never asked to pay for this Invoice.

    • A Slab can have the Price field empty, in which case it will be ignored.

    • You can offer Telescopic Pricing .on .UK domain names for your Sub-Resellers. You can set Telescopic Pricing within each Pricing Slab that you may have added.

    • The SuperSite and PartnerSite contain Pricing information about the Products and Services you offer to your Customers and Resellers respectively. This data is downloaded to your
      SuperSite and PartnerSite from your Control Panel and cached (stored) on the SuperSite and PartnerSite Server respectively. The cache of your SuperSite and PartnerSite will be reloaded automatically, once you have completed the above process. This way, the updated details will be downloaded to your SuperSite and PartnerSite from your Control Panel.

      Additional Information

      SuperSite

      PartnerSite

No NS A records at Nameservers Failure Message

Once you have setup the Free Email Service for your domain name, you need to modify your Name Servers to the ones specified by .
Generally, the Free Email Service should start working within a span of 24-48 hours post modification of Name Servers.

Additional Information

Name Server Modification

Do not be confused when you an encounter an error while using some DNS Tools like DNSReport.com:

Attention

No NS A records at nameservers

This does not indicate an error and will not affect the Email Service of your domain name.