Title: Validate a SiteLock Plan Upgrade Using the API  
PrimaryCategory: SiteLock  
Type: Procedural  
Tags: SiteLock, API, upgrade, validation, order, plan  
Source UI Terms: auth-userid, api-key, order-id, new-planid  
Source Reference: Validate a SiteLock Plan Upgrade Using the API  

---

### Prerequisites:
- You need a valid SiteLock Order ID.
- You must have authentication credentials: auth-userid and api-key.
- You must know the new plan ID for the upgrade.

### Steps:
1) Prepare a GET request to the URL:  
   `https://test.httpapi.com/api/sitelock/validate-modify.json`
2) Include the following parameters in the query string:  
   - `auth-userid` (Integer, Required): Your authentication user ID.  
   - `api-key` (String, Required): Your API key for authentication.  
   - `order-id` (Integer, Required): The SiteLock Order ID to validate the upgrade for.  
   - `new-planid` (Integer, Required): The new plan ID to which you want to upgrade.  
3) Send the GET request to validate the upgrade.

### Response Handling:
- A successful validation returns the string `&quot;true&quot;`.  
- If there is an error, the response includes a key `&quot;status&quot;` with value `&quot;ERROR&quot;` and an accompanying error message.

### Summary:
You can verify if a SiteLock order can be upgraded by sending a GET request with required authentication and order details to the API. The API returns &quot;true&quot; if the upgrade is valid or an error message if it’s not.

### Evaluation Pairs:
Q: What parameters are required to validate a SiteLock upgrade using the API?  
A: You must provide auth-userid, api-key, order-id, and new-planid parameters.

Q: What HTTP method is used to validate a SiteLock upgrade?  
A: The GET method is used.

Q: What does the API return if the upgrade validation fails?  
A: It returns a &quot;status&quot; key with value &quot;ERROR&quot; and an error message.

<p>When you want to verify whether a SiteLock order can be upgraded to another plan using the API. This article explains required parameters, upgrade validation handling, and response details for SiteLock upgrade validation requests.</p>
<div class="region region-content">
<div class="hidden"> </div>
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<h1 class="title page-title"><span class="field field--name-title field--type-string field--label-hidden">Validate Upgrade</span></h1>
<div id="toc" style="display: block;">
<div id="toc_content">
<p> </p>
</div>
</div>
</div>
</div>
<div class="node__content clearfix">
<div class="layout layout--onecol">
<div class="layout__region layout__region--content">
<div class="clearfix text-formatted field field--name-body field--type-text-with-summary field--label-hidden field__item">
<h2><a name="heading_0"></a>Description</h2>
<p>Validates upgrade for a particular SiteLock Order.</p>
<h2><a name="heading_1"></a>Parameters</h2>
<table class="codetable"><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">auth-userid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">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">Authentication Parameter</td></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 Order ID of the SiteLock Order for which upgrade needs to be validated</td></tr><tr><td colspan="1" rowspan="1">new-planid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">The new plan to which the Order is to be upgraded. </td></tr></tbody></table>
<h2><a name="heading_2"></a>HTTP Method</h2>
<p>GET</p>
<h2><a name="heading_3"></a>Example Test URL Request</h2>
<p><code>https://test.httpapi.com/api/sitelock/validate-modify.json?auth-userid=0&amp;api-key=key&amp;order-id=0&amp;new-planid=0 </code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns <em>true</em> (String) if upgrade is validated successfully.</p>
<p>In case of any errors, a <strong>status</strong> key with value as <em>ERROR</em> alongwith an error message will be returned.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to verify whether a SiteLock order can be upgraded to another plan using the API. This article explains required parameters, upgrade validation handling, and response details for SiteLock upgrade validation requests.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
order-id	Integer	Required	The Order ID of the SiteLock Order for which upgrade needs to be validated
new-planid	Integer	Required	The new plan to which the Order is to be upgraded.