Revision as of 16:57, 13 May 2021

This section of our docs explains how to configure domain registrar modules in WHMCS for the selling of domains to allow automated provisioning and management.

In Configuration () > System Settings > General Settings > Domains, you can configure which domain options you offer (register, transfer, or own domain) and various payment- and renewal-related settings. For more information, see Domains Tab.

Registrar Configuration

Watch the video tutorial for this feature  

To configure a registrar:

1. Go to Configuration () > System Settings > Products/Services > Domain Registrars.
2. Choose the registrar you want to configure from the list of available registrars and click the corresponding Activate button
3. Enter the relevant details for your account. Each registrar that WHMCS supports has specific instructions and requirements. For more information, see Domain Registrars.
4. Go to Configuration () > System Settings > General Settings > Domains to set the default nameservers that WHMCS will use for domain-only registrations.

Domain Pricing

For an explanation of how to configure the prices you charge to your clients for domain registration and associated addons, see Domain Pricing.

Automatic Domain Registration

With Automatic Domain Registration, you can automate the submission of registration and transfer requests with the built-in registrars.

When you enable this, WHMCS will automatically submit the request to the registrar as soon as the client pays you for it. WHMCS never submits domain registrations before you receive payment.

You can automate some TLDs but not others, and you can select which registrar to use for each TLD you offer.

• To enable automatic registration, go to Configuration () > System Settings > Products/Services > Domain Pricing. Choose a registrar in the automatic registrar menu on each TLD you want to automate.
• To disable automatic registration, select None from the menu.

Note: When you have disabled automatic domain registration, the system will wait until after a client has paid and an admin user manually reviews the order and authorizes it. At that point, the admin user can still initiate the automatic registration by accepting the order once they know the order is legitimate.

Manual Domain Registration

If you need to sell a TLD that none of the supported registrar modules support, you can still use WHMCS to take the order and invoice the client. However, in this case, you must perform domain registration, renewal, and updates manually.

To do this, use the Email Registrar Module:

1. Activate the module as you would a normal registrar module (see above).
2. Specify an email address.
3. Configure the pricing for the TLD to register manually (see above).
4. Select Email from the auto-register menu.

When a client orders or renews the domain, the system will send an email to the email address, notifying you that you must take manual action. Clients will need to contact you to make any modifications to the domain.

Automatic Renewal

You can enable domain renewals for auto submission to the domain registrar as soon as you receive payment for them. This setting is independant of the auto registration, and you can enable this without enabling it.

To enable this:

1. Go to Configuration () > System Settings > General Settings > Domains.
2. Check the Auto Renew on Payment checkbox.

You should always turn automatic renewal off at the registrar. Otherwise, it would override WHMCS' behaviour and renew regardless of whether you received payment.

Domain Renewals

By default, all domains are set to auto-renew, but this is not the same as what domain regstrars commonly mean by auto-renewal. In this case, an invoice will generate a number of days (according to your settings) prior to the due date. After you receive payment, the domain will renew. Paid domains never renew without payment.

Disable Auto Renew

You can set a domain's auto renewal setting to off so that no invoice will generate and the domain will expire.

To do this, toggle Disable Auto Renew to YES on the domain management page in the Admin Area. Clients can do this by toggling the option in the Client Area domain details page.

When you click the Disable Auto Renew button, WHMCS checks for any outstanding invoices:

• If the domain is invoiced on its own, it cancels that invoice.
• If the domain appears on an invoice for multiple items, WHMCS only removes the domain's line.

Disabling auto-renewal via the Admin Area will not trigger the automated invoice cancellation, allowing you to keep an existing renewal invoice or to cancel it manually. The system will continue to send Upcoming Domain Renewal notices, and clients can renew the domain manually if they wish.

Domain Renewal Notices

Renewal Notices Setup

By default, the system sends at least two domain renewal notices prior to expiration and one following it. You can change the timing, send reminders before and after a domain's expiration date, or disable it. The client's Email tab records the reminders, and the system logs them in the Domain Renewal Reminder Emails report for ICANN compliance (module dependant).

Changing Notice Intervals

To change the interval at which WHMCS sends renewal notices:

1. Navigate to Configuration () > System Settings > Automation Settings or, prior to WHMCS 8.0, Setup > Automation Settings.
2. Scroll to the Domain Reminder Settings section.
3. For each of the five possible reminders:
   1. Enter a number of days. You can disable any reminder option by setting it to 0.
   2. Select either before or after from the dropdown menu to indicate whether to send the reminder that many days before the next due date or that many after it.
4. In WHMCS 8.2 and later, choose whether to send renewal reminders for free domains associated with a paid product or service.

• • This setting defaults to disabled for existing installations upgrading to WHMCS 8.2 and to enabled for new installations of WHMCS 8.2 and higher.
  • For more information, see Free Domains.

Editing the Renewal Notice Email

To edit the email message sent to clients:

1. Go to Configuration () > System Settings > Email Templates.
2. Select a template and edit it:

• • Upcoming Domain Renewal Notice is sent before a paid domain expires.
  • Upcoming Free Domain Renewal Notice is sent before a free domain expires.
  • Expired Domain Notice is sent after a domain expires.

For more information, see Email Templates.

Offering Free Domain Registration with Selected Packages

With WHMCS, you are able to offer free domains with your packages clients purchase them with certain payment terms. For example, you might want to offer a free domain when a client purchases an annual package.

To do this:

1. Go to Configuration () > System Settings > Products/Services > Products/Services.
2. Click the edit icon next to the product or service that you want to offer a free domain with.
3. Select the Free Domain tab from the tabs at the top of the page.
4. Choose the type of free domain you want to offer: either the first year free and to renew as normal or for the lifetime of the package.
5. Select the payment terms (or billing cycles) that you want to offer with the free domain. Press Ctrl when clicking the options to select more than one.
6. Select which TLDs the free domain offer applies to. This allows you to exclude high priced TLDs such as .tv. Press Ctrl while clicking the options to select more than one.
7. Click the Save Changes button.

Now, this package won't charge the user for the domain when their order meets the specified criteria.

As long as the payment method for the domain and the hosting account is the same, and the next due date is the same, when generating the next invoice (based on the settings in your Automation settings), WHMCS will invoice for the hosting and the domain on the same invoice. When this you receive payment for the invoice, WHMCS will (if your settings allow this in Configuration () > General Settings > Domains) automatically renew your clients domain for a further period. The hosting account and domain's next due date will automatically change to the next period.

Adding Additional WHOIS Services

WHMCS 7.0 introduced override capabilities to Whois servers. These provide an easy way to maintain customisations during automatic updates. In addition, the location and format for some of these files changed.

TLD Specific Additional Domain Fields

WHMCS 7.0 introduced override capabilities to additional domain fields. These provide an easy way to maintain customisations to these files during automatic updates. In addition, the location and format for some of these files has changed.

Customising Domain Name Length Restrictions

The major TLDs have length limits by default. You can specify your own for any others by adding lines like these to the WHMCS configuration.php file:

$DomainMinLengthRestrictions[".asia"] = 3;
$DomainMaxLengthRestrictions[".asia"] = 64;
$DomainMinLengthRestrictions[".ws"] = 4;
$DomainMaxLengthRestrictions[".ws"] = 63;

Customising Domain Renewal Restrictions

Many TLDs have restrictions on renewal before and after expiration (the grace period). For example, you can typically renew a .com 40 days after the expiry date, while you can renew .uk domains between 180 days prior to expiration up to 97 days afterwards (registrar dependent).

The major TLDs have grace periods by default. You can specify your own for any others by adding lines such as these to the configuration.php file:

$DomainRenewalGracePeriods[".com"] = "40";
$DomainRenewalMinimums[".co.uk"] = "180";
$DomainRenewalGracePeriods[".co.uk"] = "97"; 

You can also specify multiple grace periods and minimum advance renewal restrictions in a single entry:

$DomainRenewalGracePeriods = array(".com"=>"30",".net"=>"40",".uk"=>"97");
$DomainRenewalMinimums = array(".com"=>"180",".com.au"=>"90");

Default Values

There are defined default Domain Grace and Redemption Period values for over 800 of the most common TLDs and extensions. For more information, see Domain Grace and Redemption Period Defaults.

The default Minimum Renewal Periods are:

.co.uk = 180,.org.uk = 180,.me.uk = 180,.com.au = 90,.net.au = 90,.org.au = 90

The default Minimum Length is three characters and the default Maximum Length is 63 characters for the following TLDs:

.com, net, .org, .info, biz, .mobi, .name, .asia, .tel,.in, .mn, .bz, .cc
.tv, .us, .me, .co.uk, .me.uk, .org.uk, .net.uk, .ch, .li, .de, .jp

Domain Pricing Matrix

The Client Area Domain Extension Pricing page is at cart.php?a=add&domain=register. It is designed to provide visitors and clients an intuitive overview of your extension pricing. The layout of this client area page should aid you in promoting your best extensions.

For more information about domain spotlights, see Domain Pricing Matrix page.

Customising Domain Categories

Domain Categories are used on cart.php?a=add&domain=register to group domain TLDs into categories such as Popular, Shopping, or Real Estate and makes it easier for clients to navigate and find their ideal domain extension.

For more information about customising the domain categories, see Domain Categories.