Description
Places a VPS Linux 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 values will be centos or ubuntu. If the os parameter is not specified in the API call, centos will be used by default. |
| no-of-dedicated-ip | Integer | Optional | Number of additional dedicated IP Addresses (paid) to be added. By default, a free (non removable) dedicated IP Address will be provided with a VPS Linux Order. |
| addons | 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 |
HTTP Method
POST
Example Test URL Request
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 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)
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.