Suspending or Unsuspending a License

Overview

This document explains how to suspend or unsuspend a Business Email license. You can suspend or unsuspend a license in either the Manage2 or Key Administrator (KA) Partner Central interfaces, or using the Manage2 or KA API functions.

In Manage2, cPanel partners enable or disable a license. You can only enable or disable a license if it is active.

In KA Partner Central or the KA API, Plesk partners suspend or resume a license.

Warning:
  • You must still pay for a suspended license. To stop billing on a license, cancel it.
  • KA does not renew a suspended license. To keep the license active, resume it before its next update date. You can find this date on the license card in the KA Partner Central interface.
  • If you do not resume a suspended license, it expires ten days after the update date. You pay for the license until it expires. About ten days after the license expires, WebPros cancels it and deletes all mailboxes and email content. You will not receive any warnings before this happens.

Suspend or unsuspend a Business Email license

When you suspend a Business Email license:

  • The server still receives and stores incoming email.
  • Mailbox users cannot log in, so they cannot read or send email.
  • WebPros does not delete any data.
  • WebPros still charges you for the suspended license.

After you unsuspend the license, mailbox users can access their email again.

Enable or disable a Business Email license in Manage2

To enable or disable a Business Email license in the Manage2 interface, perform the following steps:

  1. Log in to your Manage2 account with your WebPros Account credentials.
  2. Go to Licenses » List Licenses.
  3. Click the licenseID value for the Business Email license you want to enable or disable.
  4. Select either Enabled or Disabled for the License Status.
  5. Click Update.

Enable or disable a Business Email license via the Manage2 API

You can use the Manage2 XMLlicenseEnable.cgi API function to enable or disable a Business Email license. To do this, perform the following steps:

  1. Log in to your Manage2 account with your WebPros Account credentials.
  2. Call the XMLlicenseEnable.cgi API function with the following parameters:
    • liscid — The licenseID of the license.
    • enabled — Enter 0 to disable the license or 1 to enable it.

For example, to disable the Business Email license with a licenseID value of 99010357, copy and paste the following URL into your browser:

https://manage2.cpanel.net/XMLlicenseEnable.cgi?liscid=99010357&enabled=0

To enable the same license, copy and paste the following URL into your browser:

https://manage2.cpanel.net/XMLlicenseEnable.cgi?liscid=99010357&enabled=1
Important:

The XMLlicenseEnable.cgi API function uses the liscid parameter for the licenseID identifier.

Suspend or resume a Business Email license in KA

To suspend or resume a Business Email license in the KA Partner Central interface, perform the following steps:

  1. Log in to your KA Partner Central account.
  2. Click Manage Licenses.
  3. Click All Licenses.
  4. Click the Business Email license you want to suspend or resume.
  5. To suspend the license, click More, then select Suspend. Or, to resume the license, select Resume.
  6. Optionally, enter a note in the Note text box.
  7. Click OK.

Suspend or resume a Business Email license via the KA API

You can use the KA Partner API functions to suspend or resume a Business Email license. To do this, you need your KA Partner API username and password.

To suspend or resume a Business Email license via the KA API, send a PUT request to the /keys function with the keyId value and the suspended field. Enter true to suspend the license or false to resume it.

For example, to suspend the Business Email license with a keyId value of 12527601, run the following command, where LOGIN and PASSWORD are your KA Partner API credentials:

curl -X PUT "https://api.central.plesk.com/30/keys/12527601" \
  -H "Content-Type: application/json" --basic --user 'LOGIN:PASSWORD' \
  -d '{ "suspended": true }'

To resume the same license, run the following command, where LOGIN and PASSWORD are your KA Partner API credentials:

curl -X PUT "https://api.central.plesk.com/30/keys/12527601" \
  -H "Content-Type: application/json" --basic --user 'LOGIN:PASSWORD' \
  -d '{ "suspended": false }'
← Upgrading a License
Cancelling a License →