Title: Renew WordPress Hosting Orders Using the API  
PrimaryCategory: WordPress (CMS &amp; Hosting)  
Type: Procedural  
Tags: wordpress hosting, api, renew, order, invoice, auto-renew, discount  
Source UI Terms: auth-userid, api-key, order-id, months, invoice-option, auto-renew, discount-amount  
Source Reference: Renew WordPress Hosting Orders Using the API

---

### Prerequisites:
- Authentication parameters: `auth-userid` (Integer) and `api-key` (String) are required.
- Existing WordPress Hosting order identified by `order-id`.
- Number of months to renew specified in `months`.
- Invoice handling preference set in `invoice-option`.
- Auto-renew setting enabled or disabled using `auto-renew`.
- (Optional) Discount amount can be specified via `discount-amount`.

### Steps:
1) Use the HTTP PATCH method to send the renewal request.
2) Construct the URL as follows:  
   `https://test.httpapi.com/restapi/product/wordpresshostingusa/order/{order-id}/tenure/{months}?auth-userid={auth-userid}&amp;api-key={api-key}&amp;invoice-option={invoice-option}&amp;discount-amount={discount-amount}`
3) Replace the placeholders `{order-id}`, `{months}`, `{auth-userid}`, `{api-key}`, `{invoice-option}`, and `{discount-amount}` with actual values.  
   - `invoice-option` can be one of: `NoInvoice`, `PayInvoice`, `KeepInvoice`, or `OnlyAdd`.
4) Set the `auto-renew` parameter to `true` or `false` to enable or disable auto-renewal.
5) Send the PATCH request.
6) Upon success, the API returns a map of execution details confirming the renewal.

### Warnings:
- `discount-amount` is optional; omit if no discount applies.
- Ensure that `invoice-option` is correctly chosen as it controls how customer invoices are handled.
- The `auto-renew` parameter must be explicitly set to reflect the desired auto renewal status.

### Summary:
This procedure explains how to renew a WordPress Hosting order using the API by setting the order ID, renewal duration, invoice options, auto-renew status, and optional discounts through a PATCH request, which returns execution details of the renewal.

### Evaluation Pairs:

**Q:** What HTTP method is used to renew a WordPress Hosting order via the API?  
**A:** The HTTP PATCH method is used.

**Q:** Which parameters are required to renew a WordPress Hosting order using the API?  
**A:** Required parameters are `auth-userid`, `api-key`, `order-id`, `months`, `invoice-option`, and `auto-renew`.

**Q:** How do I specify whether to enable auto-renewal for the WordPress Hosting order?  
**A:** Set the `auto-renew` parameter to `true` to enable or `false` to disable auto renewal.

<p>When you want to renew an existing WordPress Hosting order using the API. This article explains renewal parameters, invoice options, auto-renew settings, discount handling, and response details for WordPress Hosting renewals.</p>
<div class="region region-content">
<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><a href="/help/article/answer/2844#heading_0" target="_blank"></a></h1>
</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 Wordpress Hosting 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 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">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>
</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>PATCH</p>
<h2><a name="heading_3"></a>Example Test URL Request</h2>
<p><code>https://test.httpapi.com/restapi/product/wordpresshostingusa/order/{order-id}/tenure/{months}?auth-userid=0&amp;api-key=key&amp;invoice-option=KeepInvoice&amp;discount-amount=0.00</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 WordPress Hosting order using the API. This article explains renewal parameters, invoice options, auto-renew settings, discount handling, and response details for WordPress 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
auto-renew	Boolean	Required	Enables / Disables the Auto Renewal setting for the Order.
discount-amount	Float	Optional	Discount amount for the order value.