Installation

Requirements

• CS-Cart or CS-Cart Multi-Vendor 4.17.2 – 4.21.x.
• PHP 7.4 – 8.3, as supported by your CS-Cart version.
• MySQL/MariaDB with InnoDB (the add-on uses named locks and unique keys for safe renewals).
• A cron job (recommended): the billing pass sends reminders and creates renewal orders. Without it, the add-on starts a pass after an admin page is served, at most every 5 minutes; a real cron is better.

Install

1. Go to Add-ons → Manage add-ons, click + and upload kv_subscriptions-1.0.0.zip.
2. Find Subscriptions & Recurring Orders and click Install.
3. Enter your license key in Settings → License (or the CS-Cart Marketplace license number in Add-ons → Manage add-ons).
4. Add the cron job shown in Settings → Cron (every 10 minutes):

*/10 * * * * php /path/to/store/admin.php --dispatch=kv_subscriptions.cron

or call the secret URL shown on the same page. 5. Open Orders → Subscriptions → Plans, add a plan and assign products to it.

What the installation creates

• Six tables with the prefix kv_sub_ (plans, plan products, subscriptions, items, cycles, log).
• Five editable e-mail templates (Design → E-mail templates): subscription started, renewal reminder, payment link, payment failed, subscription cancelled.
• The menu item Orders → Subscriptions (and in the vendor panel of Multi-Vendor).
• A My subscriptions link in the account menu of the storefront.

Nothing is changed in the core files.

Privileges

Administrators need View orders to see the pages and Manage orders to act, like the rest of the order management. In Multi-Vendor, vendors can use the dashboard, the list, the plans and the actions for their own subscriptions; the billing pass is closed to vendors.

Upgrading

Upload the new package over the installed add-on (or use the Upgrade Center). Plans, subscriptions, cycles and history are kept; missing tables, settings and texts are added automatically on the next admin page view.

Disabling and uninstalling

• Disable: the product page box and the plan discounts are switched off, no reminders or renewal orders are created. Existing subscriptions stay in the database.
• Uninstall: removes the add-on tables, settings, language variables and e-mail templates. Orders that were created by renewals stay in the store.

Tested on

The test matrix of this release is listed in the CHANGELOG and in the add-on’s compat-4.21.md rows; only stores that really ran the suites are named there.