Subscriptions API (v3)

Subscriptions is the VTEX solution for customers to make recurrent purchases at your store on a regular schedule. When customers subscribe, they define what products they want to acquire regularly and at what frequency they want these automatic orders to be created. For more information, see Subscriptions onboarding guide.

Index

Cycles

• GET Get cycle details
• GET List cycles
• POST Retry cycle

Plans

• GET List plans
• GET Get plan details

Reports

• GET List report templates
• GET Get report document details
• POST Generate report

Subscriptions

• GET Get subscription details by ID
• PATCH Update subscription by ID
• GET List subscriptions
• POST Create subscription
• DELETE Remove item from subscription
• PATCH Edit item on subscription
• POST Add item to subscription
• POST Calculate the current prices for a subscription
• POST Calculate the current prices for the provided subscription template
• GET Get conversation messages

Settings

• GET Get subscription settings
• POST Edit subscriptions settings

Common parameters

Parameter name	Description	Type
{{accountName}}	Name of the VTEX account. Used as part of the URL.	Server variable.
{{environment}}	Environment to use. Used as part of the URL. The default value is vtexcommercestable.	Server variable.
X-VTEX-API-AppKey	Unique identifier of the API key.	Authentication header. Must be used together with X-VTEX-API-AppToken. Not necessary when using VtexIdclientAutCookie.
X-VTEX-API-AppToken	Secret token of the API key.	Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using VtexIdclientAutCookie.
VtexIdclientAutCookie	User token, valid for 24 hours.	Authentication header. Not necessary when using X-VTEX-API-AppKey and X-VTEX-API-AppToken.