VTEX

Subscription (v1 - deprecated)

Subscription (v1 - deprecated) endpoints from VTEX

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Subscription (v1 - deprecated) endpoints from VTEX

Endpoints 11

Miscellaneous

  • GETGet Subscriptions/subscriptions?email={{email}}&cycleStatus={{cycleStatus}}Retrieves a given Subscription (formerly recurrence). There are three options of filtering your Subscruptions v1. It's possible to get a list of all…
  • PUTUpdate Subscription/subscriptionsUpdates details of a given Subscription (formerly recurrence).
  • GETGet self Subscription/subscriptions/meLists details of your self Subscription (formerly Recurrence).
  • GETGet Subscription settings/subscriptions/settingsRetrieves your store's Subscriptions' (formerly recurrence) settings.
  • PUTUpdate Subscription settings/subscriptions/settingsUpdates the Subscriptions' (formerly Recurrence) settings of your store by salesChannel and defaultSLA.
  • GETGet Subscription by recurrenceId/subscriptions/:recurrenceIdRetrieves a given Subscription (formerly recurrence) by recurrenceId.
  • PATCHUpdate partial Subscription/subscriptions/:recurrenceIdUpdates partial information of a given subscription (formerly Recurrence).
  • GETGet Subscription addresses/subscriptions/:recurrenceId/addressesRetrieves the addresses attached to a given subscription (formerly recurrence) by recurrenceId.
  • POSTAdd Subscription item/subscriptions/:recurrenceId/itemsAdds an item to a Subscription (formerly Recurrence).
  • PATCHReindex Subscription/subscriptions/:recurrenceId/reindexAlters the frequency of a given Subscription (formerly Recurrence) by changing period and interval.
  • GETGet payment accounts/subscriptions/:recurrenceid/accountsLists payment accounts of a given Subscription (formerly Recurrence) by recurrenceId.

API details

Base URL
https://vtex.local
https://{accountName}.{environment}.com.br/api
Authentication
An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header
Operations
11 operations on 8 pathsGET 6PUT 2PATCH 2POST 1
Main resources
Miscellaneous 11
Description format
OpenAPI 3.0.0, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Subscription (v1 - deprecated) in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Subscription (v1 - deprecated) collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get Subscriptions” (GET /subscriptions?email={{email}}&cycleStatus={{cycleStatus}}), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Subscription (v1 - deprecated)?

Subscription (v1 - deprecated) endpoints from VTEX It is listed under Other and has 11 endpoints.

Who publishes the Subscription (v1 - deprecated)?

It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Subscription (v1 - deprecated)?

Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br/api. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Subscription (v1 - deprecated)?

It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.

How many endpoints does the Subscription (v1 - deprecated) have?

11 operations on 8 paths (6 GET, 2 PUT, 2 PATCH, 1 POST). The largest groups are Miscellaneous.

Is forking the Subscription (v1 - deprecated) free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.