Add

Description

Places a Managed Server Linux 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 to be placed
customer-id Integer Required The Customer ID of the Customer under whom the Order should be added
months Integer Required The number of months for which the Order is to be 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.
addon Array of Strings Optional Additional Add-ons to be purchased. Values can be:
  • ipaddress
  • whmcs
  • storage_1
  • storage_2
  • storage_3
  • storage_4
  • storage_5
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/managedserver/linux/us/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Managed Server Order (entityid)

  • Action Type (actiontype)

  • Description of the Managed Server Order Add Action (actiontypedesc)

  • Action ID of the Managed Server Order Add Action (eaqid)

  • Managed Server Order Add Action Status (actionstatus)

  • Description of the Managed Server Order Add Action Status (actionstatusdesc)

  • Invoice ID of the Managed Server Order Add Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the Managed Server Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.