VTEX Subscriptions V2 MCP connector
Updated
VTEX Subscriptions V2 is VTEX's API for managing recurring order subscriptions within an ecommerce tenant. The VTEX Subscriptions V2 MCP connector allows AI agents to retrieve subscription reports by date, status, order date, or schedule, and to check report generation status. It also supports managing subscription settings, reviewing customer subscriptions, and listing subscription groups across a store's instance.
Authentication type
- API Key - Requires a static API key to be configured before the agent can connect to the service.
Uses
Use the VTEX Subscriptions V2 MCP connector to perform the following actions:
- Track recurring order subscriptions across customers and subscription groups
- Generate subscription reports filtered by date, status, or schedule
- Update subscription frequency, items, and payment methods for customers
- Manage shipping addresses tied to individual subscriptions or groups
- Cancel subscriptions or subscription groups directly from a workflow
- Retry failed subscription orders without manual intervention
- Configure subscription settings and available frequency options
- Simulate upcoming subscription purchases before they process
Example prompts
Use the following example prompts to invoke VTEX Subscriptions V2 MCP connector tools from your AI assistant or Boomi Connect workflow:
Show me all subscriptions that are scheduled to renew this week in VTEX Subscriptions V2.Cancel the subscription group for customer Jane Doe in VTEX Subscriptions V2.What subscription report options are available by status in VTEX Subscriptions V2?Update the shipping address for subscription group 12345 in VTEX Subscriptions V2.List every active subscription for customer john@example.com in VTEX Subscriptions V2.Retry the failed subscription order for group ID 987 in VTEX Subscriptions V2.Check the current subscription settings configured in VTEX Subscriptions V2.Simulate the next purchase for subscription group 456 in VTEX Subscriptions V2.Add a new item to an existing subscription group in VTEX Subscriptions V2.Show me the conversation history for subscription group 789 in VTEX Subscriptions V2.
VTEX Subscriptions V2 MCP connector tools
The VTEX Subscriptions V2 MCP connector provides the following tools. Each tool maps to a specific action you can invoke from your AI agent or automation.
| Tool | Description |
|---|---|
| GetreportstatusbyID | Get report status by ID |
| Requestreportbydate | Retrieve Subscription report by date |
| RequestreportbyStatus | Retrieve Subscription report by Status |
| Requestreportbyorderdate | Retrieve Subscription report by order date |
| Requestreportbyschedule | Retrieve Subscription report by schedule |
| Requestreportbyupdate | Request report by update |
| GetSettings | Get Subscriptions Settings |
| EditSettings | Edit Subscriptions settings |
| Getsubscriptionstocustomer | Retrieve customer's subscriptions |
| GetAllsubscriptiongroup | List All subscription groups |
| Getsubscriptiongrouplist | Get subscription group list |
| GetNextpurchase | Get Next purchase |
| GetSimulatebysubscription-group | Get Simulation by subscription-group |
| GetSubscriptionbygroupId | Get Subscription by groupId |
| UpdateSubscriptionbygroupId | Update Subscription by groupId |
| Additemsubscription-groupId | Add Subscription item by groupId |
| GetaddressesbygroupId | Get addresses by groupId |
| InsertAddressesbygroupId | Insert Addresses by groupId |
| CancelSubscriptionbygroupId | Cancel Subscription by groupId |
| GetConfigsubscriptionsgroup | List Subscription group's Configuration |
| GetConversationMessagebygroupId | Get Conversation Message by groupId |
| GetfrequencyoptionsbygroupId | Get frequency options by groupId |
| GetpaymentSystembygroupId | Get payment System by groupId |
| GetwillcreatebygroupId | List 'Will create' by groupId |
| RetrysubscriptionbygroupId | Retry subscription by groupId |
| GetSubscriptionList | Get Subscription List |
| GetsubscriptionbyId | Retrieve subscription by ID |
| UpdateSubscriptionsbySubscriptionId | Update Subscriptions by SubscriptionId |
| InsertAddressesforSubscription | Insert Addresses for Subscription |
| CancelSubscriptionsbySubscriptionId | Cancel Subscriptions by SubscriptionId |
| GetfrequencyoptionsbysubscriptionId | Get frequency options by subscriptionId |
