Renew

Description

Renews an existing CodeGuard 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 of the Order which is to be renewed
months Integer Required The number of months for which the Order is to be renewed
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/codeguard/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the CodeGuard Order (entityid)

  • Action Type (actiontype)

  • Description of the CodeGuard Order Renew Action (actiontypedesc)

  • Action ID of the CodeGuard Order Renew Action (eaqid)

  • CodeGuard Order Renew Action Status (actionstatus)

  • Description of the CodeGuard Order Renew Action Status (actionstatusdesc)

  • Invoice ID of the CodeGuard Order Renew 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 CodeGuard 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.