Knowledge Base

Upgrade a VPS Linux KVM Plan Using the API

When you want to upgrade an existing VPS Linux KVM order using the API. This article explains required parameters, invoice handling options, SSD and HDD upgrade limitations, control panel upgrade restrictions, and response details for VPS plan upgrades.

Description

Upgrades an existing VPS Linux KVM Order.

Parameters

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Your Live Account Reseller Id
api-key	String	Required	An alphanumeric code that can be used to authenticate your API calls
order-id	Integer	Required	The Order ID which is to be upgraded.
new-plan-id	Integer	Required	The new plan to which the Order is to be upgraded.
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

US Server

https://test.httpapi.com/api/virtualserver/linux/us/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=1&invoice-option=NoInvoice

India Server

 https://test.httpapi.com/api/virtualserver/linux/in/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=1&invoice-option=NoInvoice

Response

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

Note

Plan downgrades are not supported for this product.
HDD-based plans: Plan upgrades are not supported for HDD-based plans. Such plans can be identified on the basis of the flag isSSDPlan (Value:Boolean)
For SSD plans - India servers:
- An order which includes cPanel by default can be upgraded only between the same type of plans — which have cPanel by default.
- An order which has control panels optional, can only be upgraded to the plans which have optional control panel.
For SSD plans - US servers
- An order on SSD plan can only be upgraded to SSD plans

Did you find this article helpful?