Loading...

Knowledge Base

Add Email Storage to a Business Email Order Using the API

When you want to add email storage to an existing Business Email order using the API. This article explains storage add-on parameters, quantity options, billing settings, and API request details for storage provisioning.

 

Description

Places an addon storage block of 5 GB for the Business Email Order for the specified domain name.

Parameters

NameData TypeRequired / OptionalDescription
auth-useridIntegerRequiredAuthentication Parameter
api-keyStringRequiredAuthentication Parameter
order-idIntegerRequiredOrder ID of the Order for which email storage addon needs to be added
addonStringRequiredType of addon (email_storage_5)
quantityIntegerRequiredThe number of email storage addons to be purchased
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/eelite/us/addon/add.json?auth-userid=0&api-key=key&order-id=0&addon=email_storage_5&quantity=5&invoice-option=NoInvoice&discount-amount=0.00

Response

Returns a hash map containing the details

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 along with an error message will be returned.