Title: Renew Cloud Hosting Orders Using the API  
PrimaryCategory: Servers  
Type: Procedural  
Tags: cloud hosting, api, renewal, invoice, discount, order  
Source UI Terms: auth-userid, api-key, order-id, months, invoice-option, discount-amount  
Source Reference: Renew Cloud Hosting Orders Using the API  

---

### Prerequisites:
- You must have the existing Cloud Hosting Order ID.
- You must have valid API authentication credentials (auth-userid and api-key).

### Steps:
1) Use the POST HTTP method to send your renewal request.
2) Provide the following parameters in your API call:
   - `auth-userid` (Integer, Required): Your authentication user ID.
   - `api-key` (String, Required): Your API key for authentication.
   - `order-id` (Integer, Required): The Order ID of the Cloud Hosting order to renew.
   - `months` (Integer, Required): The number of months for which you want to renew the order.
   - `invoice-option` (String, Required): Decide how customer invoices will be handled. Allowed values:
     - `NoInvoice`
     - `PayInvoice`
     - `KeepInvoice`
     - `OnlyAdd`
   - `discount-amount` (Float, Optional): The discount amount to apply on the order value.
3) Send the request to the appropriate server endpoint:
   - US Server example:
     ```
     https://test.httpapi.com/api/cloudsites/linux/us/renew.json?auth-userid=0&amp;api-key=keyℴ-id=0&amp;months=12&amp;invoice-option=KeepInvoice&amp;discount-amount=0.00
     ```
   - India Server example:
     ```
     https://test.httpapi.com/api/cloudsites/linux/in/renew.json?auth-userid=0&amp;api-key=keyℴ-id=0&amp;months=12&amp;invoice-option=KeepInvoice&amp;discount-amount=0.00
     ```
4) Review the response which returns a map of execution details of the renew operation.

### Warnings:
- Ensure that the `invoice-option` parameter is one of the specified valid values to avoid errors.
- The discount amount is optional; invalid or negative values may result in request failure.

### Summary:
You can renew an existing Cloud Hosting order by sending a POST API request with your order details, renewal period, invoice handling method, and optional discount. The API responds with details of the renewal operation.

### Evaluation Pairs:
Q: What parameters are required to renew a Cloud Hosting order via API?  
A: You must provide `auth-userid`, `api-key`, `order-id`, `months`, and `invoice-option`. The `discount-amount` is optional.

Q: How do I specify how invoices are handled during a renewal?  
A: Use the `invoice-option` parameter with one of these values: `NoInvoice`, `PayInvoice`, `KeepInvoice`, or `OnlyAdd`.

Q: Which HTTP method is used to send a Cloud Hosting renewal API request?  
A: Use the POST HTTP method.

<p>When you want to renew an existing Cloud Hosting order using the API. This article explains renewal parameters, invoice options, discount handling, and response details for Cloud Hosting renewals.</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">Renew</span></h1>
<div id="toc" style="display: block;">
<div id="toc_content"></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>Description</h2>
<p>Renews an existing Cloud Hosting Order.</p>
<h2>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 OrderId which is to be renewed.</td></tr><tr><td colspan="1" rowspan="1">months</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">The number of months for which the Order is placed.</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">This parameter will decide how the Customer Invoices will be handled. Values can be: <i>NoInvoice</i>, <i>PayInvoice</i>, <i>KeepInvoice</i>, <i>OnlyAdd</i></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 for the order value.</td></tr></tbody></table>
<h2>HTTP Method</h2>
<p>POST</p>
<h2>Example Test URL Request</h2>
<p><strong>US Server</strong></p>
<p><code>https://test.httpapi.com/api/cloudsites/linux/us/renew.json?auth-userid=0&amp;api-key=key&amp;order-id=0&amp;months=12&amp;invoice-option=KeepInvoice&amp;discount-amount=0.00</code></p>
<p> </p>
<p><strong>India Server</strong></p>
<p><code>https://test.httpapi.com/api/cloudsites/linux/in/renew.json?auth-userid=0&amp;api-key=key&amp;order-id=0&amp;months=12&amp;invoice-option=KeepInvoice&amp;discount-amount=0.00</code></p>
<p> </p>
<h2>Response</h2>
<p>Returns a map of the execution details of the Renew operation.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to renew an existing Cloud Hosting order using the API. This article explains renewal parameters, invoice options, discount handling, and response details for Cloud Hosting renewals.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
order-id	Integer	Required	The OrderId which is to be renewed.
months	Integer	Required	The number of months for which the Order is 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.