Description
Gets the details of an existing VPS Linux KVM 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 Order for which the details are to be fetched |
HTTP Method
GET
Example Test URL Request
Response
Returns a hash map containing the below details:
-
Order ID (entityid)
-
Order Description (description)
-
Domain Name (domainname)
-
Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended or Deleted
-
Product key (productkey)
-
Product Category (productcategory)
-
Order Creation Date (creationtime)
-
Expiry Date (endtime)
-
Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)
-
Reseller Chain by RID (parentkey)
-
Customer ID Associated with the Order (customerid)
-
Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)
-
Whether Order Suspended by Parent Reseller (orderSuspendedByParent)
-
Whether Order Deletion is Allowed (allowdeletion)
-
Cost Price for Reseller (resellercost)
-
Cost Price for Customer (customercost)
-
IP Address (ipAddress)
-
Plan ID of the VPS Plan (planid)
-
Status of the VPS Plan (paused)
-
Admin User for the VPS Order (siteadminusername)
-
Password for the above Admin USer (siteadminpassword)
-
Whether the VPS Plan includes WHMCS Addon (includes_whmcs)
-
Installed Operating System (os_name)
-
Whether Auto-Renewal is enabled (recurring)
-
Details of the Addons (addons)
-
Addon ID of the Addon (addOnID)
-
Addon Name (name)
-
Addon Creation Date (creationTime)
-
Payment Status for the Addon (is_paid)
-
IP Address (ipAddress)
-
-
Volume Details (attachedVolumes)
-
Status (storageStatus)
-
Current Status of the volume (currentStatus)
-
Product Key of Volume (productkey)
-
Expiry date of the volumeĀ (endtime)
-
Mount Point of the volume(mountPoint)
-
Order ID of the volume (orderid)
-
Volume Size (storageSizeGb)
-
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.