Welcome to the User Documentation. Here is a complete guide to everything you can do on the site.
/registerRegister: Create a new account by providing an email address and a password. Upon registration, you will receive basic free credits and a welcome email.
/loginLogin: Access your account using your email and password. Your subscription status is automatically synced upon login.
/forgot-passwordForgot Password: If you lose your password, enter your email here to receive a secure password reset link.
/reset-passwordReset Password: Use the link from your email to set a new password for your account.
/logoutLogout: Securely sign out of your current session.
/account/profileProfile Management: Update your name, change your password, and manage email notification preferences.
/account/data-export (via POST)GDPR Data Export: Export your complete user data, including subscription history, credit ledger, and licenses, as a JSON file.
/account/delete (via POST)Account Deletion: Permanently delete your account, which automatically cancels your subscription and erases all data.
/pricing (or /)Pricing Plans: View the available subscription tiers, credit limits, and purchase options.
/accountAccount Dashboard: View your self-service billing portal. This dashboard displays your credit ledger (recent transactions), your complete billing history, and current active subscription details.
/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.
/account/upgradeUpgrade/Downgrade: Change your currently active subscription plan via a secure Paddle checkout session.
/account/pause & /account/resume (via POST)Pause / Resume: Temporarily pause your subscription or resume an already paused subscription directly from your dashboard.
/account/cancel (via POST)Cancel Subscription: Cancel your subscription effective at the end of the current billing period.
/portalCustomer Portal: Redirects you to your dedicated Paddle Customer Portal where you can manage your payment methods, download invoices, pause, or cancel your subscription.
/checkoutCheckout 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.
/account/creditsCredit History: View your complete credit usage and transaction ledger.
/account/topupBuy Credits (Top-Up): Purchase additional one-off credit packs when you are running low on credits.
/account/usageUsage Dashboard: View charts and per-app usage analytics for your credits over the last 30 days.
/account/licensesLicense Viewer: View all your acquired license keys for software apps, and re-send license key emails to yourself.
/account/invoicesInvoices: View your past billing events and purchase history.
/account/referralReferral Program: Get your unique referral link to share with friends, and earn bonus credits when they sign up.