User Documentation

Welcome to the User Documentation. Here is a complete guide to everything you can do on the site.

Account Management

Path: /register

Register: Create a new account by providing an email address and a password. Upon registration, you will receive basic free credits and a welcome email.

Path: /login

Login: Access your account using your email and password. Your subscription status is automatically synced upon login.

Path: /forgot-password

Forgot Password: If you lose your password, enter your email here to receive a secure password reset link.

Path: /reset-password

Reset Password: Use the link from your email to set a new password for your account.

Path: /logout

Logout: Securely sign out of your current session.

Profile & Preferences

Path: /account/profile

Profile Management: Update your name, change your password, and manage email notification preferences.

Path: /account/data-export (via POST)

GDPR Data Export: Export your complete user data, including subscription history, credit ledger, and licenses, as a JSON file.

Path: /account/delete (via POST)

Account Deletion: Permanently delete your account, which automatically cancels your subscription and erases all data.

Billing & Subscriptions

Path: /pricing (or /)

Pricing Plans: View the available subscription tiers, credit limits, and purchase options.

Path: /account

Account Dashboard: View your self-service billing portal. This dashboard displays your credit ledger (recent transactions), your complete billing history, and current active subscription details.

Path: /account/check-subscription (via POST)

Sync Subscription: A button on your dashboard to manually check and sync your subscription status with the billing provider (Paddle). This ensures your credits are correctly granted if there's a delay.

Path: /account/upgrade

Upgrade/Downgrade: Change your currently active subscription plan via a secure Paddle checkout session.

Path: /account/pause & /account/resume (via POST)

Pause / Resume: Temporarily pause your subscription or resume an already paused subscription directly from your dashboard.

Path: /account/cancel (via POST)

Cancel Subscription: Cancel your subscription effective at the end of the current billing period.

Path: /portal

Customer Portal: Redirects you to your dedicated Paddle Customer Portal where you can manage your payment methods, download invoices, pause, or cancel your subscription.

Path: /checkout

Checkout Process: When purchasing a new plan or completing a transaction from an external app, you will be redirected here to securely process your payment via Paddle.

Credits & Features

Path: /account/credits

Credit History: View your complete credit usage and transaction ledger.

Path: /account/topup

Buy Credits (Top-Up): Purchase additional one-off credit packs when you are running low on credits.

Path: /account/usage

Usage Dashboard: View charts and per-app usage analytics for your credits over the last 30 days.

Path: /account/licenses

License Viewer: View all your acquired license keys for software apps, and re-send license key emails to yourself.

Path: /account/invoices

Invoices: View your past billing events and purchase history.

Path: /account/referral

Referral Program: Get your unique referral link to share with friends, and earn bonus credits when they sign up.