We log search terms to improve our documentation. For more information, read our Privacy Policy.

How to Set Up Domain Recommendations & Purchase

Last modified: 2026 August 12


Overview

The Domain Recommendations & Purchase feature integrates with your WHMCS installation to sell new domains to your customers. cPanel account users can access this feature when they create or manage domains via cPanel’s Domains interface (cPanel » Home » Domains » Domains). This document explains how to set up the Domain Recommendations & Purchase feature.

Note:
  • The Domain Recommendations & Purchase feature is experimental. cPanel account users must sign in to WHMCS manually to complete a domain purchase. We plan to add automatic sign-in to the WHMCS cart in a future release.
  • Only the Jupiter theme supports this feature.

WHMCS Setup Requirements

This feature requires a WHMCS instance that you have configured to sell domain registrations. For information about selling domains in WHMCS, read WHMCS’s Selling and Managing Domains documentation.

Connect cPanel & WHM to WHMCS

To connect cPanel & WHM to your WHMCS instance, perform the following steps:

Note:

The steps below create a domain_recommendations_credentials.json file to configure the Domain Recommendations & Purchase feature. You can rename this JSON file to meet your preferences.

  1. Create the /var/cpanel/panel.ini file.

    touch /var/cpanel/panel.ini
  2. Add the following data to your /var/cpanel/panel.ini file:

    1
    2
    3
    
    [domain_recommendations]
    enabled = true
    store_config = /var/cpanel/domain_recommendations_credentials.json
  3. Create the /var/cpanel/domain_recommendations_credentials.json file:

    touch /var/cpanel/domain_recommendations_credentials.json
  4. To configure the /var/cpanel/domain_recommendations_credentials.json file, you must use the parameter values from your WHMCS instance.

    Parameter Description Example
    store_api_url Your WHMCS instance’s system URL for the API v2 endpoint. https://example.com/whmcs/api/v2/
    skip_ssl_verify Whether to skip SSL/TLS certificate verification when cPanel & WHM connects to the WHMCS API. Only set this option to true for testing purposes. false
    store_type The type of store backend. This parameter only supports the WHMCS value. WHMCS

    Add your WHMCS instance information to the /var/cpanel/domain_recommendations_credentials.json file. Review the following example:

    1
    2
    3
    4
    5
    
    {
      "store_api_url": "https://example.com/whmcs/api/v2/",
      "skip_ssl_verify": false,
      "store_type": "WHMCS"
    }

After you have completed these steps, cPanel’s Domains interface (cPanel » Home » Domains » Domains) will display the Domains Recommendations & Purchase feature.

Additional Documentation