Refresh

This website manage.optidigital.ca/kb/answer/2290 is currently offline. Cloudflare's Always Online™ shows a snapshot of this web page from the Internet Archive's Wayback Machine. To check for the live version, click Refresh.

Upgrade/Downgrade

Description

Upgrades/Downgrades 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 upgraded/downgraded
new-plan-id Integer Required The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details i.e. plan-id etc, use this method.
months Integer Required The number of months in the new plan for which the Order is to be upgraded/downgraded
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

https://test.httpapi.com/api/codeguard/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-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 CodeGuard Order (entityid)

  • Action Type (actiontype)

  • Description of the CodeGuard Order Upgrade/Downgrade Action (actiontypedesc)

  • Action ID of the CodeGuard Order Upgrade/Downgrade Action (eaqid)

  • CodeGuard Order Upgrade/Downgrade Action Status (actionstatus)

  • Description of the CodeGuard Order Upgrade/Downgrade Action Status (actionstatusdesc)

  • Invoice ID of the CodeGuard Order Upgrade/Downgrade 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)

  • Discount Amount (discount-amount)

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.