accountsummary — Reseller API
Read an account summary through the Reseller API, with request fields, response details, errors and cURL/Python/PHP examples.
/api/v1/accountsummary/Also accepts GETReads the stored hosting-account record for one existing user, adding is_suspended and is_reseller as yes/no strings. Resellers also include reseller_data and reseller usage fields. quota_usage and bandwidth_usage are current-month recorded MB values, not a live filesystem scan. The exact stored account fields depend on the server and account configuration. The response is sensitive administrator data; retain only the fields your integration needs.
Request
The selected account must be in the authenticated reseller accounts list and have a hosting-user file. Other resellers’ accounts are rejected with HTTP 400 and JSON status 400; this is an ownership check, not an authentication failure.
| Property | Value |
|---|---|
| Methods | GET, POST |
| Versioned path | /api/v1/accountsummary/ |
| Default path | /api/accountsummary/ |
| Authentication | Reseller API credentials. |
| Header | Required value |
|---|---|
X-RESELLER | The reseller account owning these API credentials. |
X-API-USER | Your Reseller API username. |
X-API-PASSWORD | Its API password. |
Parameters
| Field | Required | Type and behavior |
|---|---|---|
user | Yes | String. Existing hosting username; required account state is described above. |
POST reads the JSON/form body; GET reads query parameters. The examples use form-encoded POST. Authentication remains in the two headers. Undeclared fields are not additional API options.
Replace server.example.com, examplereseller, billing_api and YOUR_API_PASSWORD in each standalone example. Replace operation sample values with your actual target and an existing package where required. Python needs Requests; PHP needs the cURL extension. These examples make real calls when run.
Success response
HTTP 200. Illustrative values; account records and server values vary. Stored account examples show only selected fields.
{
"data": {
"acct": {
"user": "exampleuser",
"domain": "example.com",
"is_suspended": "no",
"is_reseller": "no",
"quota_usage": 128,
"bandwidth_usage": 512
}
},
"info": "Hosting account summary of user exampleuser",
"status": 200
}| Field | Type | Meaning |
|---|---|---|
status | integer | 200 on the documented success branch. |
info | string | Operation description. |
data | object | Operation data described below. |
data.acct | object | Stored account object with flags and recorded usage; optional reseller fields appear for reseller accounts. |
Account record contents are not a fixed public schema. Fields such as user/domain and nested limits depend on account configuration; reseller_data appears only where the handler adds it. Do not expose entire administrator responses to an end-user browser.
is_suspended and is_reseller are strings (yes/no), not booleans. quota_usage and bandwidth_usage are recorded current-month MB values; reseller records also contain quota_usage_reseller and bandwidth_usage_reseller.
Errors and demo mode
| Condition | Actual HTTP status | Response behavior |
|---|---|---|
| Missing credentials with no other authenticated identity | 403 | detail: Authentication credentials were not provided. |
| Rejected password or source IP | 403 | detail: Invalid API credentials |
| Demo server | 400 | error: Demo server; info: Api Operations not available in demo server; JSON status: 403. |
| Invalid/missing operation fields or invalid target state | 400 | Field errors in error; JSON status: 400. |
| Backend reports failure | 400 | Operation error in error; JSON status: 500. |
| Unsupported method | 405 after authentication | Method-not-allowed response. |
Validation failure description: Unable to read hosting account summary. The data is invalid.
Check both the HTTP status and JSON shape. Authentication failures do not use the operation envelope. Unexpected uncaught server errors are not guaranteed to return the documented JSON shape. Do not automatically retry account creation, password changes, deletions or SSO generation after a timeout: confirm the actual state first.
See Reseller API authentication and connection troubleshooting.