vtex.local

A Subscription is a list of items (SKUs) tied to certain recurring purchase settings: - User profile - Address - Payment method - Frequency - Cycle Once you have configured subscriptions in yo

🔑 apikey 20 endpoints

📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (10 total)

lever-sdk ✓ Official

npm install lever-sdk

GitHub integration →

ads-js ✓ Official

npm install ads-js

GitHub integration →

vtex-node-sdk

npm install vtex-node-sdk

GitHub integration →

physical-payments-sdk ✓ Official

# Maven: see https://github.com/vtex-apps/physical-payments-sdk

GitHub integration →

VTEX-SDK-dotnet

dotnet add package VTEX-SDK-dotnet

GitHub integration →

vtex-sdk

composer require vtex-sdk

GitHub integration →

vtex-sdk-php

composer require vtex-sdk-php

GitHub integration →

vtex-api

composer require vtex-api

GitHub integration →

vtex-kotlin-sdk

# See https://github.com/ksetoue/vtex-kotlin-sdk

GitHub integration →

vtex.js ✓ Official

# See https://github.com/vtex/vtex.js

GitHub integration →

curl examples

Get Subscription Settings

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/rns/settings

List plans

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/rns/pvt/plans

List cycles

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/rns/pub/cycles

Endpoints (20 total)

GET

/api/rns/settings

Get Subscription Settings

GET

/api/rns/pvt/plans

List plans

GET

/api/rns/pub/cycles

List cycles

GET

/api/rns/pvt/reports

List report templates

GET

/api/rns/pvt/plans/{id}

Get plan details

GET

/api/rns/pub/subscriptions

List subscriptions

GET

/api/rns/pub/cycles/{cycleId}

Get cycle details

GET

/api/rns/pub/subscriptions/{id}

Get subscription details

GET

/api/rns/pvt/reports/{reportName}/documents/{documentId}

Get report document details

GET

/api/rns/pub/subscriptions/{subscriptionId}/conversation-message

Get conversation messages

POST

/api/rns/settings

Edit Subscriptions settings

POST

/api/rns/pub/subscriptions

Create subscription