Title: Add SSL Certificate Order via API  
PrimaryCategory: SSL Certificates  
Type: Procedural  
Tags: ssl_certificate, api, order, plan_selection, billing_options, discount  
Source UI Terms: domain-name, months, customer-id, plan-id, invoice-option, discount-amount, auth-userid, api-key  
Source Reference: Add SSL Certificate Order via API  

---

Prerequisites:  
- Have a valid Customer ID under whom the order will be placed.  
- Know the Plan ID for the SSL certificate you want to order.  
- Have API authentication credentials (auth-userid and api-key).  

Steps:  
1) Use the HTTP POST method to send the SSL certificate order request.  
2) Provide the following required parameters in the API request:  
   - `domain-name`: The domain to order the SSL certificate for.  
   - `months`: Number of months for the SSL order.  
   - `customer-id`: The ID of the Customer placing the order.  
   - `plan-id`: The certificate plan ID to apply for the order.  
   - `invoice-option`: Specify invoice handling with one of these values: NoInvoice, PayInvoice, KeepInvoice, or OnlyAdd.  
3) Optionally include `discount-amount` to apply a discount on the order.  
4) Construct the API URL as follows (example):  
   ```
   https://test.httpapi.com/api/sslcert/add.json?auth-userid=0&amp;api-key=key&amp;domain-name=name&amp;months=0&amp;customer-id=0&amp;plan-id=0&amp;invoice-option=NoInvoice&amp;discount-amount=0.00
   ```  
5) Send the request and receive a response containing a hash map with order addition details.  

Warnings:  
- Ensure all required parameters are included to avoid errors.  
- Use the exact `invoice-option` values to correctly handle invoicing.  

Summary:  
You place an SSL certificate order via API by sending a POST request with domain, customer, plan, billing options, and optional discount parameters, receiving order details in response.  

Evaluation Pairs:  
Q1: What parameters are required to add an SSL certificate order via API?  
A1: Required parameters include domain-name, months, customer-id, plan-id, and invoice-option.  

Q2: How do you specify how the customer&#39;s invoice is handled when ordering an SSL certificate via API?  
A2: Use the invoice-option parameter with values like NoInvoice, PayInvoice, KeepInvoice, or OnlyAdd.  

Q3: Can you apply a discount when placing an SSL certificate order via API?  
A3: Yes, the optional discount-amount parameter allows applying a discount to the order.

<p>When you want to place an SSL certificate order using the API. This article explains SSL plan parameters, billing options, and API request details for order creation.</p>
<div class="region region-content">
<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>Places an SSL Certificate order for the specified Domain Name.</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">domain-name</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">The domain name for which the Order is to be placed</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 placed</td></tr><tr><td colspan="1" rowspan="1">customer-id</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">The Customer under whom the Order should be added</td></tr><tr><td colspan="1" rowspan="1">plan-id</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">The plan under which the Order should be added.</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&#39;s Invoice will be handled. Values can be: <em>NoInvoice</em>, <em>PayInvoice</em>, <em>KeepInvoice</em> or <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>HTTP Method</h2>
<p>POST</p>
<h2>Example Test URL Request</h2>
<p><code>https://test.httpapi.com/api/sslcert/add.json?auth-userid=0&amp;api-key=key&amp;domain-name=name&amp;months=0&amp;customer-id=0&amp;plan-id=0&amp;invoice-option=NoInvoice&amp;discount-amount=0.00 </code></p>
<h2>Response</h2>
<p>Returns a hash map containing the order addition information.</p>
</div>
</div>
</div>
</div>
<div class="mychild-topics"> </div>
</div>
<div class="seedetailssection"> </div>

When you want to place an SSL certificate order using the API. This article explains SSL plan parameters, billing options, and API request details for order creation.

Name	Data Type	Required / Optional	Description
domain-name	String	Required	The domain name for which the Order is to be placed
months	Integer	Required	The number of months for which the Order is to be placed
customer-id	Integer	Required	The Customer under whom the Order should be added
plan-id	Integer	Required	The plan under which the Order should be added.
invoice-option	String	Required	This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.
discount-amount	Float	Optional	Discount amount for the order value.

Add an SSL Certificate Order Using the API

Description

Parameters

HTTP Method

Example Test URL Request

Response