Quick Start
Get a product live and take a test payment. This assumes you have set the store currency in Configuration and entered test credentials for at least one gateway under Components → LicenseDock → Payment Gateways.
1. Create a Product
- Go to Components → LicenseDock → Products → New
- Fill in Title (the alias is generated from it) and the description
- On the Details tab, leave Requires License on if the product needs a license key
- Publish and save
Plans and downloads can only be added once the product has been saved.
2. Add a Plan
A plan is a tier of the product (e.g. Single Site, 5 Sites, Unlimited).
- Open the Plans & Pricing tab and click Add Plan
- Set the plan Title
- Pick an Activation Type – Domain, Device, Seat or Instance – which decides what each activation represents
- Set the Activation Limit (
0= unlimited) - Click Apply
3. Add a Price
Each plan has one or more prices.
- On the plan card, click Add Price
- Pick a Billing Cycle – Monthly, Quarterly, Semi-Annual, Annual or One-Time
- For One-Time, choose the Access Duration: Lifetime, or Valid For a number of days, weeks, months or years
- Set the Price
- Optionally set Trial Days and Trial Price (
0for a free trial) - Click Apply
Give a plan several prices to offer, for example, monthly and annual billing. See Plans & Pricing.
4. Upload a Download (Optional)
If the product is a file or software:
- Open the Downloads tab and click Add Version
- Set the Version and Release notes
- Upload one or more files
- Save
See Downloads.
5. Create a Checkout Menu Item
- Menus → Main Menu → New
- Menu Item Type: LicenseDock → Checkout
- Save. The item can be hidden from the menu – the URL just needs to exist
Add a LicenseDock → Single Product or Products menu item for a public product page. Without one, customers can reach checkout through a buy link: Copy buy link on each price copies a checkout URL for it.
6. Make a Test Purchase
- Open the product page, or paste the buy link into a browser
- Click Buy Now
- Pay with your gateway's test credentials – Stripe accepts
4242 4242 4242 4242with any future expiry date and CVC - The order, invoice, license and (for recurring prices) subscription appear under Components → LicenseDock
Test orders are marked as test and kept out of the live figures on the Dashboard. Cleanup in the LicenseDock menu deletes them all when you are done.
What Happens on a Successful Payment
- The order is marked completed
- A purchase invoice is issued with the next sequential number
- A license key is generated for each product that requires one
- A subscription is created for recurring prices
- The
purchase_confirmationemail is sent with the invoice PDF attached, andadmin_new_ordergoes to the admin addresses
A guest buyer gets a Joomla account created in the background. The receipt carries the link to set a password for it.
Next Steps
- Plans & Pricing – activation types and billing cycles in detail
- Payment Gateways – Stripe, PayPal and Mollie setup
- API Reference – license checks from your software