Provisioning a License

Overview #

This document explains how to provision a Business Email license in Manage2 for cPanel partners, or in Key Administrator (KA) Partner Central for Plesk partners.

You can provision a license in either the Manage2 or KA Partner Central interfaces, or using the Manage2 or KA API functions. Both Manage2 and KA create the same Business Email package in WebPros Cloud.

After you provision a license, you can upgrade, suspend or unsuspend, or cancel the license.

Provision a Business Email license #

To provision a Business Email license, you need the following customer information:

• The email address for their WebPros Dashboard account.

• Their domain name.

• The number of mailboxes that they need.

  Note:

  A Manage2 Business Email license can have a maximum of 1000 mailboxes.

• Their preferred language.

• Their preferred WebPros Cloud zone.

When you provision a Business Email license, Manage2 returns the licenseID identifier and KA returns the keyId identifier. We strongly recommend that you store this identifier, as you will need it to perform actions on the license.

Provision a Business Email license in Manage2 #

To provision 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 » Add License.
3. Select a group to which to add the license.
   Important:

   The group must have a Manage2 email address. If you select a group that does not have an address, you will need to enter one before you can add the Business Email license.

4. Select the Business Email package to add.
5. Enter the domain for the license.
6. Enter the admin email for the license.
7. Select the number of mailboxes for the license.
8. Optionally, enter a plan name that will appear in the customer interface. If you do not enter a name, the interface will display the Business Email package name as the plan name.
9. Select the geographic zone for the license.
10. Select the interface language for the license. This setting defaults to US English.
11. Optionally, enter a note about the license.
12. Click Add License.

Provision a Business Email license via the Manage2 API #

You can also use the Manage2 Add Licenses API function to provision a Business Email license. To do this, log in to your Manage2 account with your WebPros Account credentials. Then, call the Add Licenses API function with the relevant parameters.

The following Business Email plans and package IDs are available:

For example, to add a Business Email Starter license for the [email protected] WebPros Dashboard user with the domain name of example.com, five mailboxes, the interface in the Spanish language, and the Houston (USA) zone, copy and paste the following URL into your browser:

https://manage2.cpanel.net/XMLlicenseAdd.cgi?packageid=999998259&[email protected]&domain=example.com&language=es-ES&mailboxes=5&zone=us-south-tx1

Provision a Business Email license in KA #

To provision 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 Buy New License.
4. Click the empty cart icon () for WebPros Cloud Services.
5. Click the full cart icon () for the Business Email license you want to provision, then click Next.
6. Review the order, select the license agreement checkbox, then click Confirm.
7. Enter the following information for the license, then click Next:
   • The customer’s domain.
   • The WebPros Cloud zone.
   • An optional plan name.
   • The number of mailboxes.
   • The email address for the customer’s administrator.
   • The locale for the license.
   • Optional notes for the license.
8. To get the license information via email, click Get Keys by email, then click Submit. Otherwise, just click Submit.

Provision a Business Email license via the KA API #

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

To provision a Business Email license, send a POST request to the KA API /keys function. The request must contain the following data, where <tier> is STA (Starter), PRO (Professional), or ENT (Enterprise):

• The plan identifier, for example, WPC-BE-<tier>-1M.
• The mailboxes identifier, for example, WPC-BE-<tier>-MAILBOXES-1M.
• A quantity value for the number of mailboxes.
• The following provisioningPayload values:
  • zoneId — The WebPros Cloud zone.
  • locale — The interface language as an IETF BCP 47 language tag, for example, en-US.
  • domain — The domain name of the customer. The maximum length is 255 characters.
  • smbOwnerEmail — The email address of the customer’s administrator. This address receives the WebPros Dashboard welcome or signup email.
  • customPlanName — An optional plan name that will appear in the customer interface.

For example, to add a Business Email Starter license with the domain name of example.com, five mailboxes, the English language, the Houston (USA) zone, and the [email protected] administrator address, run the following command, where LOGIN and PASSWORD are your KA Partner API credentials:

curl -X POST "https://api.central.plesk.com/30/keys?return-key-state=true" \
  -H "Content-Type: application/json" --basic --user 'LOGIN:PASSWORD' \
  -d '{
    "items": [
      { "item": "WPC-BE-STA-1M" },
      { "item": "WPC-BE-STA-MAILBOXES-1M", "quantity": 5 }
    ],
    "provisioningPayload": [
      { "name": "domain", "value": "example.com" },
      { "name": "zoneId", "value": "us-south-tx1" },
      { "name": "locale", "value": "en-US" },
      { "name": "smbOwnerEmail", "value": "[email protected]" }
    ]
  }'