integrations.sh
← all integrations

vtex.local – Subscriptions-API-(v3)

OpenAPI apis-guru

A Subscription is a list of items (SKUs) tied to certain recurring purchase settings:

  • User profile
  • Address
  • Payment method
  • Frequency
  • Cycle

Once you have in your store, the Subscriptions API allows you to create, manage and monitor your customers' subscriptions.

image

To read more about the Subscriptions feature, check our article .

Homepage
https://api.apis.guru/v2/specs/vtex.local:Subscriptions-API-(v3)/1.0.json
Provider
vtex.local:Subscriptions-API-(v3) / Subscriptions-API-(v3)
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/openapi.yaml

Tools (22)

Extracted live via the executor SDK.

  • cycles.getApiRnsPubCycles

    List cycles filtering by some arguments.

  • cycles.getApiRnsPubCyclesCycleId

    Retrieve a specific cycle by its ID.

  • cycles.postApiRnsPubCyclesCycleIdRetry

    Every subscription order has an execution count called cycle, which determines the position of an order counting from when the shopper subscribed. This endpoint reruns a cycle that is currently in error state.

  • plans.getApiRnsPvtPlans

    List plans filtering by some arguments.

  • plans.getApiRnsPvtPlansId

    This endpoint retrieves a specific plan by its ID.

  • reports.getApiRnsPvtReports

    List all report templates available.

  • reports.getApiRnsPvtReportsReportNameDocumentsDocumentId

    Retrieve a specific report document by its Id.

  • reports.postApiRnsPvtReportsReportNameDocuments

    This endpoint creates a new report in the format of a CSV file and sends it via email. You can generate one of the following reports:

    • subscriptionsWithStatus

    • subscriptionsScheduledBetweenDate

    • subscriptionsUpdatedBetweenDate

    • subscriptionsCreatedBetweenDate

    • executionsBetweenDate

  • settings.editSettings

    Edits Subscriptions settings in your store.

  • settings.getSettings

    List the details of the settings of a given subscription.

  • subscriptions.deleteApiRnsPubSubscriptionsIdItemsItemId

    Removes a specific item from a given subscription

  • subscriptions.getApiRnsPubSubscriptions

    List subscriptions filtering by some arguments.

  • subscriptions.getApiRnsPubSubscriptionsId

    Retrieve a specific subscription by its ID.

  • subscriptions.getApiRnsPubSubscriptionsSubscriptionIdConversationMessage

    Retrieve all conversation messages sent to a customer regarding a given subscription.

  • subscriptions.patchApiRnsPubSubscriptionsId

    Update a specific subscription.

  • subscriptions.patchApiRnsPubSubscriptionsIdItemsItemId

    Edit a given item on a specific subscription

  • subscriptions.postApiRnsPubSubscriptions

    Create a new subscription.

  • subscriptions.postApiRnsPubSubscriptionsIdItems

    Add a new item to a given subscription.

  • subscriptions.postApiRnsPubSubscriptionsIdSimulate

    Simulates an order made by the specific subscription on checkout and retrieves the current price for items and shipping.

  • subscriptions.postApiRnsPubSubscriptionsSimulate

    Simulates an order made by subscriptions on checkout and retrieves the current price for items and shipping.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools