1. What This Module Does
The registrar module connects a reseller’s WHMCS domain actions to your reseller platform. It allows end-clients to manage domains from the normal WHMCS domain pages while keeping branding reseller-first.
Scope of this document: registrar module behavior only. No internal platform implementation details are exposed here.
2. Who Uses It
Reseller Owner
Installs the registrar module in WHMCS, configures credentials once, and sells domains using their own brand.
Reseller End-Client
Uses standard WHMCS pages to register, transfer, renew, edit nameservers, DNS records, domain forwarding, DNS records, child nameservers, email forwarding when configured, and more.
Admin Team
Approves special workflows like support lock requests and account upgrades, and controls pricing/policies centrally.
3. Account Types and Benefits
There are two account types in current production flow:
| Account Type | Who It Is For | Feature Access | Business Benefit |
|---|---|---|---|
| Basic | Default starting tier for most new resellers. | Full registrar operations, nameserver control, lock/contact/EPP management, and supported domain addons. | Fast entry to market with low complexity and complete domain operations. |
| Premium | Resellers with stronger volume, growth, or approved fast-track requests. | Same operational feature set with premium account economics and premium-level pricing profile. | Better margins and stronger scaling model for higher-volume resellers. |
Upgrade lifecycle: a reseller can request upgrade, submit paid fast-track where available, and await final admin decision.
Decision notifications are sent through configured WHMCS email templates.
4. Core Features and How They Work
4.1 Domain Register / Transfer / Renew
- Orders are submitted directly from WHMCS workflows.
- Client chooses registration years as configured for the TLD.
- Transfers use EPP/Auth code flow.
- Renewals run by term and apply account-tier cost behavior.
4.2 Nameserver Management
- Get and update nameservers from WHMCS domain page.
- Readiness guidance appears when domain must point to assigned nameservers for addon readiness.
- Benefits: quick migration, fewer support tickets, faster onboarding for client domains.
4.3 DNS Records Management
- Create, edit, and delete DNS records from domain DNS page.
- Per-row delete action includes confirmation and success feedback.
- Benefits: resellers and end-clients can self-serve without waiting for support.
4.4 ID Protection
- Toggle privacy service where supported for the TLD.
- Benefits: privacy compliance and upsell opportunity.
4.5 Registrar Lock and EPP
- Lock status can be read/updated from WHMCS.
- EPP retrieval is available for transfer-out scenarios.
- Benefits: stronger security and smoother transfer operations.
5. Cost Model and Charging Behavior
Charging is account-type aware and action-based. Reseller cost is determined when a billable action is requested and processed. This section explains behavior from reseller perspective only.
5.1 Domain Action Charges
- Billable actions: Register, Transfer, Renew.
- Term-based charging: supports yearly terms configured for each TLD (including multi-year entries you publish).
- Basic account uses Basic account pricing profile.
- Premium account uses Premium account pricing profile.
5.2 Addon Service Charges
- Addon charges apply only to supported services such as DNS management and ID Protection when enabled.
- If addon cost is set to 0, reseller sees it as Free.
- If addon is not available for a domain/TLD, it will not be provisioned as a chargeable service.
5.3 Failed Action Behavior
- If an operation fails registry, final charge should not remain as a completed successful transaction.
- Resellers should verify outcome from status/messages and transaction history after retries.
5.4 Premium Upgrade Charging
- Premium upgrade request can be free review (auto/manual path) or paid fast-track path (if enabled).
- Paid fast-track uses invoice payment workflow before final admin decision.
- Admin decision remains the final approval gate.
Business tip: keep clear pricing differences between Basic and Premium to make upgrade value obvious to high-performing resellers.
6. Installation and Setup (Registrar Only)
- Upload
nairahostresellerfolder to/modules/registrars/in reseller WHMCS. - WHMCS Admin -> System Settings -> Domain Registrars -> activate NairaHost Registrar.
- Enter module credentials and save configuration.
- Assign this registrar to required TLDs in WHMCS Domain Pricing.
- Run a smoke test: lookup, register, nameserver update, DNS add/delete, email forwarder add/delete.
7. Technical Requirements
| Requirement | Minimum | Recommendation |
|---|---|---|
| WHMCS | 8.x | Latest stable WHMCS 8.x |
| PHP | 7.4+ | 8.1+ with required extensions |
| Required Extensions | cURL, JSON | Enable standard WHMCS-supported stack |
| Network | Outbound HTTPS | Stable low-latency connection |
| Credentials | Valid key + secret | Rotate periodically and keep private |
8. 10 Troubleshooting Guides
| # | Problem | What It Means | Fix |
|---|---|---|---|
| 1 | Authentication failed | Credential mismatch or wrong endpoint | Re-enter module key/secret and verify base URL. |
| 2 | Domain register fails | TLD data/contacts/availability issue | Confirm domain is available and all required contact fields are complete. |
| 3 | Transfer rejected | Wrong EPP code or domain locked | Request fresh EPP and unlock at current registrar before retry. |
| 4 | Renew action fails | Invalid term or temporary registry rejection | Retry with allowed term and check notices in module logs. |
| 5 | Nameserver save works but addons not ready | Propagation still in progress | Wait DNS propagation and reload readiness section. |
| 6 | DNS record delete button not visible | Page cache or old template assets | Clear template cache and hard refresh browser. |
| 7 | Email forwarder save fails | Invalid destination or forwarding rule conflict | Use valid destination address and retry with unique prefix. |
| 8 | ID Protection toggle unavailable | TLD does not support privacy in current policy | Use supported TLD or disable the addon on that TLD listing. |
| 9 | Premium request still pending | Awaiting invoice payment or admin decision | Confirm invoice status and request admin review/decision. |
| 10 | Prices shown look wrong for account | Reseller is on different account type than expected | Confirm reseller account type (Basic/Premium) and re-check displayed terms. |
9. 10 FAQ
1) Is this registrar module white-labeled?
Yes. Your reseller brand remains front-facing in WHMCS domain operations.
2) Can clients manage nameservers themselves?
Yes. End-clients can update nameservers directly from WHMCS domain management.
3) Does the module support DNS record management?
Yes. Add, edit, and delete DNS records from the DNS management page.
4) Can clients create email forwarders?
Yes. Email forwarding create/update/delete is supported only when the NairaHost integrated forwarding layer is configured. NairaHost Registry API v11 documents domain URL forwarding, not native email forwarding.
5) What is the difference between Basic and Premium?
Feature operations are similar, but account economics and pricing behavior differ by account type.
6) How do resellers become Premium?
They submit an upgrade request, then follow free review and/or paid fast-track path, with final admin decision.
7) Can addon services be free?
Yes. If service cost is set to 0, it appears as Free and no addon fee is charged for that service.
8) Is multi-year pricing supported?
Yes. Multi-year terms can be published and charged according to account type pricing.
9) Does this module support registrar lock and EPP?
Yes. Both lock management and EPP retrieval are included.
10) Do I need full-page reload to use core manager actions?
No. Current implementation supports smoother section-based updates for key manager areas.
10. Release Readiness Checklist
- Registrar module activated and credentials validated.
- Basic and Premium account paths tested.
- Domain register/transfer/renew tested end-to-end.
- Nameserver update + readiness confirmation tested.
- DNS add/edit/delete tested.
- Email forwarding add/delete tested.
- ID protection toggle tested on supported TLDs.
- Premium request and admin decision notifications tested.
If all checklist items pass, the registrar module is production-ready for reseller onboarding.