Difference between revisions of "Domain Grace and Redemption Grace Periods"

From WHMCS Documentation

m (Setting Grace Periods/Redemption Grace Periods and Fees in WHMCS)
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
__TOC__
 
__TOC__
  
<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.5 and above</div>
+
<div class="docs-alert-info">
 +
<i class="fa fa-question-circle"></i>This feature is available in WHMCS 7.5 and higher.
 +
</div>
  
==About Domain Grace and Redemption Grace Periods==
+
==Domain Grace and Redemption Grace Periods==
 
 
First, here's a quick recap of the typical lifecycle of a gTLD domain name:
 
  
 
[[File:Gtld-lifecycle.jpg]]
 
[[File:Gtld-lifecycle.jpg]]
  
Image courtesy of [https://www.icann.org/resources/pages/gtld-lifecycle-2012-02-25-en ICANN].
+
''An example of the typical lifecycle of a gTLD domain name. Image courtesy of [https://www.icann.org/resources/pages/gtld-lifecycle-2012-02-25-en ICANN].''
  
 
===What is the domain grace period?===
 
===What is the domain grace period?===
  
The Grace Period is the status that most TLDs enter following expiry.
+
The grace period is the time period that most TLDs enter following expiry. It typically lasts up to 45 days, and it often does not incur any additional costs, allowing a domain name to still renew at the regular rate.
 
 
The Grace Period typically lasts between 0 and 45 days, and often does not have any additional costs associated with it allowing a domain name to still be renewed at the regular rate.
 
  
 
===What is the domain redemption grace period?===
 
===What is the domain redemption grace period?===
  
Redemption is the status that most TLDs enter if they are not renewed during the grace period.
+
Redemption is the status that most TLDs enter following the grace period if they did not renew. This coincides with a domain being put up for auction. Typically, the redemption period lasts for 30 days.
  
Redemption is a status employed by the registries following the grace period and coincides with a domain being put up for auction.  Typically the redemption period will last for 30 days.
+
Domains can still renew during the redemption grace period (if they do not sell at auction) by paying a redemption fee plus the regular renewal cost for the domain.
  
Domains can still be renewed while in the redemption status (providing it hasn't been auctioned off) by paying a redemption fee plus the regular renewal cost for the domain.
+
If the domain is not recovered from redemption, it enters a pending delete stage at the registry for one to five days. On the sixth day, the registry typically releases the domain to the public for re-registration.
  
If the domain is not recovered from redemption, it enters a Pending Delete stage at the Registry for 1-5 days. On the 6th day, the domain is typically released to the public for re-registration.
+
<div class="docs-alert-info">
 
+
Domain grace periods and redemption grace periods can vary by registrar and registry. Ask your registrar about the grace periods and redemption periods for each of the TLDs you offer.
<div class="docs-alert-info">Domain Grace Periods and Redemption Grace Periods can vary by Registrar and Registry, so it is important to check with your Registrar what the grace periods and redemption periods are for each of the TLDs you offer.</div>
+
</div>
  
 
==Domain Grace and Redemption Period Defaults==
 
==Domain Grace and Redemption Period Defaults==
  
At WHMCS, we've done the hard work for you. We've gone to each of the major registrars and registries, and collated a list of the most common grace period and redemption period timeframes for over 800 of the most common TLDs and extensions.
+
WHMCS has collated a list of the most common grace period and redemption period timeframes for over 800 of the most common TLDs and extensions at each of the major registrars and registries. This allows us to provide default values and recommendations for the grace and redemption grace periods when you add TLDs to WHMCS.
  
This allows us to provide default values and recommendations for the grace and redemption grace periods when you add TLDs to WHMCS.
+
By default, we will '''automatically apply''' the default grace period for a TLD or extension when it is available. This allows customers to renew a domain past the expiry date for the given period of time. By default, no additional fees apply to the renewal of domains in the grace period. This matches the behavior of most registrars and registries, but you can also set additional fees to apply (see below).
  
By default, we will '''automatically apply''' the default Grace Period for a TLD/extension when available.  This allows customers to renew a domain past the expiry date for the given period of time.  By default no additional fees are applied to the renewal of domains in the Grace Period, as is in keeping with the behaviour of most Registrar's and Registries, however you can set additional fees to be applied should you wish as described below.
+
Unlike the grace period, renewal during the redemption grace period typically incurs additional fees. Because those fees vary, we do not apply any defaults automatically. We will still display the default recommended value for the redemption grace period timeframe to you when configuring your extension, but if you wish to enable your customers to renew domains in the redemption grace period, you must manually activate it by setting the '''Redemption Grace Period''' value for a given extension/TLD.  Typically, you will also want to define a '''Redemption Grace Period Fee''' value for this: most registrars will charge you more for renewing a domain in the redemption grace period.
 
 
Unlike with the Grace Period, because renewal during the Redemption Grace Period typically incurs additional fees, and those fees vary, we do not apply any defaults automatically. We will still display the default recommended value for the Redemption Grace Period timeframe to you when configuring your extension, but if you wish to enable your customers to renew domains in the Redemption Grace Period, you must manually activate it by setting the Redemption Grace Period timeframe for a given extension/TLD.  Typically you will also want to define a Redemption Grace Period Fee for this as most Registrars will charge you more for renewing a domain in the Redemption Grace Period.
 
  
 
==Setting Grace Periods/Redemption Grace Periods and Fees in WHMCS==
 
==Setting Grace Periods/Redemption Grace Periods and Fees in WHMCS==
  
For supported gateways, WHMCS can handle Grace and Redemption fees automatically:
+
For supported registrars, WHMCS can handle grace and redemption fees automatically:
  
 
* [[ResellerClub]]
 
* [[ResellerClub]]
Line 48: Line 44:
 
* [[Enom]]
 
* [[Enom]]
  
WHMCS allows you to define the length of time for the Grace Period and Redemption Grace Period for each TLD/extension you sell.
+
WHMCS allows you to define the length of time for the grace period and redemption grace period for each TLD or extension you sell.
  
While it is common for there to be no additional fees associated with the Grace Period for a domain, WHMCS also allows you to set a fee for both the Grace Period and Redemption Grace Period independently for each TLD/extension you offer.
+
Generally, the grace period for a domain does not incur additional fees. However, WHMCS allows you to set a fee for both the grace period and redemption grace period independently for each TLD or extension you offer.
  
To set the grace period values, follow the steps below.
+
To set the grace period values, follow the steps below:
  
1. Begin by navigating to ''Setup > Products/Services > Domain Pricing''.
+
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Pricing]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Pricing'''.
 +
# Click the '''Setting''' icon next to the TLD you wish to manage.[[File:Domain-grace-periods-config.png]]
 +
#* This will reveal the grace period and redemption period settings. 
 +
#* If no values have previously been defined, you will see the default recommended value we have obtained for that extension (when available). 
 +
# Optionally, override the default recommended value with your own setting.
 +
# Optionally, set a fee to charge in addition to the regular renewal price.
 +
#* You can set this for the grace period, the redemption period, or both.
 +
#* Define the fee in your base system currency and WHMCS will auto convert it to any other currencies as and when required.<div class="docs-alert-warning">Grace and redemption fees are compounded, so if a domain expires and does not renew during the grace period, the total amount due will be the regular renewal price plus any grace period fee plus any redemption grace period fee.</div>
 +
# Click '''Save Changes'''.
  
2. Click the Setting icon next to the TLD you wish to manage (indicated below).
+
==Domain Grace Periods and Redemption Grace Invoicing Workflow==
  
[[File:Domain-grace-periods-config.png]]
+
You can select the desired invoicing workflow for the [[Domains_Tab#Domain_Grace_and_Redemption_Fees|domain grace and redemption fees]] in '''Domain Grace and Redemption Fee Billing''' in the '''[[Domains Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.  
  
3. This will reveal the grace period and redemption period settings.  If no values have previously been defined, you will see the default recommended value we have obtained for that extension (when available).  You may override this value as desired.
+
This provides two options:
  
4. You may optionally set a fee that is charged in addition to the regular renewal price for either the Grace Period, Redemption Period, or both.  You should define the fee in your base system currency and WHMCS will auto convert it to any other currencies as and when required.
+
* '''Add Grace and Redemption Fees to existing invoice''' — If you select this option, WHMCS will add additional grace or redemption fees to the existing unpaid renewal invoice for the domain name.
 +
* '''Generate a new invoice for the domain renewal including any Grace and Redemption Fees''' — If you select this option, WHMCS will cancel the existing unpaid domain renewal invoice or invoice item and raise a new invoice with both the renewal fee and the additional grace or redemption fee. You may prefer this option when tax authority rules do not permit you to edit invoices after issuing them.
  
<div class="docs-alert-warning">It is important to note that grace and redemption fees are compounded, so if a domain expires and is not renewed during the grace period, the total amount due will be the regular renewal price + Grace Period Fee (if defined) + Redemption Grace Period Fee.</div>
+
==Disabling Grace Periods and Redemption Grace Period Functionality==
  
5. Once you're happy with your changes, click the ''Save Changes'' button at the bottom of the page to complete the process.
+
You can individually set and control grace periods and redemption grace periods on a per TLD or extension basis. <tt>0</tt> is a valid period for both the grace period and redemption grace period if you do not wish to offer any grace or redemption period for any given extension.
  
==Disabling Grace Periods and Redemption Grace Period Functionality==
+
You can also globally disable all grace period and redemption grace period functionality, which will stop all grace period and fee handling. To do this, go to the '''[[Domains Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
 +
 
 +
==Retaining invoices for expired domains==
 +
 
 +
After a domain finishes any configured grace period and redemption grace period, it will transition to an '''Expired''' status.
 +
 
 +
The domain renewal invoice is also updated to prevent clients from paying a renewal invoice after the domain has expired and is no longer available for renewal:
  
Grace Periods and Redemption Grace Periods can be individually set and controlled on a per TLD/extension basis as described above.
+
* '''Invoice with a single domain renewal line item''' — The invoice status changes to cancelled.
 +
* '''Invoice with multiple line items''' — The system removes the domain renewal line item from the invoice and '''Invoice Modified''' email template sent to the client.
  
Zero ('''0''') is a valid period for both the Grace Period and Redemption Grace Period if you do not wish to offer any Grace or Redemption period for any given extension.
+
To disable these actions and keep domain renewal invoices in an unpaid status after expiry:
  
We also offer an option to globally disable all Grace Period and Redemption Grace Period functionality in the product which will stop all grace period and fee handling from being performed. You will find the setting for this located in ''Setup > General Settings > Domains''.
+
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Pricing]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Pricing'''.
 +
# Click the setting icon next to the TLD.
 +
# Set '''Grace Period Duration''' to a very high number (for example,<tt>9999</tt>).

Latest revision as of 20:10, 16 August 2022

This feature is available in WHMCS 7.5 and higher.

Domain Grace and Redemption Grace Periods

Gtld-lifecycle.jpg

An example of the typical lifecycle of a gTLD domain name. Image courtesy of ICANN.

What is the domain grace period?

The grace period is the time period that most TLDs enter following expiry. It typically lasts up to 45 days, and it often does not incur any additional costs, allowing a domain name to still renew at the regular rate.

What is the domain redemption grace period?

Redemption is the status that most TLDs enter following the grace period if they did not renew. This coincides with a domain being put up for auction. Typically, the redemption period lasts for 30 days.

Domains can still renew during the redemption grace period (if they do not sell at auction) by paying a redemption fee plus the regular renewal cost for the domain.

If the domain is not recovered from redemption, it enters a pending delete stage at the registry for one to five days. On the sixth day, the registry typically releases the domain to the public for re-registration.

Domain grace periods and redemption grace periods can vary by registrar and registry. Ask your registrar about the grace periods and redemption periods for each of the TLDs you offer.

Domain Grace and Redemption Period Defaults

WHMCS has collated a list of the most common grace period and redemption period timeframes for over 800 of the most common TLDs and extensions at each of the major registrars and registries. This allows us to provide default values and recommendations for the grace and redemption grace periods when you add TLDs to WHMCS.

By default, we will automatically apply the default grace period for a TLD or extension when it is available. This allows customers to renew a domain past the expiry date for the given period of time. By default, no additional fees apply to the renewal of domains in the grace period. This matches the behavior of most registrars and registries, but you can also set additional fees to apply (see below).

Unlike the grace period, renewal during the redemption grace period typically incurs additional fees. Because those fees vary, we do not apply any defaults automatically. We will still display the default recommended value for the redemption grace period timeframe to you when configuring your extension, but if you wish to enable your customers to renew domains in the redemption grace period, you must manually activate it by setting the Redemption Grace Period value for a given extension/TLD. Typically, you will also want to define a Redemption Grace Period Fee value for this: most registrars will charge you more for renewing a domain in the redemption grace period.

Setting Grace Periods/Redemption Grace Periods and Fees in WHMCS

For supported registrars, WHMCS can handle grace and redemption fees automatically:

WHMCS allows you to define the length of time for the grace period and redemption grace period for each TLD or extension you sell.

Generally, the grace period for a domain does not incur additional fees. However, WHMCS allows you to set a fee for both the grace period and redemption grace period independently for each TLD or extension you offer.

To set the grace period values, follow the steps below:

  1. Go to Configuration () > System Settings > Domain Pricing or, prior to WHMCS 8.0, Setup > Products/Services > Domain Pricing.
  2. Click the Setting icon next to the TLD you wish to manage.Domain-grace-periods-config.png
    • This will reveal the grace period and redemption period settings.
    • If no values have previously been defined, you will see the default recommended value we have obtained for that extension (when available).
  3. Optionally, override the default recommended value with your own setting.
  4. Optionally, set a fee to charge in addition to the regular renewal price.
    • You can set this for the grace period, the redemption period, or both.
    • Define the fee in your base system currency and WHMCS will auto convert it to any other currencies as and when required.
      Grace and redemption fees are compounded, so if a domain expires and does not renew during the grace period, the total amount due will be the regular renewal price plus any grace period fee plus any redemption grace period fee.
  5. Click Save Changes.

Domain Grace Periods and Redemption Grace Invoicing Workflow

You can select the desired invoicing workflow for the domain grace and redemption fees in Domain Grace and Redemption Fee Billing in the Domains tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings.

This provides two options:

  • Add Grace and Redemption Fees to existing invoice — If you select this option, WHMCS will add additional grace or redemption fees to the existing unpaid renewal invoice for the domain name.
  • Generate a new invoice for the domain renewal including any Grace and Redemption Fees — If you select this option, WHMCS will cancel the existing unpaid domain renewal invoice or invoice item and raise a new invoice with both the renewal fee and the additional grace or redemption fee. You may prefer this option when tax authority rules do not permit you to edit invoices after issuing them.

Disabling Grace Periods and Redemption Grace Period Functionality

You can individually set and control grace periods and redemption grace periods on a per TLD or extension basis. 0 is a valid period for both the grace period and redemption grace period if you do not wish to offer any grace or redemption period for any given extension.

You can also globally disable all grace period and redemption grace period functionality, which will stop all grace period and fee handling. To do this, go to the Domains tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings.

Retaining invoices for expired domains

After a domain finishes any configured grace period and redemption grace period, it will transition to an Expired status.

The domain renewal invoice is also updated to prevent clients from paying a renewal invoice after the domain has expired and is no longer available for renewal:

  • Invoice with a single domain renewal line item — The invoice status changes to cancelled.
  • Invoice with multiple line items — The system removes the domain renewal line item from the invoice and Invoice Modified email template sent to the client.

To disable these actions and keep domain renewal invoices in an unpaid status after expiry:

  1. Go to Configuration () > System Settings > Domain Pricing or, prior to WHMCS 8.0, Setup > Products/Services > Domain Pricing.
  2. Click the setting icon next to the TLD.
  3. Set Grace Period Duration to a very high number (for example,9999).