vpslinux

Reseller should be signed up for the VPS Linux US or VPS Linux IN Product.

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
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order

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

US Server


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

India Server


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


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
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order

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

US Server


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

India Server


https://test.httpapi.com/api/vps/linux/in/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 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)

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

VPS Linux Setup Guide

As a Reseller, you need to take the following steps in order to start selling the VPS Linux Product to your Customers and Sub-Resellers:

  • Ensure that you are Selling the VPS Linux
    Product. See details

  • Select which Plans to display on your SuperSite. See details

  • If Tax is applicable to the VPS Linux Product in your Country, you may use our Tax Engine to collect it from your Customers and
    Sub-Resellers. See details

Accessing your VPS Linux Order

Virtuozzo Power Panel (VZ) VZ is the Container Management software that allows you to access and manage your VPS Linux Package. You can access the Virtuozzo Power Panel and control panels for other Add-ons that you might have purchased through your VPS Linux Order as below:

  1. Login to your Control Panel, Search for the domain name for which you have purchased this VPS Linux Order and go to the
    Order Information view. See details

  2. Click the Admin Details link.

  3. Under the Virtuozzo Power Panel (VZ) section, click the link next to Url to visit the login page. The username is listed in this interface, while the password can be obtained from the email sent to you by the system, after your VPS Linux Order was provisioned.

    You can access the control panels for other Add-ons through the Url listed under the respective Add-on section.

Additional Information

You can modify the login credentials for your control panels from their respective interfaces.