Renew

Description

Renews an existing Enterprise Email Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order Id which is to be renewed.
months Integer Required The number of months for which the Order is to be renewed.
no-of-accounts Integer Optional Additional Email Accounts to be purchased for the Enterprise Email Order, if required.
no-of-storage5-blocks Integer Optional Number of additional email storage addons to purchase while renewing order
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

US Server https://test.httpapi.com/api/enterpriseemail/us/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice&discount-amount=0.00

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Enterprise Email Order (entityid)

  • Action Type (actiontype)

  • Description of the Enterprise Email Order Renewal Action (actiontypedesc)

  • Action Id of the Enterprise Email Order Renewal Action (eaqid)

  • Enterprise Email Order Renewal Action Status (actionstatus)

  • Description of the Enterprise Email Order Renewal Action Status (actionstatusdesc)

  • Invoice Id of the Enterprise Email Order Renewal Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Selling Curreny Amount (sellingamount)

  • Customer Id associated with the Enterprise Email Order (customerid)

  • Discount Amount (discount-amount)

Note

invoiceid, sellingcurrencysymbol, sellingamount 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.