Title: Renew VPS Block Storage Orders Using the API
PrimaryCategory: API
Type: Procedural
Tags: vps_block_storage, renew, api, auto_renew, invoice_handling
Source UI Terms: auth-userid, api-key, order-id, months, auto-renew, invoice-option
Source Reference: Renew VPS Block Storage Orders Using the API

Prerequisites:
- You must have your API authentication credentials: auth-userid (integer) and api-key (string).
- You must know the order-id (integer) of the VPS Block Storage order to renew.
- You must determine the number of months (integer) for the renewal.
- You must decide the auto-renew setting (boolean) for the order.
- You must select an invoice-option (string) value to specify how customer invoices are handled. Options are: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd.

Steps:
1) Use the HTTP POST method to send a renewal request to the API endpoint.
2) Structure the POST request URL as follows for the US server:
   ```
   https://test.httpapi.com/api/blockstorage/us/renew.json
   ```
3) Include the required query parameters with appropriate values:
   - auth-userid: your integer authentication user ID.
   - api-key: your API key string.
   - order-id: the integer ID of the order to renew.
   - months: the number of months to renew the order for.
   - auto-renew: true or false to enable or disable auto renewal.
   - invoice-option: one of NoInvoice, PayInvoice, KeepInvoice, OnlyAdd to handle invoicing.
4) Submit the POST request.
5) Receive a response map containing the execution details of the renewal operation.

Warnings:
- The auto-renew parameter controls whether the order is set to renew automatically or not. Setting this incorrectly may cause unexpected renewals or lapses.
- Ensure that invoice-option is set correctly to avoid unintended invoices or payment issues.

Summary:
You can renew an existing VPS Block Storage order by sending a POST request with required parameters including order ID, renewal duration, auto-renew setting, and invoice handling options. The API returns execution details of the renewal.

Evaluation Pairs:
Q: What parameters do I need to renew a VPS Block Storage order using the API?
A: You need auth-userid, api-key, order-id, months, auto-renew (boolean), and invoice-option (NoInvoice, PayInvoice, KeepInvoice, OnlyAdd).

Q: How do I enable auto renewal for my VPS Block Storage order during renewal?
A: Set the auto-renew parameter to true when making the API call to enable auto renewal.

Q: What does the invoice-option parameter control in VPS Block Storage renewal?
A: It controls how customer invoices are managed, with options such as NoInvoice, PayInvoice, KeepInvoice, and OnlyAdd.

Q: Which HTTP method and endpoint do I use to renew the order?
A: Use the POST method targeting https://test.httpapi.com/api/blockstorage/us/renew.json with required query parameters.

<p>When you want to renew VPS Block Storage volumes using the API. This article explains renewal parameters, auto-renew settings, invoice options, and response details for VPS Block Storage renewals.</p>
<div class="region region-content">
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<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 VPS Block Storage 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">Order ID of the Order 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">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></tbody></table>
<h2><a name="heading_2"></a>HTTP Method</h2>
<p>POST</p>
<p><strong>US Server</strong> <code> https://test.httpapi.com/api/blockstorage/us/renew.json?auth-userid=0&amp;api-key=key&amp;months=1&amp;order-id=0&amp;invoice-option=NoInvoice </code></p>
<h2><a name="heading_3"></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 VPS Block Storage volumes using the API. This article explains renewal parameters, auto-renew settings, invoice options, and response details for VPS Block Storage renewals.

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