Title: Renew Web Services Orders Using the API  
PrimaryCategory: API  
Type: Procedural  
Tags: renew, web services, API, order, invoice, discount, ssl, auto-renew  
Source UI Terms: auth-userid, api-key, order-id, months, enable-ssl, auto-renew, invoice-option, discount-amount  
Source Reference: Renew Web Services Orders Using the API  

### Procedural

Prerequisites:
- Valid API authentication credentials (auth-userid and api-key).
- Existing Web Services order identified by order-id.
- Determine renewal duration in months.
- Decide on auto-renew setting and invoice handling preference.
- Optionally determine any discount amount and SSL enablement.

Steps:
1) Prepare a POST request to the Web Services renew API endpoint.
2) Include these parameters in the request:
   - **auth-userid** (Integer, Required): Your API authentication user ID.
   - **api-key** (String, Required): Your API key for authentication.
   - **order-id** (Integer, Required): The existing Web Services Order ID to renew.
   - **months** (Integer, Required): Number of months for renewal.
   - **auto-renew** (Boolean, Required): Set to true or false to enable or disable auto-renewal for this order.
   - **invoice-option** (String, Required): Determines invoice handling. Choose one of: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd.
   - **enable-ssl** (Boolean, Optional): Set true to enable SSL on renewal; default is false.
   - **discount-amount** (Float, Optional): Specify any discount amount to apply to the order.
3) Submit the POST request to the URL, for example:
   ```
   https://test.httpapi.com/api/webservices/renew.json?auth-userid=0&amp;api-key=keyℴ-id=0&amp;months=0&amp;invoice-option=NoInvoice&amp;discount-amount=0.0
   ```
4) Process the response, which returns a map with execution details of the renewal operation.

Warnings:
- The **auto-renew** parameter is mandatory and controls whether the order will renew automatically in the future.
- The **enable-ssl** parameter defaults to false if omitted.
- Choose the correct **invoice-option** to avoid undesired invoice generation or payment status.

Summary:
To renew a Web Services order using the API, send a POST request including required authentication, order ID, renewal duration, auto-renew and invoice options, and optionally SSL enablement and discount amounts. The API responds with details of the renewal execution.

Evaluation Pairs:
Q: What parameters are required to renew a Web Services order using the API?  
A: Required parameters are auth-userid, api-key, order-id, months, auto-renew, and invoice-option.

Q: How do I enable SSL during a Web Services order renewal via API?  
A: Include the optional **enable-ssl** parameter set to true; if omitted, SSL is disabled by default.

Q: What does the invoice-option parameter control in the renewal API?  
A: It controls how customer invoices are handled with values like NoInvoice, PayInvoice, KeepInvoice, or OnlyAdd.

<p>When you want to renew an existing Web Services order using the API. This article explains renewal parameters, SSL enablement, auto-renew settings, invoice options, discount handling, and response details for Web Services order 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">
<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>Renews an existing Web Services Order.</p>
<h2><a name="heading_1"></a>Parameters</h2>
<p> </p>
<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 to be renewed.</td></tr><tr><td colspan="1" rowspan="1">enable-ssl</td><td colspan="1" rowspan="1">Boolean</td><td colspan="1" rowspan="1">Optional</td><td colspan="1" rowspan="1">Values can be: <em>true</em> or <em>false (default)</em>. To learn more, click here.</td></tr><tr><td colspan="1" rowspan="1">auto-renew</td><td colspan="1" rowspan="1">Boolean</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">
<p>Enables / Disables the <strong>Auto Renewal</strong> setting for the Order.</p>
<div class="note"><strong>Note</strong>
<p>Auto-Renewal</p>
</div>
</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: <em>NoInvoice</em>, <em>PayInvoice</em>, <em>KeepInvoice</em>, <em>OnlyAdd</em></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><a name="heading_2"></a>HTTP Method</h2>
<p>POST</p>
<h2><a name="heading_3"></a>Example Test URL Request</h2>
<p><code>https://test.httpapi.com/api/webservices/renew.json?auth-userid=0&amp;api-key=key&amp;order-id=0&amp;months=0&amp;invoice-option=NoInvoice &amp;discount-amount=0.0</code></p>
<h2><a name="heading_4"></a>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 Web Services order using the API. This article explains renewal parameters, SSL enablement, auto-renew settings, invoice options, discount handling, and response details for Web Services order 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 to be renewed.
enable-ssl	Boolean	Optional	Values can be: true or false (default). To learn more, click here.
auto-renew	Boolean	Required	Enables / Disables the Auto Renewal setting for the Order. Note Auto-Renewal
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.