Loading...

Knowledge Base
Home 
 
/
 Restore Domain Names Using the API
Categories: Domains API

Restore Domain Names Using the API

When you want to restore an expired domain name using the API. This article explains the required parameters, invoice options, customer billing behavior, and response details for domain restoration requests.

Restoring a domain name

Restore

Restores the specified Domain Registration Order.

Parameters

NameData TypeRequired / OptionalDescription
auth-useridIntegerRequiredAuthentication Parameter
api-keyStringRequiredAuthentication Parameter
order-idIntegerRequiredOrder Id of the Domain Registration Order that you want to restore
invoice-optionStringRequiredThis 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 restored.

  • 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 restored.

    • 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 restored.

HTTP Method

POST

Example Test URL Request

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

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Registration Order (entityid)

  • Action ID of the Domain Restoration Action (eaqid)

  • Description of the Domain Restoration Action (actiontypedesc)

  • Domain Restoration Action Status (actionstatus)

  • Description of the Domain Restoration Action Status (actionstatusdesc)

  • Invoice ID of the Domain Restoration Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Price for Customers (sellingamount)

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

Note

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

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