Add a Combo Plans Order Using the API
When you want to place a Combo Plans order using the API. This article explains bundle parameters, supported service configuration options, billing settings, and API request details for order creation.
Description
Places a Combo Plans Order for the specified domain name.
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. | ||||||||||||||||||||||||||||||||||||||||
| noOfMonths | 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 | ||||||||||||||||||||||||||||||||||||||||
| bundle-id | Integer | Required | The plan under which the Order should be added. To fetch the plan details i.e. bundle-id etc., use this method. | ||||||||||||||||||||||||||||||||||||||||
| servicesParamJson | String | Required | The parameters that are required for provisioning individual services under the Combo Plan.
Note
This should be a valid JSON, containing keys as productKey of all the services under the respective Combo Plan and values as parameters required for provisioning the particular service. | ||||||||||||||||||||||||||||||||||||||||
| discount-amount | Float | Optional | Discount amount for the order value. |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/productbundle/add.xml?auth-userid=0&api-key=api-key&domain-name=domain.com&customer-id=0&bundle-id=0&noOfMonths=12&invoice-option=KeepInvoice&discount-amount=0.00&servicesParamJson= { "domainOrder": { "ns": [ "ns1.domain.com", "ns2.domain.com" ], "reg-contact-id": "0", "admin-contact-id": "0", "tech-contact-id": "0", "billing-contact-id": "0", "attr-name1": "tnc", "attr-value1": "yes", "attr-name2": "premium", "attr-value2": "yes" }, "singledomainhostinglinuxus": {}, "sslcert": {} }
Response
Returns a map with the execution details of the Order addition.