Requirements & Install

Automatic setup — tables, defaults and email templates are created for you. No manual SQL.

Requirements

The module ships with its own bundled assets (DataTables, SweetAlert2, icons via CSS), so no external CDN dependencies are required for the admin area.

Fresh install

1. Upload the module

Copy the entire SupportPin folder into your WHMCS installation:

/path/to/whmcs/modules/addons/SupportPin/

2. Activate the module

• Log in to the WHMCS Admin Area and go to Configuration → System Settings → Addon Modules.
• Find Support Pin Pro and click Activate.

The module automatically:

• Creates its database tables (hsc_sp_pins, hsc_sp_config, hsc_sp_audit, hsc_sp_users, hsc_sp_email_prefs).
• Seeds default configuration values.
• Creates the email templates used by the module.

3. Enter your license key

Click Configure, paste the License key you received by email (or from the client area: Account → My Products → manage product) and save. The module validates the key automatically and will not run until a valid key is saved.

4. Set admin permissions

Still on Configuration → System Settings → Addon Modules, click Configure for Support Pin Pro, select which admin groups can access the module and click Save Changes.

5. Enable email templates

Go to Setup → Automation → Email Templates and check that the Support PIN email templates exist (they are created automatically on activation).

Verification

• After activation, open the module from Addons → Support Pin Pro.
• You should see the dashboard with empty statistics and a “Quick PIN Generation” panel.
• Generate a PIN for a test client to confirm everything works end-to-end.

Upgrading from v1 to v2

The upgrade hook runs automatically when WHMCS detects the new version — no manual database work is required.

1. Back up your database and the old modules/addons/SupportPin folder.
2. Replace the old folder with the v2 folder (keep the same folder name SupportPin).
3. In the WHMCS Admin Area, go to Configuration → System Settings → Addon Modules — WHMCS detects the version change and runs SupportPin_upgrade(), which re-runs the schema, seed and email-template routines (adds missing v2 columns such as created_by_userid and the email-preferences table, re-seeds missing config defaults and recreates missing email templates).
4. Clear WHMCS template cache if the admin pages do not reflect the new styles (Utilities → System → System Cleanup, or delete the contents of the addon’s templates_c folder).