reseller

is added when reseller has a customer specific business

Delete

Description

Deletes an existing Managed Server Linux 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 which is to be deleted

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/managedserver/linux/us/delete.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Managed Server Order (entityid)

  • Action Type (actiontype)

  • Description of the Managed Server Order Delete Action (actiontypedesc)

  • Action ID of the Managed Server Order Delete Action (eaqid)

  • Managed Server Order Delete Action Status (actionstatus)

  • Description of the Managed Server Order Delete Action Status (actionstatusdesc)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Delete Add-on

Description

Deletes the specified Add-on of the Managed Server Linux 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 specified Add-on is to be deleted
addon-id Integer Required ID of the Add-on to be deleted. Use this method to fetch the Add-on ID.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/managedserver/linux/us/addon/delete.json?auth-userid=0&api-key=key&order-id=0&addon-id=0

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Managed Server Order (entityid)

  • Action Type (actiontype)

  • Description of the Delete Add-on Action (actiontypedesc)

  • Action ID of the Delete Add-on Action (eaqid)

  • Delete Add-on Action Status (actionstatus)

  • Description of the Delete Add-on Action Status (actionstatusdesc)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Add Add-on

Description

Adds the specified Add-on for an existing Managed Server Linux 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 specified Add-on(s) is/are to be added
addon String Required Add-ons can be one of the following:
  • ipaddress
  • whmcs
  • storage_1
  • storage_2
  • storage_3
  • storage_4
  • storage_5
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/managedserver/linux/us/addon/add.json?auth-userid=0&api-key=key&order-id=0&addon=ssl&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Managed Server Order (entityid)

  • Action Type (actiontype)

  • Description of the Add Add-on Action (actiontypedesc)

  • Action ID of the Add Add-on Action (eaqid)

  • Add Add-on Action Status (actionstatus)

  • Description of the Add Add-on Action Status (actionstatusdesc)

  • Invoice ID of the Add Add-on 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 Managed Server Order (customerid)

Note

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.

Renew

Description

Renews an existing Managed Server Linux 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 which is to be renewed
months Integer Required The number of months for which the Order is to be renewed
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/managedserver/linux/us/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Managed Server Order (entityid)

  • Action Type (actiontype)

  • Description of the Managed Server Order Renew Action (actiontypedesc)

  • Action ID of the Managed Server Order Renew Action (eaqid)

  • Managed Server Order Renew Action Status (actionstatus)

  • Description of the Managed Server Order Renew Action Status (actionstatusdesc)

  • Invoice ID of the Managed Server Order Renew 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 Managed Server Order (customerid)

Note

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.

Add

Description

Places a Managed Server 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 to be placed
customer-id Integer Required The 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.
addon Array of Strings Optional Additional Add-ons to be purchased. Values can be:
  • ipaddress
  • whmcs
  • storage_1
  • storage_2
  • storage_3
  • storage_4
  • storage_5
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/managedserver/linux/us/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Managed Server Order (entityid)

  • Action Type (actiontype)

  • Description of the Managed Server Order Add Action (actiontypedesc)

  • Action ID of the Managed Server Order Add Action (eaqid)

  • Managed Server Order Add Action Status (actionstatus)

  • Description of the Managed Server Order Add Action Status (actionstatusdesc)

  • Invoice ID of the Managed Server 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 Managed Server Order (customerid)

Note

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.

Managed Server Linux

The pricing model of the Managed Server Linux Product is based on discounts, depending on the number of months any Plan's Order is purchased
and renewed for
. This feature is referred as Telescopic Pricing.

Set Managed Server Linux Plans Selling Price (Anchor: plans)

firstfoot Interactive Pvt Ltd. allows you to set Telescopic Price ranges for all Managed Server Linux Adds and Renewals for each Plan.
This simply means that you may offer your Customers and Sub-Resellers increased discounts as and when they may choose to add / renew their Managed Server Linux Orders with you for multiple months.

Example:

Suppose that your Cost Price for Plan DS1 is USD 5 per month. Depending upon your business model, you may set your Selling Price for 6 months as USD 10 per month. Now, if a Customer
wished to add a Hosting Order under Plan DS1 for 12 months, he would be charged USD 120 (USD 10 per month). However, with the Telescopic Pricing model, you may set a reduced price of say,
USD 8 per month. In this way, your Customer is charged USD 96 instead of USD 120, thus, availing a discount for purchasing for a longer duration.

To Set your Managed Server Linux Plans Telescopic Selling Price

  1. Login to your Control Panel. See details

  2. In the Menu, point to Settings and click Manage Products and Pricing.

  3. Click the Managed Server Linux link.

  4. Click the Customers tab to set the Customer Pricing and the Sub-Resellers tab to set the Sub-Reseller Pricing.

  5. Click the Manage Price link under the Action column besides any Plan.

  6. Mention the per month Selling Price in each text box as per your requirement.

  7. You may choose to add additional slabs for the duration of the Plan, by selecting it from the drop-down at the bottom of the page and clicking Add Slab.

  8. Click the Update button to save your changes.

To Set your Managed Server Linux Add-ons Selling Price

  1. Login to your Control Panel. See details

  2. In the Menu, point to Settings and click Manage Products and Pricing.

  3. Click the Managed Server Linux link.

  4. Click the Manage Price link under the Action column in the Add-ons section.

  5. Mention the per month Selling Price for each Add-on as per your requirement.

    Note

    Selling Price set for an Add-on would be applicable across all Slabs created for all the Managed Server Linux Plans.

  6. Click the Update button to save your changes.

Note
  • Price can be any number (upto 2 decimal places). Hence, 3.00, 3, 3.19 are all valid prices.

  • If you have multiple slabs configured, you need to set reduced pricing for the higher duration slab, than the one that is immediately of a lower duration.

    Example:

    If you have a Selling Price For 3 Months slab and add a Selling Price For 12 Months slab, then the per month Selling price you need to mention for the 12 Months slab needs to be lower
    than that of the 3 Months slab.

  • A Plan Name can be customized by clicking the Edit link next to it and submitting a new Plan Name. Plan Name of existing Orders will be updated to reflect the new Plan Name.

  • The SuperSite and PartnerSite contain Pricing information about the Products and Services you offer to your Customers and Resellers respectively. This data is downloaded to your SuperSite and PartnerSite from your Control Panel and cached (stored) on the SuperSite and PartnerSite server respectively. The cache of your SuperSite and PartnerSite will be reloaded automatically, once you have completed the above process. This way, the updated details will be downloaded to your SuperSite and PartnerSite from your Control Panel.

    Additional Information

    SuperSite

    PartnerSite