Knowledge Base

Modify or Upgrade Web Services Orders Using the API

When you want to modify or upgrade a Web Services order. This article explains how to change plans, update billing duration, configure invoice handling options, and apply discounts using the API, including supported plan category limitations.

Description

Modifies/upgrades an existing Web Services Order.

Parameters

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Your Live Account Reseller Id
api-key	String	Required	Authentication Parameter
order-id	Integer	Required	The OrderId which is to be modified.
new-plan-id	Integer	Required	The new Plan to which the order is to be upgraded/downgraded. Note The new Plan category can be websitebuilder_plan or email_plan. The new Plan category can be linux_hosting_plan only if the current Plan category is linux_hosting_plan. Similarly, the new Plan category can be windows_hosting_plan only if the current Plan category is windows_hosting_plan. In all other cases, an exception will be thrown if the new Plan category is linux_hosting_plan or windows_hosting_plan.
months	Integer	Required	The number of months in the new Plan for which the Order is to be placed.
invoice-option	String	Required	This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd
discount-amount	Float	Optional	Discount amount for the order value.

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/webservices/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=PayInvoice&discount-amount=0.0

Response

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