Configuration
Plans (Orders → Subscriptions → Plans)
Section titled “Plans (Orders → Subscriptions → Plans)”| Field | Meaning |
|---|---|
| Name, description | Shown on the product page, in the account and in e-mails. |
| Every n days / weeks / months / years | The billing interval. Dates are calculated in the shop time zone; a monthly plan started on the 31st renews on the last day of shorter months and on the 31st again afterwards. |
| Number of deliveries | 0 = until the customer cancels. The first order counts as delivery 1; the subscription is completed after the last one. |
| First renewal after (trial days) | If set, the first renewal is due this many days after the first order instead of after one interval. |
| Subscription discount | Percent, or a fixed amount per item, taken off the catalog price in every order of the subscription. |
| First-order discount | Replaces the subscription discount on the first order only. 100% gives the first order for free (a free trial). |
| Customers can pause / skip | Switches for the customer account; “max skips in a row” limits skipping (0 = unlimited) and resets after each delivery. |
| Reminder before renewal | Days; 0 uses the store setting. |
| Products | Products that can be bought with the plan. A vendor can pick only their own products. |
Changing a plan does not change subscriptions that already exist: each subscription keeps a copy of the plan terms. A plan that has subscriptions is disabled instead of deleted.
If a product has several plans (for example “every month” and “every 2 weeks”), the customer can switch between those plans in the account; this is the “change frequency” feature.
Settings (Add-ons → Manage add-ons → Subscriptions & Recurring Orders)
Section titled “Settings (Add-ons → Manage add-ons → Subscriptions & Recurring Orders)”| Setting | Meaning |
|---|---|
| Activate a subscription when its first order is | Paid: when the order reaches a status marked “payment received” (Processed and Complete by default). Open or paid: also when the order is open, for cash on delivery or bank transfer stores. |
| Renewals for offline payment methods | Create the order automatically (default) or Pay link: every customer pays each cycle through the checkout. |
| Renewal reminder (days before) | Default 5. 0 turns reminders off. |
| Payment reminders (days after the due date) | Comma separated, default 1,3,7: when the customer did not pay, a pay-link reminder goes out on these days. |
| Abandoned payment timeout (days) | Default 3. A renewal order that stays Incomplete this long (the customer left the payment page) is set to Failed and the cycle returns to the payment reminders. |
| When the reminders are used up | Cancel the subscription (default) or pause it. |
| Cancel and manage with the signed link | Lets the link in e-mails open the subscription page and cancel it without a login. |
| Quantity, swap, frequency, address | Switches for the customer account. |
| Largest quantity per line | Default 20. |
| Key information line | A plain sentence with the frequency and how to cancel, shown in e-mails and on the account page. |
| Subscriptions per cron run | Default 50. The rest is processed in the next run. |
| Run from admin page views | Fallback when no cron is configured. |
The billing pass does four things in order: renewal reminders, renewal orders and pay links for subscriptions that are due, payment reminders, and the final cancel / pause. It is safe to run more often than needed and safe to start twice at once (a MySQL lock lets one run proceed, and every cycle has a unique row).
*/10 * * * * php /path/to/store/admin.php --dispatch=kv_subscriptions.cronE-mails
Section titled “E-mails”Design → E-mail templates: kv_subscriptions_started, _reminder, _pay_link, _failed, _cancelled. The texts of the sentences live in the language variables (Administration → Languages → Translations, search “kv_subscriptions.mail”). The e-mail template variables are title, intro, items, details, button_url, button_label, outro, key_info, manage_url, cancel_url.
Vendors
Section titled “Vendors”In Multi-Vendor a vendor sees Orders → Subscriptions in the vendor panel, creates plans for their own products and manages the subscriptions whose order belongs to their company. Vendors cannot start the billing pass. Marketplace-wide plans (created by an administrator without a company) can be assigned to any product by the administrator.