Knowledge Base

Upgrade a SiteLock Order Using the API

When you want to upgrade an existing SiteLock order using the API. This article explains required parameters, invoice handling options, discount support, upgrade actions, and response details for SiteLock plan upgrades.

Description

Upgrades an existing SiteLock order.

Parameters

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Your Live Account Reseller Id
api-key	String	Required	An alphanumeric code that can be used to authenticate your API calls
order-id	Integer	Required	The Order ID of the Order which is to be upgraded
new-plan-id	Integer	Required	The new plan to which the Order is to be upgraded.
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/sitelock/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&invoice-option=NoInvoice&discount-amount=0.00

Response

Returns a hash map containing the below details:

Domain Name (description)
Order ID of the SiteLock Order (entityid)
Action Type (actiontype)
Description of the SiteLock Order Upgrade Action (actiontypedesc)
Action ID of the SiteLock Order Upgrade Action (eaqid)
SiteLock Order Upgrade Action Status (actionstatus)
Description of the SiteLock Order Upgrade Action Status (actionstatusdesc)
Invoice ID of the SiteLock Order Upgrade 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 SiteLock 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.

Did you find this article helpful?