Skip to main content
Feedback

VTEX Subscription (v1) MCP connector

Updated 

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:

  • Track recurring order subscriptions across all customers in one place
  • Update subscription frequency, status, or items for active customer plans
  • Configure global subscription settings like retry rules and notifications
  • Retrieve a customer's own subscription details for self-service portals
  • Look up subscriptions by recurrence identifier for order troubleshooting
  • Manage shipping addresses linked to recurring subscription orders
  • Add new items to existing recurring subscription orders
  • Rebuild subscription search indexes and review linked payment accounts

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 active subscriptions in VTEX Subscription (v1).
  • Update the delivery frequency for customer Jane's subscription in VTEX Subscription (v1).
  • What subscription settings are currently configured in VTEX Subscription (v1)?
  • Pause the subscription with recurrence ID 12345 in VTEX Subscription (v1).
  • Add a new product to this customer's recurring order in VTEX Subscription (v1).
  • List the shipping addresses tied to this subscription in VTEX Subscription (v1).
  • Reindex all subscriptions in VTEX Subscription (v1) after our recent catalog update.
  • Show me the payment accounts linked to subscriptions in VTEX Subscription (v1).
  • Find my own subscription details in VTEX Subscription (v1).
  • Update part of a subscription record without resetting everything 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.

ToolDescription
GetRecurrencebyemailGet Subscriptions
UpdaterecurrenceUpdate Subscription
GetselfrecurrenceGet self Subscription
GetrecurrencesettingsGet Subscription settings
UpdaterecurrencesettingsUpdate Subscription settings
GetRecurrencebyrecurrenceIdGet Subscription by recurrenceId
UpdatepartialrecurrenceUpdate partial Subscription
GetrecurrenceaddressesGet Subscription addresses
AddrecurrenceitemAdd Subscription item
ReindexrecurrenceReindex Subscription
GetpaymentaccountsGet payment accounts
On this Page