API Reference

Subscriptions v3 migration guide

The Subscriptions Module is an app developed by VTEX to facilitate recurring sales in your store. It works as an automatic scheduler, executing a repurchase at the frequency requested by the customer. Check out our article about how subscriptions work and the Subscriptions V3 API reference to know more.

This article explores all the changes the v3 module has brought, compared to the v2, and details the steps needed so your store is fully integrated with the new module.

What changed

The v3 module’s changes include:

Improvements on how your customers view and manage their subscriptions in your store.

  • How an order’s cycle date is calculated.
  • What a subscription means to our system.
  • Renaming some attributes.
  • All API endpoints have gone through structural changes.

For stores that don’t consume our API in their integrations, it is not necessary to make any adaptation or setup, our system will implement the new module automatically.

For stores or partners that consumed our Subscriptions API, it is necessary to implement new endpoints so your integrations operate with the new module. The whole migration process will be carefully supervised by the VTEX team to guarantee a smooth transition.

What is a “subscription” to Subscriptions v2?

In the Subscriptions v2 module, the entity subscription was an order composed of a single SKU tied to a given purchase setting. Purchase settings include the following attributes:

  • User profile
  • Address
  • Payment method
  • Frequency
  • Start day of the subscription’s cycle

This principle allowed the store’s customers to subscribe to several SKUs using different delivery addresses and payment methods - which represented an evolution compared to the system’s first version.

This behavior required another entity to be created: the subscriptionGroup. It allowed subscribed SKUs with similar purchase settings to be grouped in your customers’ My Account page, so they could see their subscription orders in a more organized way. The diagram below illustrates those concepts:

{"base64":"  ","img":{"width":1361,"height":696,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":39855,"url":""}}

{"base64":"  ","img":{"width":1999,"height":733,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":191627,"url":""}}

What is a “subscription” to Subscriptions v3?

For the 3rd version of our module, we have changed our system’s understanding of what is a subscription. Now, subscriptions are a list of SKUs, tied to a certain purchase setting.

This change takes out the need of creating a subscriptionGroup to arrange multiple SKUs. Therefore, all operations function around the subscription entity (which holds all the data necessary to generate a subscription order), instead of subscriptionGroup. The diagram below illustrates the updated concept:

{"base64":"  ","img":{"width":1361,"height":694,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":48049,"url":""}}

We have also renamed the entity subscriptionOrder to subscriptionCycle. Now a subscription is not tied necessarily to the first order.

Calculating the cycle date

How our system calculates an order’s next cycle date has also changed:

  • Subscriptions v2: it was calculated from the first order’s starting date. All cycle dates had to follow that first chosen date, users could not change it.
  • Subscriptions v3: it is calculated based on the previous cycle date, instead of the first one ever. The first order’s date is only used for that first purchase, when the subscription hasn’t yet been executed.

This means users can change the date whenever they want, since the following orders will be executed based on the previous cycle date. To enable this feature, we have developed an API that allows users to choose exactly when they want their next order to be executed, without needing to change the subscription’s frequency as a work-around.

All changes between v2 and v3 modules are summarized in the table below:

Subscriptions v2Subscriptions v3
Subscription: order composed of an SKU tied to a certain purchase settingSubscription: a list of SKUs, tied to a certain purchase setting
Next cycle date: the same as the first order’s starting dateNext cycle date: calculated based on the previous order’s cycle date


If your stores don’t rely on our API for any integrations, no adaptation or migration should be made - the new module will be implemented automatically by our system.

Stores that call our Subscriptions API must adapt their integrations, so the new module is fully operational. We remind you that the whole migration process will be fully supervised and assisted by the VTEX team, via ticket.

Message center

Subscriptions v3 uses a different Message center email template than v2 for the Subscriptions - Next Order stage of a given cycle.

Below you can see what the equivalent template is, if you wish to customize this transactional email:

Subscriptions v2Subscriptions v3

API endpoints

We have standardized our endpoints’ structure, so your developer experience is more consistent. Check out the table below, to compare the changes to all endpoints:

Subscriptions v2Subscriptions v3
[ALL] /api/rns/subscriptions/*Deprecated
[GET] /api/rns/subscriptions-group/:groupId:[GET] /api/rns/pub/subscriptions/:subscriptionId:
[PATCH] /api/rns/subscriptions-group/:groupId:[PATCH] /api/rns/pub/subscriptions/:subscriptionId:
[GET] /api/rns/subscriptions-group[GET] /api/rns/pub/subscriptions
[GET] /api/rns/subscriptions-group/list[GET] /api/rns/pub/subscriptions
[GET] /api/rns/subscriptions-group/simulate/:groupId:[GET] /api/rns/pub/subscriptions/simulate
[PATCH] /api/rns/subscriptions-group/:groupId:/cancel[PATCH] /api/rns/pub/subscriptions/:subscriptionId:
[POST] /api/rns/subscriptions-group/:groupId:/additem[POST] /api/rns/pub/subscriptions/:subscriptionId:/items
[GET] /api/rns/subscriptions-group/:groupId:/addressesDeprecated, use the profile-system API.
[POST]/api/rns/subscriptions-group/:groupId:/addressesDeprecated, use the profile-system API.
[GET] /api/rns/subscriptions-group/:groupId:/payment-systemsDeprecated, use the profile-system API.
[GET] /api/rns/subscriptions-group/:groupId:/frequency-options[GET] /api/rns/pvt/plans/:planId
[POST] /api/rns/subscriptions-group/:groupid:/instances/:instanceId:/retry[POST] /api/rns/pub/cycles/cycleId/retry
[GET] /api/rns/subscriptions-group/:groupId:/conversation-messageDeprecated
[GET] /api/rns/subscriptions-group/:groupId:/will-createDeprecated
[GET] /api/rns/subscriptions-group/:groupId:/configDeprecated
[GET] /api/rns/subscriptions-group/nextPurchase/:dateSR:[GET] /api/rns/pub/subscriptions
[GET] /api/rns/settingsDeprecated
[GET] /api/rns/report/reportStatus/:reportId:[GET] /api/rns/pvt/reports/:templateName/documents/:documentId
[GET] /api/rns/report/subscriptionsByStatus[POST] /api/rns/pvt/reports/:templateName/documents
[GET] /api/rns/report/subscriptionsByDate[POST] /api/rns/pvt/reports/:templateName/documents
[GET] /api/rns/report/subscriptionsScheduled[POST] /api/rns/pvt/reports/:templateName/documents
[GET] /api/rns/report/subscriptionsOrderByDate[POST] /api/rns/pvt/reports/:templateName/documents
[GET] /api/rns/report/subscriptionsUpdated[POST] /api/rns/pvt/reports/:templateName/documents
Photo of the contributor
+ 1 contributors
Was this helpful?
Suggest edits (Github)
Photo of the contributor
+ 1 contributors
On this page