VTEX Subscription (v1) MCP connector

VTEX Subscription (v1) is VTEX's API for managing recurring order subscriptions and subscription configuration settings within the VTEX commerce platform. The VTEX Subscription (v1) MCP connector allows AI agents to retrieve and update customer subscriptions, manage subscription items and addresses, and configure subscription settings. It also supports reindexing subscriptions, filtering subscriptions by recurrence ID, and performing partial updates to 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 Subscription (v1) MCP connector to perform the following actions:

• Retrieve active subscriptions and monitor recurring order status across your VTEX tenant
• Update subscription details including frequency, payment method, and delivery addresses
• Manage subscription items by adding products or adjusting quantities for existing orders
• Configure subscription settings and payment account preferences for your business
• Reindex subscription data to ensure accurate search and reporting in VTEX Subscription (v1)
• Retrieve saved payment accounts and associate them with active subscriptions
• Access subscription information by recurrence ID for targeted order management
• Fetch subscription addresses to verify and update delivery locations

Example prompts

Use the following example prompts to invoke VTEX Subscription (v1) MCP connector tools from your AI assistant or Boomi Connect workflow:

• Show me all subscriptions in VTEX Subscription (v1) that are set to renew next week.
• Update the delivery address for subscription ID 12345 in VTEX Subscription (v1).
• List all payment accounts available in VTEX Subscription (v1) for this tenant.
• Get the subscription settings and tell me the current billing configuration in VTEX Subscription (v1).
• Add a new product to an existing subscription in VTEX Subscription (v1).
• Retrieve my own subscription details from VTEX Subscription (v1).
• Find all subscriptions by recurrence ID ABC789 in VTEX Subscription (v1).
• Reindex all subscriptions in VTEX Subscription (v1) to refresh the search index.
• Update multiple subscription fields at once in VTEX Subscription (v1).
• Show me the addresses linked to subscription ID 67890 in VTEX Subscription (v1).

VTEX Subscription (v1) MCP connector tools

The VTEX Subscription (v1) MCP connector provides the following tools. Each tool maps to a specific action you can invoke from your AI agent or automation.

Tool	Description
GetRecurrencebyemail	Retrieves subscription details for a customer identified by email address.
Updaterecurrence	Modifies existing subscription information and settings for a customer.
Getselfrecurrence	Retrieves subscription details for the currently authenticated user.
Getrecurrencesettings	Retrieves configuration and policy settings for subscriptions.
Updaterecurrencesettings	Modifies configuration and policy settings for subscriptions.
GetRecurrencebyrecurrenceId	Retrieves subscription details using a specific subscription identifier.
Updatepartialrecurrence	Updates selected fields of an existing subscription without modifying others.
Getrecurrenceaddresses	Retrieves delivery and billing addresses associated with a subscription.
Addrecurrenceitem	Adds a product to an existing subscription order.
Reindexrecurrence	Refreshes and reindexes subscription data for search and retrieval.
Getpaymentaccounts	Retrieves saved payment methods and accounts for a customer.