---
title: "POST /store/domain/suggestions"
method: POST
path: "/store/domain/suggestions"
---

# POST /store/domain/suggestions

`POST /store/domain/suggestions`

## Request

- Base URL: `https://developers.whmcs.com/api/v2`
- URL: `https://developers.whmcs.com/api/v2/store/domain/suggestions`
- Auth: none declared

Query a list of domain suggestions.

## Query parameters

- `page` integer
- `page_size` integer

## Request body

- DomainSuggestionRequest
  - `term` string, required: domain, keyword, or phrase to use as the basis for suggestions depending on the Lookup Provider capabilities
  - `tlds` string[], nullable: an optional array of top level domains (TLDs) to check for suggestions (not all Lookup Providers support this)
  - `maximum_length` integer, nullable: the optional maximum number of characters for the suggested domain names (not all Lookup Providers support this)
  - `filter_sensitive_content` boolean, nullable: whether to filter out sensitive words from the suggestions (not all Lookup Providers support this)

## Response `200`

Success

- object
  - `meta` union
    - object
      - `total_items` integer, required: The total number of results available.
      - `page` integer, required
      - `total_pages` integer, required
      - `page_size` integer, required: The current number of results per page.
    - unknown[]
      - unknown
  - `data` DomainStatus[], required
    - `domain_name` string, required
    - `idn_domain_name` string, required
    - `tld` string
    - `sld` string, required
    - `idn_sld` string, required
    - `status` 'registered' | 'available for registration' | 'reserved' | 'unknown' | 'tld not supported', required
    - `group` string, nullable, required
    - `pricing` DomainPricing[], required
      - `period` integer, required
      - `register` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
      - `transfer` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
      - `renew` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
    - `shortest_period` DomainPricing, required
      - `period` integer, required
      - `register` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
      - `transfer` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
      - `renew` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
    - `is_premium` boolean, required
    - `premium_cost_pricing` DomainPricing, required
      - `period` integer, required
      - `register` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
      - `transfer` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix
      - `renew` Amount, required
        - `value` string, required
        - `code` string, required
        - `display_value` string, required
        - `prefix` string, required: Optional currency prefix
        - `suffix` string, required: Optional currency prefix

## Other responses

- `default`: General Error

---

[API](https://skmtc.dev/whmcs/apis/whmcs-api.md) - [All operations](https://skmtc.dev/whmcs/apis/whmcs-api/llms.txt) - [OpenAPI document](https://skmtc.dev/whmcs/apis/whmcs-api/revisions/bd3848ddbc3f?raw)