Loading...

Knowledge Base

Add a Cloud Hosting Order Using the API

When you want to place a Cloud Hosting order using the API. This article explains hosting plan parameters, billing options, and API request details for order creation.

 

Description

Places a Cloud Hosting Order for the specified domain name.

Parameters

NameData TypeRequired / OptionalDescription
auth-useridIntegerRequiredAuthentication Parameter
api-keyStringRequiredAuthentication Parameter
domain-nameStringRequiredThe domain name for which the Order is placed.
customer-idIntegerRequiredThe Customer under whom the Order should be added.
plan-idIntegerRequiredThe plan under which the Order should be added. To fetch the plan details i.e. plan-id etc., use this method.
monthsIntegerRequiredThe number of months for which the Order is placed.
invoice-optionStringRequiredThis parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd
discount-amountFloatOptionalDiscount amount for the order value.

HTTP Method

POST

Example Test URL Request

US Server

https://test.httpapi.com/api/cloudsites/linux/us/add.json?auth-userid=0&api-key=key&domain-name=domain.com&customer-id=0&plan-id=0&months=12&invoice-option=KeepInvoice&discount-amount=0.00

 

India Server

https://test.httpapi.com/api/cloudsites/linux/in/add.json?auth-userid=0&api-key=key&domain-name=domain.com&customer-id=0&plan-id=0&months=12&invoice-option=KeepInvoice&discount-amount=0.00

 

Response

Returns a map with the execution details of the Order addition.