Add Premium DNS

Description

Places a Premium DNS Order for the specified domain 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 you want to add the Premium DNS service.
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/premium-dns.json?auth-userid=0&api-key=key&invoice-option=KeepInvoice&order-id=0

Response

Returns a hash map containing the below details:   

  • Domain Name (description)

  • Order ID of the 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)