This function displays pertient account information for a specific account.
- user
-
Username associated with the acount to display.
- accountsummary
-
Account summary information container.
- acct
-
Account container.
- disklimit (string)
-
Disk space usage limit for the account. Format: XXXM
- diskused (string)
-
Current disk space usage for the account. Format: XXXM
- domain (string)
-
Name of the root domain for the account. Format: domain.com
- email (string)
-
Contact email for the account. Format: user@domain.com
- ip (string)
-
IP address of root domain on the account. Format: xxx.xxx.xxx.xxx
- owner (string)
-
Root owner of the account. Reseller or root. Format: username
- partition (string)
-
The disk/partition the user's home directory is located on.
- plan (string)
-
Hosting package associated with the account.
- startdate (date)
-
Date and time of plan creation. Format: YY Mon (D)D HH:MM
- suspended (0=no, 1=yes)
-
Shows whether an account is suspended or not.
- suspendedreason (string)
-
Account suspension reason. This is added by the reseller/user that suspended the account.
- theme (string)
-
cPanel interface theme associated with the account.
- unix_startdate (integer)
-
Date and time of plan creation. Format: Unix Time
- user (string)
-
Username associated with the account. Format: username
- status (boolean)
-
Status of the operation. (1=Success, 0=Fail)
- statusmsg (string)
-
Relevant information about the operation.
Calling this URL in WebHost Manager:
/xml-api/accountsummary?user=ben
will produce something similar to:
<accountsummary>
<acct>
<disklimit>1000M</disklimit>
<diskused>172M</diskused>
<domain>luvcpanel.com</domain>
<email>luvcpanel@cpanel.net</email>
<ip>222.222.222.255</ip>
<owner>root</owner>
<partition>home</partition>
<plan>gold_1000MB</plan>
<startdate>04 May 8 21:12</startdate>
<suspended>1</suspended>
<suspendedreason>Account suspended due to hosting of pirated software</suspendedreason>
<theme>x3</theme>
<unix_startdate>1104173413</unix_startdate>
<user>luvcpanel</user>
</acct>
<status>1</status>
<statusmsg>Ok</statusmsg>
</accountsummary>
Copyright 2007 cPanel Inc.