is added when reseller has a customer specific business
Use this method to get details of the pricing for the Reseller Linux Hosting plans.
Returns a map with the prices of the Reseller Linux Hosting plans along with the prices of the other products.
The response structure for the Reseller Linux Hosting product will be:
"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}
Example:
Gets the applicable modify/upgrade price for a particular Reseller Linux Hosting Order.
| 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 are to be fetched. |
| new-plan-id | Integer | Required | The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details: plan-id etc., use this method. |
| months | Integer | Required | The number of months (tenure) in the new plan for which the Order to be placed. |
GET
Returns the applicable modify/upgrade price for a particular Reseller Linux Hosting Order.
Example:
{
"upgradecost":0.0,
"modifiedOrderPrice":0.0,
"endtime":"0000000000",
"remainingmonths":0,
"currentOrderPrice":0.0
}
where
currentOrderPrice: The current pricing of the Order for remaining months.
modifiedOrderPrice: New applicable pricing of the Order as per the new plan.
upgradecost: Actual price applicable i.e. modifiedOrderPrice - currentOrderPrice
Gets a list and details of the Reseller Linux Hosting Orders matching the search criteria.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| no-of-records | Integer | Required | Number of Orders to be fetched. |
| page-no | Integer | Required | Page number for which details are to be fetched. |
| order-id | Array of Integers | Optional | Order ID(s) of the Reseller Linux Hosting Order(s) whose details need to be fetched. |
| reseller-id | Array of Integers | Optional | Reseller Id(s) whose Orders need to be fetched. |
| customer-id | Array of Integers | Optional | Customer Id(s) whose Orders need to be fetched. |
| show-child-orders | Boolean | Optional | Whether Sub-Reseller Orders need to be fetched or not. |
| status | Array of Strings | Optional | Status of the Order: Active, InActive, Deleted, etc. |
| domain-name | String | Optional | Name of the Domain of the Reseller Linux Hosting Order. |
| creation-date-start | String | Optional | UNIX TimeStamp for listing of the Reseller Linux Hosting Orders whose Creation Date is greater than creation-date-start. |
| creation-date-end | String | Optional | UNIX TimeStamp for listing of the Reseller Linux Hosting Orders whose Creation Date is less than creation-date-end. |
| expiry-date-start | String | Optional | UNIX TimeStamp for listing of the Reseller Linux Hosting Orders whose expiry date is greater than expiry-date-start. |
| expiry-date-end | String | Optional | UNIX TimeStamp for listing of the Reseller Linux Hosting Orders whose expiry date is less than expiry-date-end. |
| order-by | Array of Strings | Optional | One or more parameters by which you want to sort the Orders. Default is orderid.
Example: If page-no is 1, no-of-records is 30 and order-by is orderid; it will fetch the first 30 Orders which suit the search criteria sorted by orderid. |
GET
Returns the list of the Reseller Linux Hosting Orders which match the search criteria.
Gets the associated Reseller Linux Hosting Order ID from the domain name.
| 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 ID is to be fetched. |
GET
Returns the associated Reseller Linux Hosting Order ID (Integer) of the domain name.
Use this method to get details of your plans.
Returns the details of the plans of the Reseller Linux Hosting product along with the plan details of other Products of the reseller.
Example:
The response structure for the Reseller Linux Hosting product will be:
Gets the details of an existing Reseller Linux Hosting Order.
| 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. |
GET
Returns the details of an existing Reseller Linux Hosting Order.
Deletes an existing Reseller Linux Hosting Order.
| 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 which is to be deleted. |
POST
Returns a map of the execution details of the delete operation.
Adds a dedicated IP for an existing Reseller Linux Hosting Order.
| 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 a dedicated IP to be added. |
| invoice-option | String | Required | This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd |
POST
Returns a map of the execution details of the adding dedicated IP operation.
Modifies/upgrades an existing Reseller Linux Hosting Order.
| Name | Data Type | Required / Optional | |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | The Order ID which is to be modified. |
| new-plan-id | Integer | Required | The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details i.e. plan-id etc, use this method. |
| months | Integer | Required | The number of months in the new plan for which the Order is to be modified. |
| invoice-option | String | Required | This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd |
POST
Returns a map of the execution details of the modify operation.
Renews an existing Reseller Linux Hosting Order.
| 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 which is to be renewed. |
| months | Integer | Required | The number of months for which the Order is to be renewed. |
| 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 |
POST
Returns a map of the execution details of the Renew operation.