Cancelling a License
Overview
This document explains how to cancel a Business Email license in Manage2 for cPanel partners, or in Key Administrator (KA) Partner Central for Plesk partners. You can cancel a license in either the Manage2 or KA Partner Central interfaces, or using the Manage2 or KA API functions.
Cancellation is not the same as suspension. When you suspend a license, WebPros keeps all data and you can unsuspend the license later. When you cancel a license, WebPros deletes all data.
- Cancellation is permanent and destructive. When you cancel a Business Email license, WebPros deletes all mailboxes and email content immediately. Always confirm cancellation with your customer before proceeding.
- Cancel a Business Email license only through KA or Manage2. If you delete a license directly in WebPros Cloud, KA or Manage2 and WebPros Cloud will not be in sync.
- If a cancellation fails, do not assume the license is no longer active. Make sure that the license shows as terminated in the KA Partner Central or Manage2 interface.
Cancel a Business Email license in Manage2
To cancel a Business Email license in the Manage2 interface, perform the following steps:
- Log in to your Manage2 account with your WebPros Account credentials.
- Go to Licenses » List Licenses.
- Click Expire for that license in the list of licenses.
- Verify the license information and enter an expiration reason.
- Click Expire License to confirm the cancellation and expire the license.
Cancel a Business Email license via the Manage2 API
You can use the Manage2 Expire Licenses API function to cancel a Business Email license. To do this, log in to your Manage2 account with your WebPros Account credentials. Then, call the Expire Licenses API function with the relevant parameters.
For example, to cancel the Business Email Starter license with a licenseID value of 99010357, copy and paste the following URL into your browser:
https://manage2.cpanel.net/XMLlicenseExpire.cgi?liscid=99010357&reason='Cancel+Business+Email+Starter+license'&expcode=normal
- The Expire Licenses API function uses the
liscidparameter for thelicenseIDidentifier. - The
expcodeparameter is the reason code. Usenormalfor an ordinary cancellation. Other values flag a security risk on the customer, so only use them if they apply.
Cancel a Business Email license in KA
To cancel a Business Email license in the KA Partner Central interface, perform the following steps:
- Log in to your KA Partner Central account.
- Click Manage Licenses.
- Click All Licenses.
- Click the Business Email license number that you want to cancel.
- Click More, then select Terminate.
- Optionally, add a note, then click OK.
Cancel a Business Email license via the KA API
You can use the KA Partner API functions to cancel a Business Email license. To do this, you need your KA Partner API username and password.
To cancel a Business Email license via the KA API, send a DELETE request to the /keys function with the keyId of the license. For example, to cancel the license with a keyId value of 12527601, run the following command, where LOGIN and PASSWORD are your KA Partner API credentials:
curl -X DELETE "https://api.central.plesk.com/30/keys/12527601" --basic --user 'LOGIN:PASSWORD'
If the request succeeds, KA returns the 200 HTTP status code and terminates the license.