VTEX Subscriptions V3 MCP connector
VTEX Subscriptions V3 is VTEX's recurring order management system for handling subscription-based commerce operations. The VTEX Subscriptions V3 MCP connector allows AI agents to manage subscription lifecycles, monitor and retry billing cycles, and calculate pricing for subscription templates. It also supports adding or removing items from active subscriptions, retrieving detailed subscription and cycle information, and creating new subscription records.
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 V3 MCP connector to perform the following actions:
- Automate recurring order fulfillment and reduce manual subscription management overhead
- Track subscription cycles and retry failed charges to recover lost revenue
- Customize subscription plans and pricing for different customer segments
- Monitor subscription health with conversation messages and activity reports
- Add, remove, and edit subscription items without pausing customer billing
- Generate subscription analytics and performance reports on demand
- Synchronize subscription data across systems to maintain single source of truth
Example prompts
Use the following example prompts to invoke VTEX Subscriptions V3 MCP connector tools from your AI assistant or Boomi Connect workflow:
Show me all active subscriptions in VTEX Subscriptions V3 for customers in Brazil.List the last 10 failed subscription cycles and tell me which ones need retry.Create a new monthly subscription plan with a 15% discount for annual commitments.What are the current prices for my premium subscription template in VTEX Subscriptions V3?Add three new products to an existing subscription without interrupting the customer's billing.Generate a subscription performance report for the last quarter in VTEX Subscriptions V3.Update my subscription settings to allow customers to change their billing frequency.Show me all conversation messages related to subscription cancellation requests.Remove out-of-stock items from active subscriptions in VTEX Subscriptions V3.Retrieve the details for all available subscription plans and their pricing tiers.
VTEX Subscriptions V3 MCP connector tools
The VTEX Subscriptions V3 MCP connector provides the following tools. Each tool maps to a specific action you can invoke from your AI agent or automation.
| Tool | Description |
|---|---|
| getApiRnsPubCycles | Retrieves a list of all subscription billing cycles. |
| getApiRnsPubCycles2 | Retrieves detailed information about a specific subscription billing cycle. |
| createApiRnsPubCyclesRetry | Retries a failed or pending subscription billing cycle. |
| getApiRnsPubSubscriptions | Retrieves a list of all active subscriptions. |
| createApiRnsPubSubscriptions | Creates a new subscription with the specified details. |
| createApiRnsPubSubscriptionsSimulate | Calculates current prices for a subscription template. |
| getApiRnsPubSubscriptions2 | Retrieves detailed information about a specific subscription. |
| patchApiRnsPubSubscriptions | Updates subscription settings or status. |
| createApiRnsPubSubscriptionsItems | Adds a new item to an existing subscription. |
| deleteApiRnsPubSubscriptionsItems | Removes items from a subscription. |
| patchApiRnsPubSubscriptionsItems | Modifies items already added to a subscription. |
| createApiRnsPubSubscriptionsSimulate2 | Calculates current prices for a specific subscription. |
| getApiRnsPubSubscriptionsConversationMessage | Retrieves conversation messages associated with a subscription. |
| getApiRnsPvtPlans | Retrieves a list of all subscription plans. |
| getApiRnsPvtPlans2 | Retrieves detailed information about a specific subscription plan. |
| getApiRnsPvtReports | Retrieves a list of available subscription report templates. |
| createApiRnsPvtReportsDocuments | Generates a new subscription report document. |
| getApiRnsPvtReportsDocuments | Retrieves details about a specific generated report document. |
| GetSettings | Retrieves the current subscription settings configuration. |
| EditSettings | Updates the subscription settings configuration. |
