Registrar TLD Sync

From WHMCS Documentation

Registrar TLD & Pricing Sync functionality requires a domain registrar module that supports TLD Pricing functionality. This is supported natively by the eNom and all LogicBoxes modules. All WHMCS users can get a free account with eNom or ResellerClub by navigating to Setup > Products/Services > Domain Registrars within the WHMCS admin area interface.

The Registrar TLD & Pricing Sync tool allows import of domain extensions and pricing from supported registrars.

On import, a markup amount of either a percentage or a fixed amount can be applied automatically, as well as a rounding amount from a range of options.

How to Sync TLDs and Pricing

To perform an import & pricing sync, begin by navigating to Utilities > Registrar TLD Sync.

Choose the domain registrar that you wish to perform the import or sync with by clicking on the relevant icon.

RegistrarTldSyncStepOneV2.png

If you do not see your desired registrar module in this list, it suggests the domain registrar module you are using does not support the TLD Sync functionality. Try a different registrar or contact the developer of your domain registrar module.

Upon choosing a domain registrar, a connection will be established to the domain registrar and a list of available extensions along with cost pricing for all requested. This may take a couple of minutes to download.

Extension List

Once the TLD and pricing information has been obtained from the domain registrar, you will be presented with a list of all available TLDs, grouped by Category.

For each TLD, you will see the selling status, minimum registration period, and cost price. In the case of TLDs you are already selling, you will also see the current selling price, and margin for each of the 4 pricing options - Register, Renew, Transfer and Redemption.

RegistrarTldSyncStepTwo.png

Any extensions that are being sold at a loss - where the selling price is below the cost price - will be highlighted with a red background.

The Pricing button located in the right-most column can be used to open the WHMCS Pricing matrix for a given TLD, giving you a quick and convenient way to make manual adjustments to the selling pricing of a TLD.

Note that as with all pricing in WHMCS, making changes to product or domain pricing here applies to new customers only. Existing customers by default will retain the prices from the time of their signup/order. To adjust pricing for existing customers, please see the Bulk Pricing Updater utility.

Categories

TLDs are grouped by category using a category mapping provided by Enom. These are the same categories that are used to display domain pricing within the shopping cart.

A single extension may appear in more than one category, and selecting the extension on one category will automatically mark it as selected in any categories it appears in.

If a category is empty or has no TLDs returned by the currently selected domain registrar for sync, the category will not be displayed.

Sync Options

Set the desired margin type and profit margin options for the import process. The available options include:

  • Margin Type - Percentage or Fixed. The type of margin to apply to the imported extensions.
  • Profit Margin - Numerical. Depending on the Margin Type, the amount to apply to the imported extension registrar pricing.
  • Round to Nearest - Choose the number to round up to when setting the import pricing. Eg: x.95 will set all pricing to the next .95 amount.
  • Sync Redemption/Grace Fee - Should the redemption and grace fee be imported and have the same markup applied. Not all registrars support a grace fee.
  • Automatic Registration - Should the TLD being synced set the auto register value to the registrar being synced from

RegistrarTldSyncStepTwoPart2.png

Auto-select TLDs associated with Registrar

Clicking this button will automatically select all TLDs that are configured within the WHMCS installation to be automatically registered with the selected domain registrar.

Performing the Import

To perform the import process, click the "Import TLDs" button which is located at the top and bottom of the domain extensions pricing matrix table.

Import Complete

Once an import has been completed, a confirmation screen will be displayed listing all extensions that were imported and/or updated.

RegistrarTldSyncStepThree.png

If any errors occurred importing or updating an extension, these will be listed separately.

Currency

Domain registrars can return TLD cost pricing information in any currency they define. Typically cost pricing information will be returned in the primary currency of your domain registrar, or based on a setting within your domain registrar account.

Regardless of the currency cost pricing is returned in, WHMCS will always convert and display pricing in your WHMCS system default currency.

For this reason, it is necessary to ensure you always have the currency that cost pricing is returned in by your domain registrar setup and configured with a valid exchange rate prior to using the Registrar TLD Sync tool.

If a currency is encountered that does not exist in WHMCS, or for which no exchange rate is defined, you will see a message such as the ones in red below indicating the currency that needs to be added.

RegistrarTLDSyncNoCurrency.png

When a pricing import and synchronisation is performed, pricing will be set for all active currencies in WHMCS. Currency conversion will be performed using the rates defined in Setup > Currencies, and any rounding defined in the Sync Options will be applied after the conversion has occurred.

Troubleshooting

Unable to display TLD cost pricing as currency 'XXX' is not defined with an exchange rate

This message occurs when a currency in WHMCS is missing, or does not have an exchange rate. Navigate to Setup > Payments > Currencies and either add or update the currency.

Developer Documentation

If you would like to add support for TLD Syncing to a custom or third-party registrar module, please refer to the Registrar Module documentation on the developer site for details of how to implement the required functions.

Notes

ResellerClub

Due to limitations with the ResellerClub API, the prices returned are exclusive of any taxes charged by ResellerClub. If ResellerClub levies a tax on your account we recommend adjusting the Profit Margin setting to include taxes plus the desired profit margin.