Knowledge Base
Categories: Website Builder API
Add a Web Services Order Using the API
When you want to place a web services order using the API. This article explains supported plan categories, billing options, and API request details for order creation.
Places a Web Services Order for the specified domain name. An Order can be either Email only or Website Builder.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| domain-name | String | Required | The domain name for which the Order is placed. |
| customer-id | Integer | Required | The Customer under whom the Order should be added. |
| months | Integer | Required | The number of months for which the Order is placed. |
| plan-id | Integer | Required | The Plan under which the Order should be added. To fetch the Plan details i.e. plan-id etc., use this method.
Note
The Plan category can be websitebuilder_plan or email_plan. An exception will be thrown if the Plan category is linux_hosting_plan or windows_hosting_plan. |
| 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. |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/webservices/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice&discount-amount=0.0
Response
Returns a map with the execution details of the Order addition.
Did you find this article helpful?