Title: Upgrade cWatch Orders via the API  
PrimaryCategory: cWatch  
Type: Procedural  
Tags: cWatch, upgrade, API, order, plan, subscription  
Source UI Terms: order-id, new-plan-id, auth-userid, api-key, noOfMonths, invoice-option, discount-amount, PATCH  
Source Reference: Upgrade cWatch Orders via the API  

Prerequisites:  
- Have the existing cWatch order ID ready.  
- Know the target cWatch plan ID for the upgrade.  
- Have reseller authentication credentials: Reseller ID (auth-userid) and API key.  
- Determine subscription duration in months.  
- Choose an invoice generation option.  

Steps:  
1) Construct a PATCH request URL using the following pattern:  
   `https://httpapi.com/restapi/product/cwatch/order/{order-id}/plan/{new-plan-id}`  

2) Append the following query parameters to the URL:  
   - `auth-userid`: Your reseller ID (required)  
   - `api-key`: Your reseller API key (required)  
   - `noOfMonths`: Subscription duration in months (required)  
   - `invoice-option`: Invoice generation option (required), e.g. `NoInvoice`  
   - `discount-amount`: Discount amount to apply (optional), e.g. `0`  

3) Set the HTTP method to PATCH.  

4) Set the request `Content-Type` header to `application/x-www-form-urlencoded`.  

5) Send the PATCH request to upgrade the existing cWatch order to the new plan.  

6) Review the JSON response for confirmation. A successful response returns the order ID, new plan ID, and status &quot;Success,&quot; for example:  
   `{ &quot;orderid&quot;: &quot;666704&quot;, &quot;planid&quot;: &quot;300637&quot;, &quot;status&quot;: &quot;Success&quot; }`  

Summary:  
You can upgrade an existing cWatch order to a new plan by sending a PATCH request to the API with your reseller credentials, order and plan IDs, subscription duration, and invoice option. The response confirms the successful upgrade.  

Evaluation Pairs:  
Q: What HTTP method should I use to upgrade a cWatch order via the API?  
A: Use the PATCH method.  

Q: Which parameters are required to upgrade a cWatch order through the API?  
A: Required parameters are order-id, new-plan-id, auth-userid, api-key, noOfMonths, and invoice-option.  

Q: How can I verify the upgrade was successful?  
A: The API returns a JSON response containing the order ID, new plan ID, and status &quot;Success.&quot;

<h1>Description</h1>
<p>Upgrades an existing cWatch order to a new plan.</p>
<h2><a name="heading_0"></a>Parameters</h2>
<table style="width: 597.971px;"><tbody><tr><th colspan="1" rowspan="1">Name</th><th colspan="1" rowspan="1">Data Type</th><th colspan="1" rowspan="1">Required / Optional</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">order-id</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">The ID of the order to upgrade (passed in the URL path)</td></tr><tr><td colspan="1" rowspan="1">new-plan-id</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">The target cWatch plan ID (passed in the URL path)</td></tr><tr><td colspan="1" rowspan="1">auth-userid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Reseller ID (Authentication Parameter)</td></tr><tr><td colspan="1" rowspan="1">api-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Reseller API key (Authentication Parameter)</td></tr><tr><td colspan="1" rowspan="1">noOfMonths</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Subscription duration in months (e.g. 12)</td></tr><tr><td colspan="1" rowspan="1">invoice-option</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Invoice generation option (e.g. NoInvoice)</td></tr><tr><td colspan="1" rowspan="1">discount-amount</td><td colspan="1" rowspan="1">Float</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">Discount amount to apply (e.g. 0)</td></tr></tbody></table>
<h2><a name="heading_1"></a>HTTP Method</h2>
<p>PATCH</p>
<h2><a name="heading_2"></a>Example Request</h2>
<pre>PATCH <a href="https://httpapi.com/restapi/product/cwatch/order/666704/plan/300637?auth-userid=0&amp;api-key=key&amp;noOfMonths=12&amp;invoice-option=NoInvoice&amp;discount-amount=0" target="_blank">https://httpapi.com/restapi/product/cwatch/order/666704/plan/300637?auth-userid=0&amp;api-key=key&amp;noOfMonths=12&amp;invoice-option=NoInvoice&amp;discount-amount=0</a></pre>
<p>Content-Type: application/x-www-form-urlencoded</p>
<h2><a name="heading_3"></a>Response</h2>
<p>Returns the status of the upgrade, including the new plan applied to the order. Representative example:</p>
<pre>{ &quot;orderid&quot;: &quot;666704&quot;, &quot;planid&quot;: &quot;300637&quot;, &quot;status&quot;: &quot;Success&quot; }</pre>

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)