SUB: Configuration Guide

Owned by Artur Petrov (Deactivated)
Last updated: Mar 30, 2023 by Dev Team
15 min read

 

 

General: General

Extension Version

The current version of our product. We may ask you for this number if you ever have any issues and engage with us via PowerSync Helpdesk.

Enable Subscriptions

The master shut-off switch. Must be enabled if you want to leverage all the features and functionality of the product.

Turn On mPower Subscriptions

  • Go to Magento Admin panel - mPower - (Configuration) - General

  • Set Enable Subscriptions option to Enable

  • Go to Catalog - All Products - Edit product

  • Scroll to the end of the page and check the Subscription Options tab is available

  • Go to Magento Frontend - open subscription product page - check subscription option available

Turn Off mPower Subscriptions

  • Go to Magento Admin panel - mPower - (Configuration) - General

  • Set Enable Subscriptions option to Disable

  • Go to Catalog - All Products - Edit product

  • Scroll to the end of the page and check the Subscription Options tab is missing

  • Go to Magento Frontend - open subscription product page - check subscription option are not available

 

Allow edit in cart

Allows your shoppers to subscribe to products and modify recurring purchases directly from the shopping cart.

  • Go to Magento Admin panel - mPower - (Configuration) - General

  • Set Enable Subscriptions option to Enable

  • Set Allow edit in cart option to Yes

  • Go to Magento Frontend and add subscription product Cart

  • Click on Cart icon - View and Edit Cart link

  • check subscription options are available in the shopping cart

  • Go to Magento Admin panel - mPower - (Configuration) - General

  • Set Enable Subscriptions option to Enable

  • Set Allow edit in cart option to No

  • Go to Magento Frontend and add subscription product Cart

  • Click on Cart icon - View and Edit Cart link

  • check subscription options are not available

Disable Cron

Disable or enable MPOWER notification cron jobs

General: Advanced

 

Enable File

Mainly used for debugging purposes. If enabled, all activities by the product will be logged in the file specified in the description under the dropdown.

DB Logging

Mainly used for debugging purposes. If enabled, all activities by the product will be logged in the database and these logs can be viewed via the Magento Admin interface.

DB Log Limit

Allows you to specify how many log entries should the DB hold before purging old records.

Log Object Depth

Allows controlling how deep the log should go into the nested objects.

 

Notifications: Notifications

Renewals

The number of days before sending the customer an email notification to inform of the upcoming renewal.

Expired Card

Magento will send a notification email to the customer X days prior to the renewal asking them to update their credit card.

Notifications: Comment Add Setting

Send Subscription Profile Comment Add

Turn On sending of public comment added to the subscription profile

Subscription Profile Comment Add

A template used to email the customer when a new public comment is added to the subscription profile.

Send Comment Add Email Copy To

Allows you to define “Copy to” customers for Send Comment Add Emails

Send Comment Add Email Copy Method

Allows you to select Bcc or Separate Emails Copy Method

  • Go to Magento Admin panel - mPower - (Configuration) - Notifications

  • Set Send Subscription Profile Comment Add option to Yes

  • Select Subscription Profile Comment Add email template

  • Go to Magento Frontend and add subscription product Cart

  • Click on Cart icon and place order

  • Go to Magento Admin panel – Sales – (Recurring) – Subscriptions

  • Click Edit link on created Subscriptions – Change History tab

  • Type some comment and click Add comment button

  • Check Email box

Notifications: Status Change Setting

Send Subscription Profile Status Change

Turn On sending of Status Change email

Subscription Profile Status Change

A template used to email the customer when a subscription profile status changes.

Send Status Change Email Copy To

Allows you to define “Copy to” customers for Status Change Email

Send Status Change Email Copy Method

Allows you to select Bcc or Separate Emails Copy Method

  • Go to Magento Admin panel - mPower - (Configuration) – Notifications

  • Set Status Change Setting option to Yes

  • Select Subscription Profile Status Change email template

  • Go to Magento Frontend and add subscription product to Cart

  • Click on Cart icon and place order

  • Go to Magento Admin panel – Sales – (Recurring) – Subscriptions

  • Click Edit link on created Subscriptions – Place On Hold (for ex) button

  • Check Email box

Notifications: Card Expire Setting

Send Subscription Profile Card Expire

Turn On sending of Profile Card Expire email

Subscription Profile Card Expire

A template used to email the customer when the credit card on file is set to expire before the next recurring order

Send Card Expire Email Copy To

Allows you to define “Copy to” customers for Card Expire Email

Send Card Expire Email Copy Method

Allows you to select Bcc or Separate Emails Copy Method

  • Go to Magento Admin panel - mPower - (Configuration) – Notifications

  • Set Send Subscription Profile Card Expire to Yes

  • Select Subscription Profile Card Expire email template

  • Go to Magento Frontend and add subscription product Cart

  • Place order with online payment method (cart should expire soon)

  • Check Email box

Notifications: Payment Failed Setting

Send Subscription Profile Failed

Turn On sending of Subscription Profile email

Subscription Profile Failed

A template used to email the customer when Magento was unable to process the card on file.

Send Payment Failed Email Copy To

Allows you to define “Copy to” customers for Payment Failed Email

Send Payment Failed Email Copy Method

Allows you to select Bcc or Separate Emails Copy Method

Notifications: Renewal Setting

Send Subscription Profile Renewal

Turn On sending of Subscription Profile Renewal email

Subscription Profile Renewal

A template used to email the customer notifying them about an upcoming recurring order.

Send Renewal Email Copy To

Allows you to define “Copy to” customers for Renewal Email

Send Renewal Email Copy Method

Allows you to select Bcc or Separate Emails Copy Method

Notifications: Out Of Stock Setting

Send Subscription Profile Out Of Stock Notification

Turn On sending of Subscription Profile Out Of Stock Notification email

Subscription Profile Out Of Stock Notification

A template used to email the customer if a product for an upcoming recurring order is out of stock.

Send Out Of Stock Email Copy To

Allows you to define “Copy to” customers for Out Of Stock Email

Send Out Of Stock Email Copy Method

Allows you to select Bcc or Separate Emails Copy Method

Subscription Profiles: General

 

Profile Product Price

  • Dynamic (best value) - product price will be automatically re-calculated when the customer or admin user makes changes to the quantity of the existing subscription. Only Product price decreases will affect the update of the subscription prices. Product price increases will be ignored.

  • Dynamic (full) - product price will be automatically re-calculated when the customer or admin makes changes to the quantity of the existing subscription. Product price may increase or may decrease, both actions will adjust the subscription price.

  • Grandfathered - product price is grandfathered and will not change for existing profiles when orders are created even if the product price changes in the catalog for new customers.

Let's say you are selling milk to your customers. John Smith subscribed to receive a gallon of milk every week for $2.49. Several months later, you cannot afford to sell this product for that amount and need to raise the price and you change the price to $2.69.

  • If Grandfathered Price is selected, John Smith will continue to pay $2.49 until he cancels.

  • If Dynamic (full) is selected, John Smith will be charged $2.69 automatically on the next renewal if modify qty of the existing subscription (product price may increase or decrease)

  • If Dynamic (best value) is selected, John Smith will continue to pay $2.49 until he cancels (Only Product price decreases will affect the update of the subscription price)

Shipping Fallback

Let’s say you have offered USPS as a shipping method. John Smith subscribes to products and chooses USPS duing checkout. Your business pivots and you no longer offer USPS as a shipping method.

  • If Pick the cheapest available is selected - Magento will pick the cheapest option available and substitute it for that renewal.

  • if Use the Default is selected - Magento will force the default shipping method you specify. See the Default Shipping Method section.

Default Shipping Method

Allows setting default shipping method to be used in the Shipping Fallback configuration (see above).

Free Shipping

Let’s say you have a rule offering your customers to pick a FREE Shipping if the order amount is over $50. John Smith places his initial order buying six different products and subscribing to one of them. The total order amount is $52.00 and the subscription is for $5.00 every week. John Smith chooses FREE Shipping when placing the order. When the renewal takes place, the order is $5.00 and FREE shipping is no longer available.

  • If Honor Magento free shipping is selected - The renewal will use FREE shipping to process the renewal.

  • If Substitute with an alternate is selected - Magento will automatically subsctitute the shipping method selected in the Shipping Fallback configuration (see above).

Subscription Profiles: Past Due

Attempt Count - The number of payment attempts prior to changing the status of the subscription profile to “Suspended”.

Attempt Interval - If a payment fails for any reason, Magento will re-try the payment in the number of days specified in this field.

Grace Period - If all attempts to collect the payment during the grace period fail, the subscription profile will go into "Suspended" status.

Subscription Profiles: Email Config

Email Sender

All email notifications for recurring orders will come from this email address.

Products: General

The list of default options to apply when creating or importing new products into the Magento catalog.

Available For

Specifies if products should be available for a one-time purchase, as a subscription, or both.

  1. One -Time Purchase Only

  • Go to Magento Admin panel - Catalog -Products – Edit subscription product

  • Scroll to the end of the page and expand the Subscription Options tab

  • Set Available For the option to One -Time Purchase Only

  • Go to Magento Frontend - open subscription product page

2. Recurring Purchase only

  • Go to Magento Admin panel - Catalog -Products – Edit subscription product

  • Scroll to the end of the page and expand the Subscription Options tab

  • Set Available For the option to Recurring Purchase only

  • Go to Magento Frontend - open subscription product page

3. One-Time and Recurring

  • Go to Magento Admin panel - Catalog - Products – Edit subscription product

  • Scroll to the end of the page and expand the Subscription Options tab

  • Set Available For the option to One -Time and Recurring

  • Go to Magento Frontend - open subscription product page

Start Date

Allows you, as a merchant, to control when the recurring order starts for your customers.

Available Start Date option:

  1. Moment of purchase

  2. Defined by customer

  3. On the last day of the month

  4. First day of the month

  5. 15th of every month

How Defined by customer Option works:

  • Go to Magento Admin panel - Catalog - Products – Edit subscription product

  • Scroll to the end of the page and expand the Subscription Options tab

  • Click in Manage button

  • Select Defined by customer from the “Start Date“ drop-down list

  • Go to Magento Frontend - open subscription product page

  • Click on the Change link under the Delivery Schedule section

  • Select the Start date and click the Update button

Lock Product Price

Mainly used for products where the product price remains the same for every billing frequency (eg. physical goods) or if the product price varies (eg. an hourly service, or a software license).

  • Go to Magento Admin panel - Catalog - Products – Edit subscription product

  • Scroll to the end of the page and expand the Subscription Options tab

  • Click in Manage button

  • Set Lock Product Price option to Yes

  • Click Next button

  • Go to Magento Admin panel - Catalog - Products – Edit subscription product

  • Scroll to the end of the page and expand the Subscription Options tab

  • Click in Manage button

  • Set Lock Product Price option to No

  • Click Next button

Unlock Preset Quantity

The product quantity will be preset for a customer and a customer cannot change product quantity when buying products. Example: Selling a monthly magazine subscription billed annually.

  • Go to Magento Admin panel - Catalog - Products – Edit subscription product

  • Scroll to the end of the page and expand the Subscription Options tab

  • Click in Manage button

  • Set Unlock Preset Quantity option to Yes

  • Click Next button

  • Go to Magento Admin panel - Catalog - Products – Edit subscription product

  • Scroll to the end of the page and expand the Subscription Options tab

  • Click in Manage button

  • Set Unlock Preset Quantity option to No

  • Click Next button

Savings Calculation

Used for service-based products. IMPORTANT: Will be departed in the near future.

Infinite Subscriptions

The recurring orders will continue unless the customer places the subscription on hold OR cancels.

  • Go to Magento Admin panel - Catalog - Products – Edit subscription product

  • Scroll to the end of the page and expand the Subscription Options tab

  • Click in Manage button

  • Set Infinite Subscriptions option to Yes

  • Go to Magento Frontend - open subscription product page

  • Check that customer is not able to change qty of payments

  • Go to Magento Admin panel - Catalog - Products – Edit subscription product

  • Scroll to the end of the page and expand the Subscription Options tab

  • Click in Manage button

  • Set Infinite Subscriptions option to No

  • Go to Magento Frontend - open subscription product page

  • Check that customer can change qty of payments

Products: Discount

IMPORTANT: This option is only available only if the Lock Product Price option is enabled for the product.

 

Offer Flat Discount

The default catalog setting for the product to determine if a flat discount is offered to customers when they choose to receive that product on a recurring basis.

Discount Amount

The default catalog setting for the product discount in the catalog when the product is purchased on a recurring basis. Allows you to preset a specific amount when creating new products.

Discount Type

Refers to the Discount Amount field and controls if the Discount Amount is a percentage or a flat currency value. Allows you to preset a specific amount when creating new products.

  • Go to Magento Admin panel - Catalog - Products – Edit subscription product

  • Scroll to the end of the page and expand the Subscription Options tab

  • Click in Manage button

  • Set Lock Product Price option to Yes

  • Set Offer Flat Discountoption to Yes

  • Set Discount Amount to 10 (for ex)

  • Ser Discount Type to Percent (for ex)

  • Go to Magento Frontend - open subscription product page and check the price difference

Products: Trial

Is Trial Offered

The default setting that controls if the product you are selling has a trial period.

Is Trial Static Pre-Auth

Controls the amount of money you want to change the customer when they are signing up for the trial.

  • If disabled - the customer will be billed upfront for the whole trial duration

  • If enabled - the customer will be billed the amount specified in the Trial Pre-Auth Amount configuration setting (if the trial is free, for example).

Trial Length

The default catalog setting for the product trial length in the catalog. Allows you to preset a specific amount when creating new products.

Trial Length Unit

Refers to the Trial Length configuration value. This is also the default catalog setting for the product trial length unit in the catalog. Allows you to preset a specific amount when creating new products.

Trial Price

This is the default catalog setting for the product trial price unit in the catalog. Allows you to preset a specific amount when creating new products.

Trial Pre-Auth Amount

The amount to be billed to validate the credit card.

Trial Start Date

This is the default catalog setting for the product trial start date in the catalog. Allows you to preset this value when creating new products.

  • Go to Magento Admin panel - Catalog - Products – Edit subscription product

  • Scroll to the end of the page and expand the Subscription Options tab

  • Click in Manage button

  • Set Is Trial Offered option to Yes

  • Set Trial Can Be Skipped option to Yes

  • Trial Length to 15

  • Trial Price to 15

  • Trial Start Date to Moment of purchase

  • Go to Magento Frontend - open subscription product page and check trial option

  • place order with a trial subscription

  • Go to My Account - My Subscriptions - Edit subscription

Payment methods: Available Payment Methods

The list below includes all supported Magento payment methods which are enabled in your Magento setup. You will be able to specify which of available and supported payment methods you would want to allow for recurring orders.

In the example above we are allowing all enabled and supported payment methods, but not the Authorize.net CIM.

ATTENTION: At least one of the payment methods should be active to correct subscription options configuration in products.

Customer Settings: Subscription Profiles Settings

Can Place On Hold

This setting controls if a customer can place orders on hold.

Example: If a customer has a monthly subscription for 1 pack of 250 paper plates, but it happens that they have not used all the plates yet and they can go another month w/o getting a new order. The customer can then log into their Magento subscription dashboard and place their recurring orders on hold. Then, they can re-activate next month without any interruptions to the service. 

  • Go to Magento Admin panel - mPower - (Configuration) - Customer Settings - Subscription Profile Settings tab

  • Set Can Place On Hold option to Yes

  • Go to Magento Frontend - My Account - My Subscriptions

  • or click the Edit button on some subscription

  • Go to Magento Admin panel - mPower - (Configuration) - Customer Settings - Subscription Profile Settings tab

  • Set Can Place On Hold option to No

  • Go to Magento Frontend - My Account - My Subscriptions

Can Cancel

This setting controls if a customer can cancel their subscription orders themselves or if they would have to call/contact you to cancel.

  • Go to Magento Admin panel - mPower - (Configuration) - Customer Settings - Subscription Profile Settings tab

  • Set Can Cancel option to Yes

  • Go to Magento Frontend - My Account - My Subscriptions

 

  • Go to Magento Admin panel - mPower - (Configuration) - Customer Settings - Subscription Profile Settings tab

  • Set Can Cancel option to No

  • Go to Magento Frontend - My Account - My Subscriptions

Until Canceled

This setting controls if a customer is able to create recurring orders that don't run indefinitely.

Example: You may be selling a Magento support service to your customers. You may sign an annual contract with a customer where you bill them monthly for 50 hours of work. Your product may be an hour of support time and its a monthly subscription for 12 installments. If you do want to support this use case, you would want to set this setting to No.

  • Go to Magento Admin panel - mPower - (Configuration) - Customer Settings - Subscription Profile Settings tab

  • Set Until Canceled option to Yes

 

 

 

 

 

  • Go to Magento Admin panel - mPower - (Configuration) - Customer Settings - Subscription Profile Settings tab

  • Set Until Canceled option to No

 

Customer Settings: Subscriber Limitation

Limit which customer group can use subscriptions

Allow to all customer groups

This setting allows you to select one of two options “All allowed groups“ or “Specific Groups”

Customer Group Limit

Allow customers from the selected customer groups to be able to place recurring orders