reseller

is added when reseller has a customer specific business

Add Add-on

Description

Adds the specified Add-on for an existing VPS 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:
  • ssl
  • cpanel
  • plesk_10_domain
  • plesk_100_domain
  • plesk_unlimited_domain
  • whmcs
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd
Note
  • VPS 1 and VPS 2 Plans will support only ssl, plesk_10_domain and whmcs Add-ons.

  • VPS 3 Plan onwards will support all Add-ons.

  • Only 1 Plesk license (among plesk_10_domain, plesk_100_domain and plesk_unlimited_domain) can be installed on an Order.

  • cPanel & Plesk licenses can not be installed on an Order simultaneously, since these are conflicting Add-ons.

HTTP Method

POST

Example Test URL Request


Response

Returns a map of the execution details of the adding Add-on operation.

Modify/Upgrade

Description

Modifies/upgrades an existing VPS Linux Order.

Parameters

Name Data Type Required / Optional
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 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

HTTP Method

POST

Example Test URL Request


Response

Returns a map of the execution details of the modify operation.

Renew

Description

Renews an existing VPS 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 Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request


Response

Returns a map of the execution details of the Renew operation.

Add

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:
  • cpanel
  • whmcs
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)

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.

VPS Linux

The pricing model of the VPS 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 VPS Linux Plans Selling Price (Anchor: plans)

firstfoot Interactive Pvt Ltd. allows you to set Telescopic Price ranges for all VPS 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 VPS Linux Orders with you for multiple months.

Example:

Suppose that your Cost Price for Plan VPS 1 is USD 5 per month. Depending upon your business model, you may set your Selling Price for 12 months as USD 10 per month. Now, if a Customer
wished to add a Hosting Order under Plan VPS 1 for 36 months, he would be charged USD 360 (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 288 instead of USD 360, thus, availing a discount for purchasing for a longer duration.

To Set your VPS 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 VPS 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 VPS 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 VPS 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 VPS 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

Get DNS Records

Description

Gets the DNS records of a Reseller Windows Hosting 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 Reseller Windows Hosting Order

HTTP Method

GET

Example Test URL Request

US Server


https://test.httpapi.com/api/resellerhosting/windows/us/dns-record.json?auth-userid=0&api-key=key&order-id=0

Response

Returns DNS records of the domain name.

Change Hosting Panel Password

Description

Changes the hosting panel password of the specified Reseller Windows Hosting 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 Reseller Windows Hosting Order whose hosting panel password needs to be changed.
new-passwd String Required New password.

HTTP Method

POST

Example Test URL Request

US Server


https://test.httpapi.com/api/resellerhosting/windows/us/change-password.json?auth-userid=0&api-key=key&order-id=0&new-passwd=password1

Response

Returns status as success if the password is changed successfully.

Get Reseller Pricing

Description

Use this method to get details of the pricing for the Reseller Windows Hosting plans for your Sub-Resellers.

Response

Returns a map with the prices of the Reseller Windows Hosting plans along with the prices of the other products.

The response structure for the Reseller Windows Hosting product will be:


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US Server


"resellerwindowshosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}