{"id":543984,"date":"2026-06-22T05:04:12","date_gmt":"2026-06-22T05:04:12","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=543984"},"modified":"2026-06-22T05:04:24","modified_gmt":"2026-06-22T05:04:24","slug":"user-guide-for-subscription-delivery-plugin","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/user-guide-for-subscription-delivery-plugin\/","title":{"rendered":"User Guide For Subscription Delivery Plugin"},"content":{"rendered":"\n
Magento 2 Subscription Delivery Extension lets your store sell catalog products on a recurring delivery schedule. A customer subscribes once on the product page.<\/p>\n\n\n\n
During checkout, they pick their delivery days, delivery shift, and start and end dates.<\/p>\n\n\n\n
A background cron engine then generates each delivery order automatically. Customers manage everything themselves from a My Subscriptions<\/strong> dashboard. <\/p>\n\n\n\n
They can pause, resume, skip a delivery, change quantity, set a vacation hold, or unsubscribe. Admins manage subscriptions, cancellation reasons, and delivery blackout dates from a dedicated admin menu.<\/p>\n\n\n\n
\n
Features of\u00a0Magento 2 Subscription Delivery Extension<\/h3>\n<\/div><\/div>\n\n\n\n
\n
Sell any catalog product on a recurring delivery schedule \u2014 either All Products<\/strong> eligible or Selected Products<\/strong> opted in per product.<\/li>\n\n\n\n
Customer-chosen delivery days<\/strong> (weekday based) and delivery shift<\/strong> (Morning \/ Evening, or admin-defined time slots) selected at checkout.<\/li>\n\n\n\n
Customer-chosen Subscription Start Date<\/strong> and optional End Date<\/strong>, bounded by a configurable future-days window and cut-off hour.<\/li>\n\n\n\n
Automatic recurring order generation via a background cron engine, with optional batch processing<\/strong> and configurable batch size.<\/li>\n\n\n\n
Webkul Stripe Recurring Payment<\/strong> integration with one-click webhook generation and Test\/Live modes.<\/li>\n\n\n\n
Payment-failure handling: automatic retry<\/strong> (max attempts + delay) or mark delivery as failed<\/strong>.<\/li>\n\n\n\n
Per-product or global subscription discount (%)<\/strong> applied to every recurring delivery.<\/li>\n\n\n\n
Subscription-only<\/strong> products (one-time purchase disabled) and a minimum subscription duration<\/strong> before cancellation.<\/li>\n\n\n\n
Customer self-service from My Subscriptions<\/strong>: Pause \/ Resume, Skip \/ Unskip a delivery, edit per-date quantity, Vacation hold, and Unsubscribe with a reason.<\/li>\n\n\n\n
Admin-managed Cancellation Reasons<\/strong> shown to customers at unsubscribe.<\/li>\n\n\n\n
Delivery Blackouts<\/strong> (holidays \/ maintenance days) with a Skip Delivery<\/strong> or Move to Next Available Day<\/strong> shift policy, plus admin override.<\/li>\n\n\n\n
Admin Manage Subscriptions<\/strong> grid + detail view with Force Delivery Today<\/strong> and a per-delivery order generation audit log.<\/li>\n\n\n\n
Subscription reference and scheduled delivery date surfaced on Sales > Orders<\/strong> and order view pages.<\/li>\n\n\n\n
Automatic expiration<\/strong> of subscriptions past their end date via a daily cron.<\/li>\n<\/ul>\n\n\n\n
\n
Installation<\/h3>\n<\/div><\/div>\n\n\n\n
First, customers receive a ZIP folder. Next, they extract its contents on their system.<\/p>\n\n\n\n
The extracted folder has a src<\/strong> folder, inside the src folder, you have the app<\/strong> folder.<\/p>\n\n\n\n
The extracted folder is having an src<\/strong> folder, inside the src folder you have the app<\/strong> folder.<\/p>\n\n\n\n<\/figure>\n\n\n\n
After that, run the following commands from the Magento 2 root directory.<\/p>\n\n\n\n
Multi-Lingual Configuration of Adobe Commerce<\/h3>\n\n\n\n
For Multilingual support, please navigate to Store>Configuration>General >Locale Options<\/strong>. And select your desired language from the Locale <\/strong>option.<\/p>\n\n\n\n<\/figure>\n\n\n\n
Language Translation<\/h3>\n\n\n\n
For translating the module language, navigate through the app\/code\/Webkul\/SubscriptionDelivery\/i18n<\/strong> and edit the en_US.csv file.<\/p>\n\n\n\n
Thereafter, rename the CSV as \u201cen_SA.csv\u201d and translate all right side content after the comma in the Arabic language. After editing the CSV, save it.<\/p>\n\n\n\n<\/figure>\n\n\n\n
Now, upload it to the path app\/code\/SubscriptionDelivery\/i18n,<\/strong> where the installation of Magento 2 is on the server.<\/p>\n\n\n\n
\n
Admin Configuration of Subscription Delivery Extension<\/h3>\n<\/div><\/div>\n\n\n\n
Navigate to Stores > Configuration > Webkul > Subscription Delivery<\/strong>. The configuration splits into the sections below.<\/p>\n\n\n\n<\/figure>\n\n\n\n
\n
General Settings:<\/h3>\n<\/div><\/div>\n\n\n\n
\n
Enable Module<\/strong> \u2014 global on\/off toggle for the whole module. The admin menu appears only when this is Yes<\/strong>.<\/li>\n\n\n\n
Subscription Applicability<\/strong> \u2014 All Products<\/strong> (every product is subscribable) or Selected Products<\/strong> (opt in per product on the catalog edit page).<\/li>\n\n\n\n
Default Subscription Status<\/strong> \u2014 initial status for new subscriptions: Active<\/strong>, Paused<\/strong>, Unsubscribed<\/strong> or Expired<\/strong>.<\/li>\n\n\n\n
Global Minimum Subscription Duration (Days)<\/strong> \u2014 minimum days before a customer may cancel; per-product value overrides it.<\/li>\n<\/ul>\n\n\n\n
\n
Delivery and Scheduling<\/h3>\n<\/div><\/div>\n\n\n\n
\n
Max Future Days<\/strong> \u2014 how far ahead the delivery calendar is visible.<\/li>\n\n\n\n
Allow Same-Day Delivery<\/strong> \u2014 permit a same-day start if ordered before the cutoff hour (default No<\/strong>).<\/li>\n\n\n\n
Cutoff Hour (0-23)<\/strong> \u2014 daily time after which the next period is locked.<\/li>\n\n\n\n
Cutoff Timezone<\/strong> \u2014 reference timezone for cutoff calculations.<\/li>\n\n\n\n
Delivery Time Slots<\/strong> \u2014 define Start Time<\/strong> \/ End Time<\/strong> rows via Add Time Slot<\/strong>. If left empty, Morning<\/strong> \/ Evening<\/strong> defaults are used.<\/li>\n<\/ul>\n\n\n\n
\n
Calendar and Skip Rules<\/h3>\n<\/div><\/div>\n\n\n\n
\n
Allow Skip Delivery<\/strong> \u2014 let customers skip a specific delivery date.<\/li>\n\n\n\n
Allow Unskip<\/strong> \u2014 let customers reverse a skip before the date\/cutoff.<\/li>\n\n\n\n
Skip Allowed Before Cutoff<\/strong> \u2014 restrict skip\/unskip to before the cutoff hour.<\/li>\n\n\n\n
Vacation Mode Enabled<\/strong> \u2014 allow customers to pause all deliveries for a date range.<\/li>\n\n\n\n
Max Vacation Duration (Days)<\/strong> \u2014 maximum consecutive vacation days allowed.<\/li>\n<\/ul>\n\n\n\n
Delivery Blackouts<\/h3>\n\n\n\n
\n
Enable Blackouts<\/strong> \u2014 turn on the global blackout system for holidays \/ maintenance days.<\/li>\n\n\n\n
Default Shift Policy<\/strong> \u2014 Skip Delivery<\/strong> or Move to Next Available Day<\/strong> when a delivery lands on a blackout date.<\/li>\n\n\n\n
Allow Admin Override<\/strong> \u2014 let admins force deliveries on blackout dates. This flag also controls the Force Delivery Today<\/strong> button.<\/li>\n<\/ul>\n\n\n\n
Cron and Processing<\/h3>\n\n\n\n
\n
Daily Cron Time<\/strong> \u2014 time each day the renewal engine starts.<\/li>\n\n\n\n
Enable Batch Processing<\/strong> \u2014 split large subscription lists into batches.<\/li>\n\n\n\n
Batch Size<\/strong> \u2014 subscriptions processed per batch.<\/li>\n\n\n\n
Generate Webhook<\/strong> \u2014 one-click button that registers a webhook in your Stripe account for invoice.payment_succeeded<\/code>, invoice.payment_failed<\/code>, customer.subscription.deleted<\/code> and customer.subscription.updated<\/code>. Once generated, the button is disabled with the title Webhook already generated<\/strong>.<\/li>\n<\/ul>\n\n\n\n
Per-Product Subscription Settings<\/h3>\n\n\n\n
Open Catalog > Products<\/strong>, edit a product, and expand the Subscription Settings<\/strong> group. The setup patch adds these attributes:<\/p>\n\n\n\n<\/figure>\n\n\n\n
\n
Allow Subscription<\/strong> \u2014 make this product subscribable (required when applicability is Selected Products<\/strong>).<\/li>\n\n\n\n
Subscription Allowed Days<\/strong> \u2014 weekdays customers may choose for this product.<\/li>\n\n\n\n
CUSTOMER WORKFLOW of Subscription Delivery<\/h3>\n<\/div><\/div>\n\n\n\n
Choose a subscription on the product page<\/h3>\n\n\n\n
On a subscribable product, the customer sees a notice such as “This product is available for subscription.”<\/strong> (or “This product is available for subscription only.”<\/strong>).<\/p>\n\n\n\n
When a discount applies, they also see “Get X% OFF on every recurring delivery!”<\/strong>. The product page offers two options: One-time Purchase<\/strong> (default) and Subscribe Product<\/strong>. <\/p>\n\n\n\n
Selecting Subscribe Product<\/strong> changes the button text to Add to Subscribe<\/strong>. Subscription requires a logged-in account.<\/p>\n\n\n\n<\/figure>\n\n\n\n
Review the cart<\/strong><\/h2>\n\n\n\n
The cart flags subscription items. A subscription cart cannot contain normal products. <\/p>\n\n\n\n
Magento 2 Subscription Delivery Extension blocks mixing with the message\u00a0“Subscription products cannot be added to a cart with normal products. Please clear your cart first.”<\/strong><\/p>\n\n\n\n<\/figure>\n\n\n\n
Set the delivery schedule at checkout<\/h3>\n\n\n\n
A dedicated Subscription Delivery Schedule<\/strong> step appears during checkout. The customer completes:<\/p>\n\n\n\n
\n
Select Delivery Days<\/strong> \u2014 weekday checkboxes (Mon\u2013Sun), at least one required.<\/li>\n\n\n\n
Subscription Start Date<\/strong> \u2014 required; bounded by the cutoff and Max Future Days<\/strong>.<\/li>\n\n\n\n
Subscription End Date (Optional)<\/strong> \u2014 must respect the minimum duration if set.<\/li>\n<\/ul>\n\n\n\n<\/figure>\n\n\n\n
Pay with Webkul Stripe Recurring Payment<\/h3>\n\n\n\n
At the payment step the customer selects Webkul Stripe Recurring Payment<\/strong> and enters card details in the embedded Stripe card field. <\/p>\n\n\n\n
Placing the order tokenizes the card and authorizes the first payment.<\/p>\n\n\n\n<\/figure>\n\n\n\n
Order success<\/h3>\n\n\n\n
The success page confirms “Your subscription has been successfully created.”<\/strong> with the subscription order number and a note that renewal details follow by email. <\/p>\n\n\n\n
The order placement creates the subscription record and seeds the first delivery in the audit log.<\/p>\n\n\n\n<\/figure>\n\n\n\n
Manage from My Subscriptions<\/h3>\n\n\n\n
The customer opens My Account > My Subscriptions<\/strong>. <\/p>\n\n\n\n
![\"Installation](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/02\/1-9-1200x379.webp\")
<\/figure>\n\n\n\n![\"Multi](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/02\/userguide21.webp\")
<\/figure>\n\n\n\n![\"Tanslation](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/02\/traslation.webp\")
<\/figure>\n\n\n\n![\"alt-01-admin-configuration\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/06\/01-admin-configuration.webp\")
<\/figure>\n\n\n\n\n![\"alt-02-admin-stripe-payment-config\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/06\/02-admin-stripe-payment-config.webp\")
<\/figure>\n\n\n\n![\"alt-03-admin-product-subscription-settings\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/06\/03-admin-product-subscription-settings.webp\")
<\/figure>\n\n\n\n![\"alt-04-admin-menu\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/06\/04-admin-menu.webp\")
<\/figure>\n\n\n\n\n![\"alt-05-storefront-product-subscription-options\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/06\/05-storefront-product-subscription-options.webp\")
<\/figure>\n\n\n\n![\"alt-shopping](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/06\/06-storefront-cart-subscription-item.webp\")
<\/figure>\n\n\n\n![\"alt-07-checkout-schedule-step\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/06\/07-checkout-schedule-step.webp\")
<\/figure>\n\n\n\n![\"alt-08-checkout-payment-stripe\"](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/06\/08-checkout-payment-stripe.webp\")
<\/figure>\n\n\n\n![\"alt-order](\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2026\/06\/09-order-success.webp\")
<\/figure>\n\n\n\n