Description
Adds / Renews the Privacy Protection service for the specified Domain Registration 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 the Privacy Protection service needs to be purchased / renewed. Privacy Protection is not supported for the following TLDs (extensions): |
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. |
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 &discount-amount=0.0
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)
-
Discount Amount (discount-amount)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.