eCommerce Setup Guide
Knowledge Anywhere ecommerce is powered primarily by Recurly, a third-party billing and subscription management platform. Recurly securely handles payments, coupons, and invoicing, while the Knowledge Anywhere LMS manages course access and learner enrollment.
How the Recurly Integration Works
To enable ecommerce in the Knowledge Anywhere LMS:
-
Your organization must have an active Recurly account - the Starter Plan is sufficient for feature usage.
-
Recurly must be configured correctly for LMS ecommerce.
-
A Recurly API key must be securely shared with Knowledge Anywhere.
-
Discount and coupon settings must match Knowledge Anywhere requirements.
Once configured, learners can:
-
Purchase courses
-
Apply discount codes at checkout
-
Receive automatic enrollment after payment
Required Information to Get Started
Before Knowledge Anywhere can enable ecommerce, you must provide:
-
Your Recurly site name
-
Your Recurly environment (production or sandbox)
-
A Private API Key from Recurly
-
Confirmation that coupon settings are configured correctly
This information is sent securely to Knowledge Anywhere Support, who completes the final integration.
Obtaining Your Recurly API Key
Knowledge Anywhere uses a Private API Key from Recurly to securely communicate with your ecommerce environment.
Steps to generate your API key:
-
Log in to your Recurly Admin Console
-
Navigate to Configuration → API Credentials
-
Under Private API Keys, either:
-
Use the Default API Key, or
-
Click Add Private API Key to generate a new one
-
-
Copy the Private API Key
-
Send the API key securely to Knowledge Anywhere Support
⚠️ Important: Private API keys should be treated like passwords. Do not share them publicly or store them in unsecured locations.
Sending Your Configuration to Knowledge Anywhere
Once the following are complete:
-
Recurly account is active
-
API key has been generated
-
Coupon settings match the required configuration
Send the following to Knowledge Anywhere Support:
-
Recurly site name
-
Private API key
-
Confirmation that coupon settings are enabled as shown above
After verification, Knowledge Anywhere will:
-
Enable ecommerce in your LMS
-
Complete backend configuration
-
Confirm when ecommerce is ready for use
Course Pricing
The actual price of the course can be implemented in the configuration
Coupon Code Configuration
Discount codes in Recurly must be configured in a very specific way to work correctly with the Knowledge Anywhere LMS.
Major Code Settings
Multiple Coupons Per Account
This setting must be enabled.
-
Allows multiple coupon redemptions on a single account
-
Ensures discounts are applied correctly on invoices
Order of Application
Select:
-
Apply percentage first
This ensures percentage discounts are applied before fixed-amount discounts.
Multiple Percentage Discounts
Select:
-
Apply to full line item amount
This ensures all percentage discounts apply to the original price, not a discounted subtotal.
One-Time Charges Configuration
Select:
-
Enable One-Time Charges
One-time charges are a single course within the LMS
Code Configuration Settings
Required Coupon Rules:
Internal Name
-
Used for internal reference only
-
This name is not shown to learners
Coupon Code
-
This is the code learners will enter at checkout
-
Codes are case-sensitive, spaces are not recommended
-
Example:
SPRING25
Discount Type
-
Percentage-based discounts are recommended
-
Example:
25% -
Fixed-amount discounts may be used, but must follow global coupon settings (percentage-first application)
Duration
-
Set the discount duration based on your pricing strategy
- Duration determines how long the discount applies after redemption
Redemption Rules (Must Match Exactly)
To ensure discount codes work properly with Knowledge Anywhere ecommerce, coupons must be created using the exact configuration outlined below. Deviating from these settings may result in discounts not applying correctly or learners being unable to redeem coupons at checkout.
Maximum Redemptions (Across All Customers)
-
Unlimited
This allows the coupon to be reused across multiple customers without restriction.
Redemptions Per Account
-
Unlimited
This ensures the coupon can apply correctly even when multiple eligible items or renewals exist.
Redeem By
-
Anytime
Do not restrict coupons to a specific expiration date unless absolutely required.
Eligible Charges (Critical Setting)
Eligible Charges
-
One-time charges, All plans
This ensures coupons apply to Individual course purchases
Discount Level
-
Account
Coupons must be applied at the Account level to work with The Knowledge Anywhere LMS's ecommerce logic.
Coupon Descriptions (Optional but Recommended)
Payment Page Description
-
Displays on the checkout page
-
Helps learners understand the discount they are receiving
Invoice Description
-
Displays on the invoice and receipt
-
Useful for billing clarity and reporting
PayPal
If your site has eCommerce enabled, you can optionally allow learners to pay using PayPal during checkout. PayPal is controlled by a separate site option called Enable PayPal and requires PayPal credentials to be configured by Customer Success.
Prerequisites
-
eCommerce must be enabled for your site.
-
You must have permissions to modify site options.
Steps
-
Go to Admin → Site Options.
-
Confirm eCommerce is enabled.
-
If eCommerce is disabled, the Enable PayPal option will not appear.
-
-
Locate Enable PayPal.
-
This toggle is available only when eCommerce is enabled.
-
Default setting is OFF.
-
-
Switch Enable PayPal to ON.
- Select the currencies you wish to use
-
Click Save to store all Site Options values on the page.
To complete PayPal setup, the following values must be provided in order to enable PayPal for your site:
-
PayPal ClientId
-
PayPal Secret
Without these credentials, PayPal cannot be used successfully during checkout even if the toggle is enabled.
Note: PayPal does not allow for Discount Codes
For learners: Paying with PayPal at checkout
When PayPal is available
PayPal appears as a payment option only when both of these are enabled on the site:
-
eCommerce enabled
-
Enable PayPal enabled
PayPal checkout flow
-
Add a paid course to your cart and start checkout.
-
In the Select Method step, click PayPal.
-
A PayPal popup opens.
-
PayPal may show an additional confirmation step depending on the account or transaction.
-
-
Complete the PayPal steps in the popup.
-
After PayPal finishes, checkout advances to the Finished step.
What learners will see on the Finished step
Under the Finished step on the Checkout screen:
-
The payment method shows “Paid by PayPal” (instead of credit card details).
-
Billing address information may not be available, depending on what PayPal returns for the transaction.
For more information on eCommerce or if you wish to enable it for your Knowledge Anywhere LMS, please reach out to our team at support@knowledgeanywhere.com