---
title: "Return current user's available hosting plans"
method: GET
path: "/listpkgs"
tags: ["Packages", "Hosting Plans"]
---

# Return current user's available hosting plans

`GET /listpkgs`

This function lists the authenticated user's available hosting plans (packages).

**Important:**

This function **only** returns packages that the authenticated user can access and
use during account creation.

## Query parameters

- `want` 'all' | 'creatable' | 'editable' | 'viewable'

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `pkg` object[] — An array of objects that contains hosting plans and their settings.
      - `BWLIMIT` union — The hosting plan's bandwidth limit, in megabytes (MB). * `unlimited` — The hosting plan allows unlimited bandwidth.
        - integer
        - 'unlimited' — The hosting plan allows unlimited bandwidth.
      - `CGI` 'y' | 'n' — Whether CGI is enabled for the hosting plan. * `y` — Enabled. * `n` — Disabled.
      - `CPMOD` string — The hosing plan's cPanel interface theme.
      - `DIGESTAUTH` 'y' | 'n' — Whether the hosting plan enables Digest Authentication. * `y` — Enabled. * `n` — Disabled.
      - `FEATURELIST` string — The hosting plan's [feature list](https://go.cpanel.net/whmdocsFeatureManager).
      - `HASSHELL` 'y' | 'n' — Whether shell access is enabled for the hosting plan. * `y` — Enabled. * `n` — Disabled.
      - `IP` 'y' | 'n' — Whether the hosting plan grants accounts a dedicated IP address. * `y` — Dedicated IP address. * `n` — Shared IP address.
      - `LANG` string, ISO-3166-1 (alpha-2) — The hosting plan's locale.
      - `MAXADDON` union — The hosting plan's maximum number of addon domains. * `unlimited` — The hosting plan allows unlimited addon domains.
        - integer
        - 'unlimited' — The hosting plan allows unlimited addon domains.
      - `MAXFTP` union — The hosting plan's maximum number of FTP accounts. * `unlimited` — The hosting plan allows unlimited FTP accounts.
        - integer
        - 'unlimited' — The hosting plan allows unlimited FTP accounts.
      - `MAXLST` union — The hosting plan's maximum number of mailing lists. * `unlimited` — The hosting plan allows an unlimited number of mailing lists.
        - integer
        - 'unlimited' — The hosting plan allows an unlimited number of mailing lists.
      - `MAXPARK` union — The hosting plan's maximum number of parked domains (aliases). * `unlimited` — The hosting plan allows unlimited parked domains.
        - integer
        - 'unlimited' — The hosting plan allows unlimited parked domains.
      - `MAXPOP` union — The hosting plan's maximum number of email accounts. * `unlimited` — The hosting plan allows unlimited email accounts.
        - integer
        - 'unlimited' — The hosting plan allows unlimited email accounts.
      - `MAXSQL` union — The hosting plan's maximum number of each available type of SQL database. For example, if this value is `5`, and the system administrator allows MySQL® and PostgreSQL® databases, users can create up to five MySQL databases and up to five PostgreSQL databases. * `unlimited` — The hosting plan allows unlimited SQL databases.
        - integer
        - 'unlimited' — The hosting plan allows unlimited SQL databases.
      - `MAXSUB` union — The hosting plan's maximum number of subdomains. * `unlimited` — The hosting plan allows unlimited subdomains.
        - integer
        - 'unlimited' — The hosting plan allows unlimited subdomains.
      - `MAX_DEFER_FAIL_PERCENTAGE` union — The [percentage of failed or deferred email messages](https://go.cpanel.net/howtopreventspam) that the hosting plan can send per hour before the system rate-limits outgoing mail. * `unlimited` — The hosting plan allows unlimited email messages.
        - integer
        - 'unlimited' — The hosting plan allows unlimited email messages.
      - `MAX_EMAILACCT_QUOTA` union — The hosting plan's maximum email account quota size, in megabytes (MB). * `unlimited` — The hosting plan allows an unlimited email account quota size.
        - integer
        - 'unlimited' — The hosting plan allows an unlimited email account quota size.
      - `MAX_EMAIL_PER_HOUR` union — The [maximum number of emails](https://go.cpanel.net/howtopreventspam) that the hosting plan can send in one hour. * `unlimited` — The hosting plan allows unlimited emails per hour.
        - integer
        - 'unlimited' — The hosting plan allows unlimited emails per hour.
      - `MAX_TEAM_USERS` integer, nullable — The hosting plan's maximum number of Team users.
      - `QUOTA` union — The hosting plan's disk space limit, in megabytes (MB). * `unlimited` — The hosting plan allows unlimited disk space.
        - integer
        - 'unlimited' — The hosting plan allows unlimited disk space.
      - `_PACKAGE_EXTENSIONS` string — A space-separated list of one or more of the hosting plan's package extensions, if any exist.
      - `name` string — The hosting plan's name.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 1 | 0 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)