Menu
Feedback
Start here
Tutorials
Developer portal

Known Issues
Support Rules
Troubleshooting

Frequently Asked Questions
Announcements
Tutorials
Tutorials
Explore in-depth tutorials for operating your VTEX store.
Tutorials
Orders
Subscription Guides
How to configure Subscriptions in your store
How to configure Subscriptions in your store

To install the Subscriptions module, please contact our Support.

The Subscriptions system is an app developed by VTEX to facilitate recurring sales. It works as an automatic scheduler, repeating orders according to the frequency chosen by your customer.

Your costumer can indicate how often they would like to repurchase a certain product and the system will automatically resubmit the purchase order according to the selected frequency, on a recurring basis.

This purchase will be made automatically, according to the selected frequency, with the same characteristics configured in the original order. Subscription is a simple way to save your customer's time and to provide a scheduled sales flow to your store.

To activate this feature, you will need to:

  1. Install the Subscriptions app
  2. Configure payment methods
  3. Create a subscription plan
  4. Configure roles for subscriptions

1. Install the Subscriptions app

Currently, the installation of the Subscriptions module is done only by our Support.

To install the free Subscriptions app from the VTEX App Store, follow the steps below:

  1. In the VTEX App Store, go to the Subscriptions app page.
  2. Click Get app.
  3. In Type your account, enter the name of your VTEX account.
  4. Click Confirm.
  5. In your shopping cart in the VTEX App Store, click Place Order.
  6. Click Go to the installation page.
  7. In VTEX Admin, click Install.

After installation, the app settings will be available in VTEX Admin under Orders > Subscriptions.

2. Configure payment methods

To configure payment methods for subscription orders, please follow the steps below.

  1. Log in to the Subscriptions module of your Admin.
  2. Click on the Settings tab.
  3. Toggle the checkbox next to the payment method you want to activate to Activated.

Currently, the following payment methods are enabled for subscription orders:

  • Boleto (popular Brazilian off-line payment method)
  • Credit card

To make the Credit card payment option available, contact your store's acquirer and make sure they accept recurring purchase transactions coming from tokenized cards (no CVV). The Subscriptions system will use the same card data from the first purchase to place subsequent subscription orders, ensuring the security of the entire process.

To enable this type of transaction in the connector, the store manager must ask the acquirer for permission to process recurring payments. Check out our article Registering gateway affiliations.

3. Create a subscription plan

In the Subscriptions module, you need to create subscription plans to offer to your customers and to associate products with these plans. The plans indicate that the Subscriptions feature is active for certain products and display the available subscription frequencies. Please refer to the article Creating a subscription plan to learn more about this process.

There is another option to create a subscription plan, which involves manually creating an SKU attachment in the Catalog. In this case, the SKU attachment is responsible for indicating that the Subscription feature is active for that SKU and which order frequencies are available. Check out the article How to create a subscription attachment to learn more about this process.

4. Configure roles for Subscriptions

There are a number of subscription-related features available in the Roles module of your store. These features allow your VTEX Admin users to access certain features in order to operate the Subscriptions module. To learn more about roles, please read this article.

If the user does not have the permissions required to access the data on the Subscriptions pages, the system will display a warning stating that they do not have those permissions, and the user will be unable to view the data.

See the table below for features related to the Subscriptions module.

Feature name on the Roles pageKey nameDescription
Subscription view onlySubscriptionViewerAllows viewing lists related to subscribers and orders only
Subscription view and editSubscriptionManageAllows edits and actions, but does not give access to charts and non-monetary relationships
Subscription metrics and reportsSubscriptionMetricsAllows viewing charts, figures and trends
Subscription adminSubscriptionAdminAllows configuring Subscriptions

To configure Subscription roles, please follow the instructions below.

  1. Under Account Settings, click User Roles.
  2. Click New Role.
  3. Fill in the Role name.
  4. Under Products and Resources select Subscriptions.
  5. Check the resources you would like to add.
  6. Click Save.

Once Subscriptions are configured in your store, please read our article on how to manage subscriptions.

You can test the purchase flow of a subscription from your customer's perspective. To understand how your customer generates a subscription order, please refer to our article on How subscriptions work.

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page
Still got questions?
Ask the community
Find solutions and share ideas in the VTEX community.
Join our community
Request support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
GithubDeveloper portalCommunityFeedback