Support Pin Profor WHMCS · Documentation
v2.0.0

Admin Usage Guide

After installation you will see Support Pin Pro in the Addons menu. The top navigation bar switches between five areas: Dashboard, Support Pins, Clients, Activity Log and Settings.


Dashboard

/admin/addonmodules.php?module=SupportPin

The dashboard is your command centre for monitoring and acting on support PINs.

  • Statistic tiles — six live counters update in real time:
    • Total PINs — every PIN ever generated.
    • Active PINs — PINs currently in an active state.
    • Expired PINs — PINs that have reached their expiry time.
    • Clients with PINs — distinct clients that hold at least one PIN.
    • Generated Today — PINs created since midnight.
    • Verified Today — PINs successfully verified today.
  • Quick PIN Generation — select a client by name, email or ID, then generate a PIN without leaving the dashboard. The generated code appears in a SweetAlert2 dialog and can be copied immediately — the fastest way to issue a PIN while a client is on the phone.
  • Verify Support PIN — paste or type a code to verify it instantly. The result modal shows the verdict (Valid / Used / Expired / Inactive / Not Found) plus the PIN details, with quick actions such as Mark Used or Terminate.
  • Recent Activity — a colour-coded feed of the latest audit entries.

Support Pins

/admin/addonmodules.php?module=SupportPin&p=pins

This page lists every PIN in the system across all clients.

  • DataTable columns — Client, PIN Code, Status, Created, Expires, Actions; with search, sort and pagination.
  • Live countdown — each active PIN shows a ticking (h m s) countdown next to the code.
  • Client name — click any client name to open their WHMCS profile in a new tab.
  • Row actions (for active PINs only):
    • Extend — pushes the expiry time forward by the configured number of hours.
    • Terminate — immediately flips the PIN to expired.
    • Delete — permanently removes the PIN record.
    • All destructive actions use a SweetAlert2 confirmation dialog with a fallback to the native confirm().
  • Admin users always see the full PIN code, regardless of the Hide PIN client setting.

Clients

/admin/addonmodules.php?module=SupportPin&p=clients

This page focuses on a single client and every PIN attached to them.

  • Search bar — a wide, centred search field. Enter a client name, email address or numeric ID and press Search.
  • Client overview card — the client’s name (linked to their WHMCS profile), a #ID badge, their email address and a prominent green Generate PIN button.
  • PIN table — every PIN for the selected client with the full code, live countdown, status badge, created/expires timestamps and the Extend / Terminate / Delete actions.
  • Empty states — friendly icon-and-text placeholders when a client has no PINs or before a search is performed.
  • Generate modal — pre-scoped to this client; submitting creates a new active PIN and returns you to the refreshed list.

Activity Log

/admin/addonmodules.php?module=SupportPin&p=audit

A complete, searchable audit trail of everything that happens with your support PINs.

  • Columns — Client, Email, User, Action, Detail, Date:
    • Client — the account the action belongs to (linked to the profile). Rows with no client (e.g. PIN-not-found attempts) show an em-dash.
    • Email — the client’s email address as a clickable mailto: link.
    • User — the sub-user’s name, or Owner for account-owner actions.
    • Action — a colour-coded badge (Generate, Extend, Terminate, Delete, Used, Verified, Verify failed, Expired).
    • Detail — a human-readable description such as “PIN revoked by client”, plus the PIN code, status badge and expiry when available.
    • Date — the exact timestamp plus a relative hint such as “2 hr ago”.
  • Logged events — generate, extend, terminate, delete, mark-as-used, successful verification, failed verification, PIN not found, cron auto-expiry and cron auto-removal.
  • Clear Log — wipes the entire audit history after a confirmation prompt.

Settings

/admin/addonmodules.php?module=SupportPin&p=settings

Configure every aspect of the module. Settings are grouped into four tabs — General, Security & Expiry, Sidebar Display, and Users & Notifications. See the Settings Reference for a full explanation of every option.