Knowledge Base
Categories: Combo Plans API
Get the Details of a Combo Plan Order Using the API
When you want to retrieve the details of an existing Combo Plan order using the API. This article explains the required authentication parameters, order ID input, Combo Plan order information, included product details, plan status information, and order response details.
Description
Gets the details of an existing Combo Plans Order.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | The Order ID for which the details to be fetched |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/productbundle/details.json?auth-userid=0&api-key=key&order-id=0
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)
-
Status of the Combo Plans Plan (paused)
-
Whether Auto-Renewal is enabled (recurring)
-
Details of the Products included in the Combo Plans (Plan_Details)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Did you find this article helpful?