Skip to main content
Feedback

VTEX Subscriptions V3 MCP connector

Updated 

VTEX Subscriptions V3 is VTEX's API for managing recurring order subscriptions on its commerce platform. The VTEX Subscriptions V3 MCP connector allows AI agents to create and update subscriptions, manage subscription items, and review billing cycle details. It also supports retrying failed cycles and calculating current pricing for subscription templates, giving teams visibility and control over recurring revenue operations.

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 cycles without manual intervention
  • Retry failed subscription cycles to recover lost revenue
  • Create and update customer subscriptions in real time
  • Adjust subscription items, quantities, and skus on demand
  • Calculate updated pricing before applying subscription changes
  • Generate and retrieve subscription performance reports
  • Review customer conversation history tied to subscriptions
  • Configure global subscription settings and available plans

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 subscription cycles in VTEX Subscriptions V3.
  • Retry the failed cycle for order 12345 in VTEX Subscriptions V3.
  • Create a new subscription for this customer in VTEX Subscriptions V3.
  • Add a new item to this customer's subscription in VTEX Subscriptions V3.
  • What plans are currently available in VTEX Subscriptions V3?
  • Calculate the updated price for this subscription in VTEX Subscriptions V3.
  • Generate a monthly subscription report in VTEX Subscriptions V3.
  • Show me the conversation history for this subscription in VTEX Subscriptions V3.
  • Update the delivery frequency for this subscription in VTEX Subscriptions V3.
  • What are the current subscription settings in VTEX Subscriptions V3?

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.

ToolDescription
getApiRnsPubCyclesList cycles
getApiRnsPubCycles2Get cycle details
createApiRnsPubCyclesRetryRetry cycle
getApiRnsPubSubscriptionsList subscriptions
createApiRnsPubSubscriptionsCreate subscription
createApiRnsPubSubscriptionsSimulateCalculate the current prices for the provided subscription template
getApiRnsPubSubscriptions2Get subscription details
patchApiRnsPubSubscriptionsUpdate subscription
createApiRnsPubSubscriptionsItemsAdd item to subscription
deleteApiRnsPubSubscriptionsItemsRemove items from a subscription.
patchApiRnsPubSubscriptionsItemsEdit items on a subscription.
createApiRnsPubSubscriptionsSimulate2Calculate the current prices for a specific subscription
getApiRnsPubSubscriptionsConversationMessageGet conversation messages
getApiRnsPvtPlansList plans
getApiRnsPvtPlans2Get plan details
getApiRnsPvtReportsList report templates
createApiRnsPvtReportsDocumentsGenerate report
getApiRnsPvtReportsDocumentsGet report document details
GetSettingsGet Subscription Settings
EditSettingsEdit Subscriptions settings
On this Page