Plesk
Subscriptions on Plesk: the secret key, service plan and IP, customers and webspaces, every module command, sign-in, usage and troubleshooting.
The Plesk module builds hosting on a Plesk server through the Plesk XML API. Each client becomes a Plesk customer (the login is the service's username) and each service becomes a subscription (a webspace named after the domain) on a service plan. It also suspends, unsuspends, changes the plan and the password, removes the subscription, reads disk and bandwidth use, and gives a one-click sign-in to Plesk. It is a free provisioning module for hosting companies whose servers run Plesk. How services, servers and the service page work in general is in Services and servers.
Switching it on
- Setup → Addon Modules: Plesk is built in. If it is off, press Activate.
- Setup → Servers → Add: make the server (below) and press Test Connection.
- Setup → Products / Services: open the product, tab Module Settings, choose Plesk, pick the server group and fill in the product settings.
The server
| Field | What to enter for Plesk |
|---|---|
| Name, Hostname, IP Address | The hostname is used first. The IP Address is the one new subscriptions use unless the product names another. |
| Module | Plesk. Save once to load the module's own fields. |
| Username | The Plesk administrator's login. Empty means admin. |
| Password | The administrator's password. |
| Access Hash / API Token | A Plesk secret key. If it is filled it is used instead of the user name and password and is sent as the KEY header. |
| Secure and Port | Secure on. The port is empty or 8443, Plesk's port. |
The password and the key are stored encrypted. The module does not check the server's certificate. A Plesk secret key can be limited to an IP address when it is made; if you did that, use your billing server's IP address. The calls go to /enterprise/control/agent.php on the server.
Product settings
On the product's Module Settings tab:
| Setting | Meaning |
|---|---|
| Service plan | The Plesk service plan name, exactly as in Plesk (Service Plans). |
| IP address | The IP address new subscriptions use. Empty means the server's main IP address. With neither, creation stops with No IP address: set one in the product or on the server. |
What each command does
| Command | Effect on the server |
|---|---|
| Create | First creates the Plesk customer (name from the client, the username as login, the password, e-mail and country). If the customer exists already (Plesk error 1007) that is fine. Then creates the subscription named after the domain, owned by that customer, on the IP address, with FTP login and password and the service plan. The service needs a domain name and a user name. |
| Suspend / Unsuspend | Sets the subscription's status to suspended (16) or active (0). |
| Terminate | Deletes the subscription, then tries to delete the customer. If the customer still owns other subscriptions Plesk refuses, and that is ignored. |
| Change Password | Changes the customer's password and the subscription's FTP password. |
| Change Package | Switches the subscription to the product's service plan. A product with none gives The product has no Plesk service plan set. |
| Login to Control Panel | Makes a Plesk session for the customer and opens it. If that fails, the link opens the Plesk sign-in page. |
| Usage | Once a day the cron reads disk and traffic use and the limits of every subscription in one call and matches them to services by the domain name. |
Typical workflow
- A client orders and pays. With Automatic Setup on payment the module runs Create.
- The customer and subscription exist, the service turns Active and the welcome e-mail goes out.
- An unpaid renewal suspends; payment unsuspends. See Automation.
- When you end the service, Terminate removes the subscription and, when possible, the customer.
Testing
Press Test Connection on the server form. A good answer reads Connected to Plesk (server name). Then make a small test service plan, a product that uses it, order it as a test client, pay with Add Payment, and check the customer and subscription in Plesk. Try Suspend, Unsuspend, Change Password and Terminate.
Troubleshooting
Every call is written to Utilities → Module Log (module plesk); press View for the XML request and answer. A failed create, suspend or unsuspend also e-mails the administrators.
| Message | Cure |
|---|---|
| The server has no password or secret key. | Fill Password or Access Hash / API Token. |
| Plesk could not be reached: ... | Wrong host or port, a firewall that blocks 8443, or no curl. |
| Plesk: ... (code) | Plesk refused: a plan that does not exist, a domain or login that is taken, an invalid password (Plesk has its own strength rules), or an IP address that is not available. |
| Plesk gave no result. | The answer was not what the Plesk API sends; check the host and port. |
| The service has no domain name. / no user name. | Fill the fields on the service page and retry. |
More in Troubleshooting.
Was this helpful?
Updated 2026-11-03