vtex.local

API provider — vtex.local:Recurrence-(v1-

🔑 apikey 11 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 Subscriptions

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

Get self Subscription

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/subscriptions/me

Get Subscription settings

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

Endpoints (11 total)

GET

/subscriptions

Get Subscriptions

GET

/subscriptions/me

Get self Subscription

GET

/subscriptions/settings

Get Subscription settings

GET

/subscriptions/{recurrenceId}

Get Subscription by recurrenceId

GET

/subscriptions/{recurrenceid}/accounts

Get payment accounts

GET

/subscriptions/{recurrenceId}/addresses

Get Subscription addresses

POST

/subscriptions/{recurrenceId}/items

Add Subscription item

PUT

/subscriptions

Update Subscription

PUT

/subscriptions/settings

Update Subscription settings

PATCH

/subscriptions/{recurrenceId}

Update partial Subscription

PATCH

/subscriptions/{recurrenceId}/reindex

Reindex Subscription