Admin Documentation

This document details the features and operations available to site administrators.

Dashboard & Metrics

Path: /admin

Overview Dashboard: View key metrics, such as total registered users and active subscriptions, along with recent system logs. Includes user search functionality.

Path: /admin/revenue

Revenue Dashboard: View detailed revenue metrics and an aggregated monthly revenue chart, along with recent billing events.

Path: /admin/analytics

App-Level Analytics: View credit usage breakdowns across different SaaS applications.

Path: /admin/churn-risks

Churn Risks: View a list of users potentially at risk of cancelling their subscriptions based on recent activity or lack thereof.

Path: /admin/users/<user_id>

User Detail Page: Inspect a specific user intimately, detailing their subscriptions, credit ledger, licenses, and raw billing events.

Administrative Actions

Path: /admin/credits (via POST)

Manage Credits: Manually grant or deduct credits for a user. Useful for refunds, bonuses, or support.

Path: /admin/bulk-credits

Bulk Credits Adjustment: Add credits to all users on a specific subscription tier at once, sending notification emails in the process.

Path: /admin/sync & /admin/sync-all (via POST)

Force-Sync Subscriptions: Force sync a specific user's Paddle data locally, or trigger a background thread to sync all users at once.

Path: /admin/cancel, /admin/pause, /admin/resume (via POST)

Manage Subscriptions: Intervene to cancel, pause, or resume a user's subscription on their behalf.

Path: /admin/override-plan (via POST)

Override Plan: Adjust a user's plan and status in the local DB without pinging Paddle (useful for custom pricing or complimentary tier access).

Path: /admin/refund (via POST)

Issue Refund: Trigger a transaction refund via Paddle directly from the user's detailed billing history.

Path: /admin/impersonate/<user_id>

User Impersonation: Start an impersonation session to temporarily view the frontend billing portal as the specified user to troubleshoot issues.

Developer & Access Management

Path: /admin/api-keys

API Key Manager: Generate new programmatic API keys for connected SaaS apps, or revoke existing ones.

Path: /admin/licenses

License Manager: View all issued license keys and audit logs. Issue new licenses directly to users or revoke existing ones.

Path: /admin/licenses/batch

License Batch Generation: Generate up to 500 license keys at once for an app and download them as a CSV file.

Webhooks & Integrations

Path: /admin/webhooks

Webhook Event Log: View all incoming raw webhook payloads from Paddle. Replay an event entirely if it initially failed.

Path: /admin/webhook-routes

Webhook Routing Config: Manage fan-out webhook forwarding logic, routing specific event types to different internal applications.

Path: /admin/webhook-deliveries

Webhook Deliveries Log: View the delivery attempts for webhook fan-outs, and instantly retry any failed delivery.

System Configuration

Path: /admin/alert-rules

Alert Rules: Manage system-wide alert rules (e.g., low revenue threshold triggers or user count alerts) and be emailed when triggered.

Path: /admin/credit-packs

Credit Pack Manager: Create and manage the one-off credit packs that users can purchase via their portal Top-Up page.