Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - suspendreseller - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - suspendreseller
Skip to end of metadata
Go to start of metadata


This function suspends a reseller account.


This function also suspends all of the cPanel accounts that the reseller owns. 


 Command Line
whmapi1 suspendreseller user=username reason=Nonpayment


  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:


 Output (JSON)
  "metadata": {
    "version": 1,
    "reason": "OK",
    "output": {
      "raw": "Changing Shell to \/bin\/false...Changing shell for username.\n
Warning: \"\/bin\/false\" is not listed in \/etc\/shells.\nShell changed.\n
Done\nLocking Password...Locking password for user username.\n
passwd: Success\nDone\n1Suspending mysql users\n
Notification => username@exampleowner.com via EMAIL [level => 3]\n
Using Universal Quota Support (quota=0)\n
Suspended document root \/home\/username\/public_html\n
Using Universal Quota Support (quota=1024000)\n
Suspending FTP accounts...\nUpdating ftp passwords for username\n
Ftp password files updated.\nFtp vhost passwords synced\nusername's account has been suspended\n"
    "result": 1,
    "command": "suspendreseller"
 Output (XML)
                Changing Shell to /bin/false...Changing shell for username. Warning: "/bin/false" is not listed in /etc/shells. Shell changed. Done
Locking Password...Locking password for user username. passwd: Success Done
1Suspending mysql users Notification =&gt; username@exampleowner.com net via EMAIL [level =&gt; 3]
Using Universal Quota Support (quota=0) Suspended document root /home/username/public_html
Using Universal Quota Support (quota=1024000) Suspending FTP accounts...
Updating ftp passwords for username Ftp password files updated.
Ftp vhost passwords synced username's account has been suspended


Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.



ParameterTypeDescriptionPossible valuesExample


The reseller's username.

A valid reseller username on the server.username

The reason for the reseller's suspension.


We strongly recommend that you always include a reason for suspension. 

A valid string.



This function only returns metadata.