VAIOWEB Domain Names Registration, Linux Web Hosting, Email Hosting, Reseller Hosting, VPS Hosting, Thawte Digital SSL Certificates, WebSite Builder, WebSite Templates

Upgrade

Description

Upgrades an existing SiteLock 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
new-plan-id Integer Required The new plan to which the Order is to be upgraded. To fetch the plan details i.e. plan-id etc, use this method.
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

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

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)

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.