Description
Places a VPS Linux KVM Order for the specified domain name.
Parameters
Name | Data Type | Required / Optional | Description |
---|---|---|---|
auth-userid | Integer | Required | Authentication Parameter |
api-key | String | Required | Authentication Parameter |
domain-name | String | Required | The domain name for which the Order is to be placed |
customer-id | Integer | Required | Customer ID of the Customer under whom the Order should be added |
months | Integer | Required | The number of months for which the Order is to be placed |
plan-id | Integer | Required | The plan under which the Order should be added. To fetch the plan details i.e., plan-id etc., use this method. |
os | String | Optional | The OS required for the VPS. Values can be:
Note If this parameter is not mentioned, CentOS 7 will be provisioned by default. |
addon | Array of Strings | Optional | Additional Add-ons to be purchased. Values can be:
|
auto-renew | Boolean | Required |
Enables / Disables the Auto Renewal setting for the Order Note
|
invoice-option | String | Required | This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd |
discount-amount | Float | Optional | Discount amount for the order value. |
HTTP Method
POST
Example Test URL Request
US Server https://test.httpapi.com/api/virtualserver/linux/us/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice&discount-amount=0.00
India Server https://test.httpapi.com/api/virtualserver/linux/in/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice&discount-amount=0.00
Response
Returns a hash map containing the below details:
-
Domain Name (description)
-
Order ID of the VPS Order (entityid)
-
Action Type (actiontype)
-
Description of the VPS Order Add Action (actiontypedesc)
-
Action ID of the VPS Order Add Action (eaqid)
-
VPS Linux KVM Order Add Action Status (actionstatus)
-
Description of the VPS Order Add Action Status (actionstatusdesc)
-
Invoice ID of the VPS Order Add Invoice (invoiceid)
-
Selling Currency of the Reseller (sellingcurrencysymbol)
-
Transaction Amount in the Selling Currency (sellingamount)
-
Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)
-
Customer ID associated with the VPS Order (customerid)
-
Discount Amount (discount-amount)
invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount 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.
W.E.F. 26 August 2020, you will not be able to purchase a new VPS by Bluehost (Product Key : bluehostvpslinuxus). However you can continue to renew your existing orders.