Upgrade cWatch Orders

KB Tags associated with this article:
Use any one tag
KB Tags
Body


Description

Upgrades an existing cWatch order to a new plan.

Parameters

Name Data Type Required / Optional Description
order-id Integer Required The ID of the order to upgrade (passed in the URL path)
new-plan-id Integer Required The target cWatch plan ID (passed in the URL path)
auth-userid Integer Required Reseller ID (Authentication Parameter)
api-key String Required Reseller API key (Authentication Parameter)
noOfMonths Integer Required Subscription duration in months (e.g. 12)
invoice-option String Required Invoice generation option (e.g. NoInvoice)
discount-amount Float Optional Discount amount to apply (e.g. 0)

HTTP Method

PATCH

Example Request

PATCH https://httpapi.com/restapi/product/cwatch/order/666704/plan/300637?auth-userid=0&api-key=key&noOfMonths=12&invoice-option=NoInvoice&discount-amount=0

Content-Type: application/x-www-form-urlencoded

Response

Returns the status of the upgrade, including the new plan applied to the order. Representative example:

{ "orderid": "666704", "planid": "300637", "status": "Success" }