Managing Domain Renewals in WHMCS with Openprovider
Renewing Domains
If Automatic renew on payment is selected (which can be found in WHMCS admin area, Setup > General settings > Domains) and Openprovider is set as the auto registration provider, then the module will automatically register or renew the domain in Openprovider via API as soon as the client pays for domain renewal or registration.
When a domain expires in Openprovider, depending on the TLD, it can be put into 'Soft Quarantine' state. While in that state, it can be restored for a normal renewal fee, but restoration needs to be requested with the restoreDomainRequest API command. The module automatically detects when the domain is in Soft Quarantine, and makes an appropriate API request. The module will not request renewal if the domain has already passed into "Hard Quarantine" and can only be restored for an additional fee.
Auto Renew Configurations
Important: Default WHMCS workflow recommend switching “Off” auto-renewal in Openprovider and waiting for the client to pay for their domain renewal prior to performing any renewal action. This greatly reduces the chance of a domain being renewed twice unwittingly and incorrect domain statuses in WHMCS. Please explore WHMCS documentation thoroughly before deciding on the business logic to use in your workflow.
Scenario 1 (WHMCS Recommended)
| Setting | Value |
|---|---|
| Openprovider Global Auto renew | Off |
| WHMCS Auto Registration | On |
| WHMCS Automatic renewal | On |
Process:
End-user receives an invoice based on the due date.
If the invoice is paid before expiration, WHMCS automatically sends a renewal command to the module and the domain's registration period extends.
If the invoice is not paid before the expiration date, the domain will expire or go into quarantine at the expiration date.
If the grace period is supported for the given TLD and the invoice is paid after expiration, the module will send the appropriate command or commands to renew the domain.
If the invoice is paid when the domain is in hard quarantine, or already deleted, the module will not take action.
Scenario 2. Not recommended by WHMCS
| Setting | Value |
|---|---|
| Openprovider Global Auto renew | On |
| WHMCS Auto Registration | On |
| WHMCS Automatic renewal | Off |
Process:
The domain will be renewed at Openprovider on the expiration date, regardless of the invoice status (paid/unpaid).
When the end-user pays an invoice to renew a domain, the WHMCS next due date will increment one year.
No renewal commands are sent to Openprovider from WHMCS via the module.
Important: If a client doesn't pay the renewal invoice before expiry date, the domain's status in WHMCS will cycle from Active → Grace → Redemption → Expired, even though it was auto-renewed at Openprovider.
To trigger the updating of the domain status and expiry date, the invoice would need to be paid in WHMCS, the renewal command successfully sent to your registrar and successfully processed.
Scenario 3. Not recommended!
| Setting | Value |
|---|---|
| Openprovider Global Auto renew | On |
| WHMCS Auto Registration | On |
| WHMCS Automatic renewal | On |
Process:
If the invoice is paid before expiration, WHMCS automatically sends a renewal command to the module and the domain's registration period extends.
If the end-user misses payment due date, the domain will be renewed at Openprovider automatically.
If the end-user pays the invoice after the due date, WHMCS will send another renewal command to the module.
If you have further questions or need help reviewing your WHMCS settings, feel free to contact support.