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):
|
auto-renew | Boolean | Required |
Enables / Disables the Auto Renewal setting for the domain name. Note
|
invoice-option | String | Required | This will decide how the Customer Invoice will be handled. Set any of below mentioned Invoice Options for your Customer:
|
discount-amount | Float | Optional | Discount amount for the order value. |
purchase-premium-dns | Boolean | Optional | Purchase Premium DNS Service |
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&discount-amount=0.0
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&discount-amount=0.0
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&discount-amount=0.0
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)
-
Discount Amount (discount-amount)
-
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)
-
-
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.