How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
VTEX

VTEX Subscriptions API

The Subscriptions API from VTEX — 7 operation(s) for subscriptions.

Documentation Provider Profile APIs.io OpenAPI GitHub

VTEX Subscriptions API is one of 142 APIs that VTEX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 7 paths, and defines 39 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://{providerApiEndpoint}.

10 operations 7 paths 39 schemas 1 DELETE3 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://{providerApiEndpoint}
Authentication
API Key
Resource Areas
1

Authentication & Security 1

VTEX Subscriptions API declares 1 security scheme for authenticating requests. An API key is passed in the header as VtexIdclientAutCookie (VtexIdclientAutCookie).

  • VtexIdclientAutCookie — [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 3 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 10
GET
/api/rns/pub/subscriptions/{id}
VTex Get subscription details
3 params → 200
PATCH
/api/rns/pub/subscriptions/{id}
VTex Update subscription
3 params body → 200
GET
/api/rns/pub/subscriptions
VTex List subscriptions
11 params → 200
POST
/api/rns/pub/subscriptions
VTex Create subscription
2 params body → 201
DELETE
/api/rns/pub/subscriptions/{id}/items/{itemId}
VTex Remove items from a subscription.
4 params → 200
PATCH
/api/rns/pub/subscriptions/{id}/items/{itemId}
VTex Edit items on a subscription.
4 params body → 200
POST
/api/rns/pub/subscriptions/{id}/items
VTex Add item to subscription
3 params body → 200
POST
/api/rns/pub/subscriptions/{id}/simulate
VTex Calculate the current prices for a specific subscription
3 params → 200
POST
/api/rns/pub/subscriptions/simulate
VTex Calculate the current prices for the provided subscription template
2 params body → 200
GET
/api/rns/pub/subscriptions/{subscriptionId}/conversation-message
VTex Get conversation messages
3 params → 200

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are SubscriptionGroupResponse (15 properties), Payment (12 properties), LogisticsInfo (11 properties), PurchaseContextAvailableGiftResponse (11 properties). Each schema is shown below with its type and property counts.

PurchaseContextAvailableGiftResponse
object
11 properties
PlanResponse
object
4 properties 4 required
ValidityResponse
object
2 properties 1 required
PlanThinRequest
object
Information about the plan.
4 properties 3 required
UpdateItemInput
object
4 properties
SimulateMessageResponse
object
3 properties
ItemSimulationStatus
integer
Transaction
object
2 properties
PurchaseContextSelectableGiftsResponse
object
3 properties
LogisticsInfoDeliveryWindow
object
3 properties
FrequencyResponse
object
2 properties 2 required
LogisticsInfoSLA
object
8 properties
SubscriptionGroupResponse
object
15 properties 13 required
PurchaseDay
integer
SimulateResponseVO
object
4 properties
PurchaseSettingsThinRequest
object
Object containing purchase settings information.
2 properties 2 required
ShippingEstimate
object
5 properties
SubscriptionItemResponse
object
7 properties 5 required
ItemAttachment
object
2 properties
PaymentField
object
2 properties
TotalizationResponse
object
3 properties
PriceTag
object
5 properties
ShippingAddressResponse
object
2 properties 2 required
PaymentData
object
2 properties
SubscriptionThinItemRequest
object
3 properties
SubscriptionUpdateRequestV3
object
6 properties
shippingAddress
object
2 properties 2 required
SimulationItemResult
object
5 properties
PaymentMethodResponse
object
3 properties 1 required
SubscriptionGroupRequest
object
9 properties 5 required
SimulateResponse
object
9 properties
OrderItem
object
10 properties
LogisticsInfo
object
11 properties
ValidityRequest
object
Information about the period during which the subscription will be valid.
2 properties
FrequencyRequest
object
Information about subscriptions' recurrence.
2 properties 2 required
PurchaseSettingsResponse
object
2 properties 2 required
Totalization
object
2 properties
PaymentMethodThinRequest
object
Object containing information about the payment method.
3 properties 1 required
Payment
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-subscriptions-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Account API
AE Profile APIs.io
VTEX Addresses API
AE Profile APIs.io
VTEX Anti-Fraud Flow API
AE Profile APIs.io
VTEX App Keys API
AE Profile APIs.io
VTEX Attachment API
AE Profile APIs.io
VTEX Authentication API
AE Profile APIs.io
VTEX Autocomplete API
AE Profile APIs.io
VTEX Brand API
AE Profile APIs.io
VTEX Bulk Import API
AE Profile APIs.io
VTEX Carriers API
AE Profile APIs.io
VTEX Cart Attachments API
AE Profile APIs.io
VTEX Category API
AE Profile APIs.io
#Subscription
← Back to V APIs
API Details
ID
vtex:vtex-subscriptions-api
Base URL
https://{providerApiEndpoint}
Docs
https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works
Provider
VTEX
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vtex-subscriptions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vtex-subscriptions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of VTEX Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.