Help us improve our documentation! Tell us about your experience with this article by filling out this form.

Subscriptions is the VTEX solution for shoppers to make recurrent purchases on a regular schedule, determining the orders’ products and frequency. This overview article presents what you can accomplish with Subscriptions and gathers relevant documentation on the subject.

Subscriptions is an app developed by VTEX to facilitate recurring sales for a store. It works as an automatic scheduler, executing a repurchase at the frequency requested by the shopper.

To enable Subscriptions for shoppers, merchants have to create subscription plans to associate the products valid for subscriptions and the frequencies available for recurrent orders.

Once the Subscriptions module is configured, the merchant can generate, edit and manage shoppers’ recurrent orders, and create subscription promotions.

Have the most performative VTEX solution by using the version Subscriptions v3. For more information, see Subscriptions v3 migration guide.

The composition of a subscription is as the following:

Every subscription order has an execution count called cycle. The cycle determines the position of an order counting from when the shopper subscribed. The original order that creates the subscription corresponds to 0, the first subscription order corresponds to 1, the second corresponds to 2, and so on.

Shoppers can create a subscription during checkout or on their My Account page, and the communication between merchants and shoppers regarding subscriptions is made in the Message Center module through transactional emails.

To install the Subscriptions module, merchants have to contact our Support. After that, they have to follow the configuration steps described in How to configure Subscriptions in your store.

After the installation, merchants have to create subscription plans to associate the products valid for subscriptions and the frequencies available for recurrent orders.

Subscription plans are in Beta stage, meaning we are working to improve it.

We highly recommend creating subscription plans in the Subscriptions module of your VTEX Admin, although it is also possible to create them as catalog attachments.

In Admin: Orders > Order Management > Subscriptions > Dashboards

In Redesigned Admin: Orders > Subscriptions > Dashboards

In this section, you will find content about controlling and editing the Subscriptions settings of your store, and about updating, retrieving data and removing subscription orders.

You can edit the Subscriptions settings of your store and retrieve information about them.

• POST - Edit Subscriptions settings
• GET - Get Subscription Settings

It is possible to list and retrieve information about Subscription plans.

• GET - List plans
• GET - Get plan details

You can update settings, edit items and retrieve information about a given subscription.

• POST - Create subscription
• PATCH - Update subscription
• GET - Get subscription details
• GET - List subscriptions
• PATCH - Edit item on subscription
• POST - Add item to subscription
• DELETE - Remove item from subscription

Cycles are the execution count of subscription orders. The cycle determines the position of an order counting from when the shopper subscribed.

You can retrieve information about cycles and rerun cycles that present errors, which will reprocess the order.

• GET - Get cycle details
• GET - List cycles
• POST - Retry cycle

The communication between stores and shoppers about subscription orders happens via transactional emails. It is possible to retrieve the conversation messages sent to a shopper regarding a subscription order.

• GET - Get conversation messages

When using Subscriptions, stores might need to configure prices manually. By enabling the Manual Price feature for Subscriptions, merchants can apply a manual price on each subscription item, overriding the current price, and maintain the same manual price for future recurrent orders from a given subscription.

It is possible to simulate a subscription order price at checkout, getting information about items and shipping costs.

• POST - Calculate the current prices for a specific subscription
• POST - Calculate the current prices for the provided subscription template

The feature pickup points for subscription orders is in beta and available only for stores using the Checkout V6.

A pickup point is a physical location where shoppers can pick up their orders instead of having them delivered to their addresses, and merchants can configure pickup points for subscription orders. The requirements are the following:

• Have the Subscriptions module installed.
• Have pickup points configured.
• Associate to pickup points for subscription orders only carriers that do not have a delivery windows configured.
• Have items in stock at the subscription cycle date.

You can generate reports about subscription orders using templates to filter orders. When you create a template, you determine which criteria will be used for filtering: order status, creation date, scheduled date, among others.

• GET - List report templates
• GET - Get report document details
• POST - Generate report