VTEX Subscriptions V2 MCP connector
VTEX Subscriptions V2 is VTEX's recurring order management system for automating subscription-based commerce and customer lifecycle operations. The VTEX Subscriptions V2 MCP connector allows AI agents to generate and retrieve subscription reports by status, date, or schedule, manage subscription settings, and access customer subscription data across multiple dimensions. It also supports monitoring report generation status, configuring subscription groups, and retrieving detailed subscription information for analysis and optimization.
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:
- Monitor subscription health by retrieving reports filtered by status, date, and order history
- Retrieve and update customer subscription details including frequency, items, and payment methods
- Cancel recurring subscriptions and manage subscription group configurations across multiple orders
- Simulate subscription changes and access next purchase dates before confirming modifications
- Insert and manage delivery addresses linked to active subscriptions and subscription groups
- Retry failed subscription orders and resolve payment issues to maintain recurring revenue
- Configure global subscription settings and access frequency options available to customers
- Track subscription creation forecasts and retrieve conversation messages for customer communication
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 with a status of pending in VTEX Subscriptions V2.Retrieve the subscription report for orders placed between January 1 and January 31 in VTEX Subscriptions V2.List all active subscriptions for customer ID 12345 in VTEX Subscriptions V2.What is the next purchase date for subscription group ABC789 in VTEX Subscriptions V2?Cancel the subscription with ID XYZ456 in VTEX Subscriptions V2.Update the delivery address for subscription group ABC789 in VTEX Subscriptions V2.Simulate a frequency change from monthly to quarterly for subscription group ABC789 in VTEX Subscriptions V2.Get all failed subscription orders and retry them in VTEX Subscriptions V2.Retrieve the payment method settings for subscription group ABC789 in VTEX Subscriptions V2.Show me subscriptions scheduled to renew next week 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 | Retrieves the current processing status of a subscription report by its identifier. |
| Requestreportbydate | Generates a subscription report filtered by a specific date. |
| RequestreportbyStatus | Generates a subscription report filtered by subscription status. |
| Requestreportbyorderdate | Generates a subscription report filtered by order date. |
| Requestreportbyschedule | Generates a subscription report filtered by schedule. |
| Requestreportbyupdate | Generates a subscription report filtered by update timestamp. |
| GetSettings | Retrieves the current configuration settings for subscriptions. |
| EditSettings | Modifies the configuration settings for subscriptions. |
| Getsubscriptionstocustomer | Retrieves all active and inactive subscriptions for a customer. |
| GetAllsubscriptiongroup | Lists all subscription groups in the system. |
| Getsubscriptiongrouplist | Retrieves a list of subscription groups with filtering options. |
| GetNextpurchase | Retrieves the next scheduled purchase date for a subscription. |
| GetSimulatebysubscription-group | Simulates pricing and details for a subscription group. |
| GetSubscriptionbygroupId | Retrieves subscription details for a specific group identifier. |
| UpdateSubscriptionbygroupId | Modifies subscription information for a specific group identifier. |
| Additemsubscription-groupId | Adds a product item to an existing subscription group. |
| GetaddressesbygroupId | Retrieves all delivery addresses associated with a subscription group. |
| InsertAddressesbygroupId | Adds new delivery addresses to a subscription group. |
| CancelSubscriptionbygroupId | Cancels a subscription for a specific group identifier. |
| GetConfigsubscriptionsgroup | Retrieves configuration settings for a subscription group. |
| GetConversationMessagebygroupId | Retrieves messages and notes for a subscription group. |
| GetfrequencyoptionsbygroupId | Retrieves available frequency options for a subscription group. |
| GetpaymentSystembygroupId | Retrieves payment method information for a subscription group. |
| GetwillcreatebygroupId | Lists upcoming orders scheduled to be created for a group. |
| RetrysubscriptionbygroupId | Retries a failed payment or order for a subscription group. |
| GetSubscriptionList | Lists all subscriptions with available filters and pagination. |
| GetsubscriptionbyId | Retrieves detailed information for a specific subscription. |
| UpdateSubscriptionsbySubscriptionId | Modifies details for a specific subscription. |
| InsertAddressesforSubscription | Adds new delivery addresses to a specific subscription. |
| CancelSubscriptionsbySubscriptionId | Cancels a specific subscription by its identifier. |
| GetfrequencyoptionsbysubscriptionId | Get frequency options by subscriptionId. |
