Title: Enable SSL for Web Hosting Orders via API
PrimaryCategory: API
Type: Procedural
Tags: ssl_enable, web_hosting, api_request, authentication, invoice_option, discount
Source UI Terms: auth-userid, api-key, order-id, invoice-option, discount-amount
Source Reference: Enable SSL for Web Hosting Orders via API

Prerequisites:
- You must have an existing Web Hosting order.
- API authentication credentials (auth-userid and api-key) are required.

Steps:
1) Prepare a POST API request to enable SSL for the desired Web Hosting order.
2) Include the following required parameters in the request:
   - `auth-userid` (Integer): Your authentication user ID.
   - `api-key` (String): Your API access key.
   - `order-id` (Integer): The Order ID for which you want to enable SSL.
   - `invoice-option` (String): Determines how customer invoices are handled. Allowed values are `NoInvoice`, `PayInvoice`, `KeepInvoice`, or `OnlyAdd`.
3) Optionally include the `discount-amount` (Float) parameter to specify a discount on the order value.
4) Send the POST request to the API endpoint:
   ```
   https://test.httpapi.com/api/webservices/enable-ssl.json?auth-userid=YOUR_AUTH_USERID&amp;api-key=YOUR_API_KEYℴ-id=YOUR_ORDER_ID&amp;invoice-option=YOUR_INVOICE_OPTION&amp;discount-amount=YOUR_DISCOUNT_AMOUNT
   ```
5) Review the API response, which returns a map detailing the execution status of the SSL enabling operation.

Warnings:
- Ensure the `invoice-option` parameter value is one of the accepted options to avoid request errors.
- The `discount-amount` is optional; omit if no discount applies.

Summary:
You can enable SSL for an existing Web Hosting order by making a POST API request with the required authentication, order details, invoice handling option, and an optional discount amount. The API returns execution details of the SSL enabling process.

Evaluation Pairs:
Q: What parameters are required to enable SSL via API for a web hosting order?
A: You must provide `auth-userid`, `api-key`, `order-id`, and `invoice-option` parameters in the POST request.

Q: What are the possible values for the `invoice-option` parameter when enabling SSL via API?
A: The allowed `invoice-option` values are `NoInvoice`, `PayInvoice`, `KeepInvoice`, and `OnlyAdd`.

Q: How do I specify a discount when enabling SSL for a web hosting order through the API?
A: Include the optional `discount-amount` parameter as a floating-point number in the API request to apply the discount.

<p>When you want to enable SSL for an existing Web Hosting order using the API. This article explains the required parameters, invoice handling options, optional discount amount configuration, and API request format for enabling SSL.</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">Enable SSL</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>Enables SSL for an existing Web Hosting Order. To learn more, </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 OrderId for which SSL needs to be enabled.</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/enable-ssl.json?auth-userid=0&amp;api-key=key&amp;order-id=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 enabling of SSL operation.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to enable SSL for an existing Web Hosting order using the API. This article explains the required parameters, invoice handling options, optional discount amount configuration, and API request format for enabling SSL.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
order-id	Integer	Required	The OrderId for which SSL needs to be enabled.
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.