Presta-Module Documentation

A/ Rules

B/ Incentives

This tab allows you to define specific promotion rules for subscriptions.

First, select the criteria from which you want to create your discounts:

You have the choice between:

• A discount based on the total of the order
• A discount based on the number of products in the order
• A discount based on the number of orders

You can only choose one criterion at a time. If you change the criterion, the previously created rules will be deleted. However, you can define several rules (several “slices”) for each customer group, and define different discount rules per customer group.

Select a first client group for which you want to create discount rules, then click on “Add this group”:

A tab opens to allow you to configure the discount rules for this customer group.

• If the rule is based on the total of the order: indicate the amount (excl. tax) from which the discount applies, the amount of the discount (or its percentage) and specify if you want to offer delivery. Don’t forget to save.

Example:

In this example, customers of the “Subscribers” group will benefit from a 10% discount from 100€ excl. tax, but not from free delivery.

• If the rule is based on the number of products in the order: indicate the number of products from which the discount applies, the amount of the discount (or its percentage) and specify if you want to offer delivery. Don’t forget to save.

Example:

In this example, the customers of the group “Subscribers” will benefit from the free delivery from 5 ordered products.

• If the rule is based on the number of orders: indicate the order ID from which the discount applies, the amount of the discount (or its percentage) and specify if you want to offer delivery. Don’t forget to save.

Example:

In this example, the customers of the “Subscribers” group will benefit from a 10€ (excl. tax) discount from the 5th order.

Click “Add slice” to add more discount rules for the selected group.

You can also copy rules from one customer group to another, using the “Duplicate in the group” button. This will clone the rules from the current tab to a new tab, corresponding to the newly selected customer group.

Once you have created your incentives rules, you must indicate, through each product file concerned by the subscription, if you authorize the use of these incentives. Indeed, you are not obliged to apply these discounts to all your subscription products. Only those for which you have checked the box “Allow incentives” in the “Subscription” tab will be concerned:

Note that you also have the possibility to take into account the specific prices defined for the product by checking the “Inherit discounts” option:

C/ Subscription frequencies and order creation periods

1. Subscription frequencies

The “Periods and frequencies” tab allows you first to create subscription frequencies. Once these frequencies are created, they will be available in each product file, through the “Subscription” tab. All you have to do is select the ones you want to make available for the product concerned. The choice of subscription frequencies is therefore independent from one product to another.

To create a new frequency, enter a number, select “weeks” or “months” and click “Add this frequency”.

Example of adding a “2 weeks” subscription frequency:

You will see the new frequency appear in the list of available frequencies:

Once your frequencies are created through the module configuration, go to the “Subscription” tab of each product concerned and activate the subscription sale:

If you want this product to be sold on subscription only, check “On subscription only”:

Among the frequencies you have created, check the ones that will be available for the product, then define the one to be selected by default.

Example:

Note: if you have activated the option “Highlight the most selected frequency” in the visual options of the module (see part G/ of this documentation), as soon as you get subscriptions for the product, it will no longer be the frequency defined here “by default” that will be selected on arrival on the product file, but the frequency most used by your customers.

2. Allowed periods for the creation of orders

The second part of the tab “Periods and frequencies” of the module concerns the periods allowed for the creation of orders.

If, for logistical reasons, you want orders to be created only on certain days of the week, or certain months of the year, you can indicate this in the “Allowed periods for order creation” part of the “Periods and frequencies” tab.

Leave checked the days and months during which orders can be created and uncheck the others.

Example:

If you do not want to create orders on Saturdays and Sundays, or during the month of March, uncheck them in the table:

D/ Payment modules

a. Payment module configuration

First of all, please read this FAQ to know more about the different payment modules delivered with “Advanced Subscription”.

“Advanced Subscription” comes with two modules that automatically handle recurring payments: Stripe and PayPlug. The 3 other payment methods offered for subscriptions are extensions of the standard PrestaShop payment modules (“Bank transfer”, “Payments by check”) as well as a cash on delivery module. These 3 standard methods do not support automatic debit (a payment validation action from your customers will be required).

We therefore strongly advise you to use one of the two automatic recurring payment methods: Stripe or Payplug. Creating an account and subscribing to one of their offers is necessary before configuring these payment methods through the module. You can find more information about Stripe’s rates here, and PayPlug’s rates here (please note that in order to use PayPlug’s solution for recurring payments, you will need to subscribe to at least the “Pro” offer).

1. Payment by Stripe 

To configure the Stripe payment module, click on “Enabled” to activate the payment method:

Click on “Configure”:

Choose the public name to associate with this payment method. This is the name that will be displayed to your customers for this payment method in the order tunnel. Indeed, your customers may not know Stripe, so you can simply write “Payment by credit card” for example, to facilitate understanding:

If you want to test subscription payments through Stripe first, select the “development” mode and enter the test keys that are provided to you in your Stripe online account in the “Test Publishable Key” and “Test Secret Key” fields. They must start with “pk_test_” and “sk_test_”:

A pre-configuration of the order statuses that will be applied according to the status of the orders is saved. You can modify it if necessary. Then save the configuration.

When testing, use the test card identifiers provided by Stripe here.

When you want to switch to production mode (the credit cards used for payments will then be actually debited), go back to the Stripe payment module configuration, select the “production” mode and enter your “Live Publishable Key” and “Live Secret Key” (you will also find them in your Stripe account) then click on “Save configuration”.

2. Payment by PayPlug 

To configure the PayPlug payment module, click on “Enabled” to activate the payment method:

Click on “Configure”:

Choose the public name to associate with this payment method. This is the name that will be displayed to your customers for this payment method in the order tunnel. Indeed, your customers may not know PayPlug, so you can simply write “Payment by credit card” for example, to facilitate understanding:

If you want to test subscription payments through PayPlug first, select the “development” mode and enter the test key that is provided to you in your PayPlug online account in the “Test Secret Key” field. It must start with “sk_test_”:

A pre-configuration of the order statuses that will be applied according to the status of the orders is saved. You can modify it if necessary. Then save the configuration.

During your tests, use the test credit card identifiers provided by PayPlug here.

When you want to switch to production mode (the credit cards used for the payments will then be really debited), go back to the PayPlug payment module configuration, select the “production” mode and enter your “Live Secret Key” (you will also find it in your PayPlug account) then click on “Save the configuration”.

3. Cash on Delivery

This payment method allows your subscribers to pay when they receive their order. No third party module configuration is required.

Attention: this payment module does not allow automatic debit.

4. Payment by cheque

This module is an extension of the default PrestaShop module “Payments by check”, allowing you to propose the payment by check as a payment method for subscriptions. Because it is an extension, the configuration of the default module is inherited, which means that the configuration fields of the “Payments by check” module must be filled in for this payment method to work properly.

Attention: this payment module does not allow automatic debit.

5. Bank Wire

This module is an extension of the default PrestaShop module “Bank transfer”, allowing you to propose bank transfer as a payment method for subscriptions. Because it is an extension, the configuration of the default module is inherited, which means that the configuration fields of the “Bank transfer” module must be filled in for this payment method to work properly.

Attention: this payment module does not allow automatic debit.

b. Case of a cart containing only subscriptions with pre-payment

In the case of a shopping cart containing only subscriptions with pre-payment (and potentially products without subscription), you can offer your customers to pay their order with the payment modules configured on your store and not supported by the subscription module. To do so, select the concerned modules in the left column, click on “Add” and save:

These payment methods will not be offered if the cart contains at least one product on subscription without pre-payment.

E/ Prepayment

You have the possibility to allow your customers to pre-pay their subscription over a certain period. This allows you to ensure the payment of orders for a certain period of time and to have a better control of the products’ stocks. To encourage your customers to pay in advance, you can also offer them different types of discounts in exchange.

First of all, you need to create the pre-payment periods you want to make available. You will then be able to select only those you wish to offer for each product independently.

To add a new pre-payment period, enter a number, select “weeks” or “months” and click “Add this period”.

Example of adding a “1 month” pre-payment period:

You will see the new period appear in the list of available pre-payment periods:

Once your pre-payment periods have been created through the module configuration, go to the “Subscription” tab of each product concerned and activate the pre-payment:

If you want to automatically renew the payment for the same pre-payment period, check the “Renew payment automatically” option and select “For the same period” in the “Renewal type” option:

If, on the other hand, you want to automatically renew the payment but, this time, at each shipment (thus no longer activating pre-payment), check the “Renew payment automatically” option and select “At each expedition” in the “Renewal type” option:

Example:

Your customer subscribes to a product with a 2-week renewal frequency. He chooses to pre-pay for 6 months. At the first payment, he will pay for 12 shipments. At the end of the 6 months, you can choose to have him prepay again for 6 months (thus 12 shipments) or to have him pay this time at each shipment (payment of 1 shipment, every 2 weeks).

You can also offer a discount to encourage your customers to pre-pay their subscription. To do this, first select the pre-payment periods you allow for the product, and then specify a discount percentage for each. If you do not want this discount to be cumulative with the incentive rules, select “Only apply discounts due to prepayment”. If, on the other hand, you want to allow cumulation, select “Apply discounts due to prepayment and incentive rules”. In the latter case, you must have configured incentive rules in the module and have activated the “Allow incentives” option at the product level.

Do not forget to save.

Example of pre-payment options on a product page:

F/ CRON task

a. CRON task configuration

In order to automate the creation of orders and the sending of automatic reminder emails to your customers, you need to create an automated task called CRON task, on your server. If you do not have the possibility to create this automated task, you can use an external service. We recommend that you run this automated task on the same web server where your PrestaShop store is installed.

We provide you with its URL to fill in during its configuration:

Attention: If you have activated the multi-shop mode, you must configure a scheduled task for each store (the CRON URL is different for each store).

Schedule your CRON task to run every hour, every day. You can also run this automated task manually by clicking on the “Execute the cron task manually” button:

b. Automated action segmentation

When the CRON task is executed with the URL provided in the module, it performs the following set of actions:

• before_delivery (sending notification emails before renewal)
• order_creation (order creation)
• order_validation (order validation)
• card_validity (credit card validity verification)
• subscribers_group (update of the subscriber group)

If you want to run only one or some of the above actions, you can add at the end of the CRON URL the ?action= parameter followed by the name of the action to be performed. You can cumulate the actions by separating them with a comma.

For example, if you want to run only the order creation, the URL to execute is :

URL_de_CRON?action=order_creation

where URL_de_CRON is the URL provided.

If you want to run only the order creation and the update of the subscriber group, the URL to execute is :

URL_de_CRON?action=order_creation,subscribers_group

G/ Visual options

This tab allows you to manage your display options.

1. Most selected frequency

You have the possibility to indicate to your visitors the most chosen subscription frequency for a product. To do this, activate the “Highlight the most selected frequency” option:

This is the frequency that will be selected by default on the corresponding product page, with the mention “Most selected”:

Note: if there is not yet subscriptions for the product, the frequency you have chosen as the “default” frequency for the product will be highlighted.

2. Tax Rate

Select the tax rate to apply for the calculation of the prices including VAT. You can use the tax rate defined for the product or use a specific rate, among those available in your store.

3. How the subscription details are displayed in the shopping cart

Choose how you want the details of the subscription added to the cart to be displayed through the “Subscription details display in the cart” option:

You can choose to display it in a window, after clicking on a link, or directly in the cart.

Example of a subscription with renewal every 2 weeks and pre-paid for 1 month:

• Display of the subscription details in a window:

• Display of the subscription details directly in shopping cart:

4. Display a “Save time” block

This option allows you to display a text encouraging your customers to subscribe to the product in order to save time. If you activate the option, this “Save time” block will be displayed on all product pages for which subscription is possible. You can define yourself the text to be displayed:

Do not forget to define a text for each language installed on your store.

Example:

5. Display a “Save money” block

This option allows you to display a text encouraging your customers to subscribe to the product in order to save money.

Attention: If you enable the option, the “Save Money” block will only be displayed if you have allowed incentives for the product AND you have defined incentive rules. It will then be displayed on all pages of the relevant products.

You can define yourself the text to be displayed:

Use the string %amount% to display the discount your customer is eligible for (the string %amount% will be dynamically replaced by the module with the discount amount). Don’t forget to define a text for each language installed on your store.

Example:

6. Display a “You do not have any subscription yet” block

This option allows you to display a “You do not have any subscription yet” block on the “My Subscriptions” page, when a customer without any subscription visits this page. You can also select a specific CMS page to display in this block.

Example of the display of the CMS page “About us”:

7. Display products as a grid or list

This option allows you to choose a grid or list view for the products linked to a subscription, within the “My Subscriptions” tab of the customer accounts. Enable the option for a grid view, disable it for a list view:

Here is what the display looks like in grid mode:

and the display in list mode:

I/ Advanced styles (CSS)

The “Advanced Styles” tab allows you to add your own CSS rules to customize your displays.