Subscriptions API (v3)

vtex · Company

Company No Auth Free & Open API

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](https://help.vtex.com/tutorial/how-to-configure-subscriptions%20--1FA9dfE7vJqxBna9Nft5Sj) in your store, the Subscriptions API allows you to create, manage and monitor your customers' subscriptions. ![image](https://user-images.githubusercontent.com/77292838/213024675-9407863b-0c55-4282-9442

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET List cycles

List cycles filtering by some arguments.

https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/cycles?page=1&size=15&status=example&endDate=example&beginDate=example&customerEmail=example&subscriptionId=example

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/cycles?page=1&size=15&status=example&endDate=example&beginDate=example&customerEmail=example&subscriptionId=example" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "page": "1",
    "size": "15",
    "status": "example",
    "endDate": "example",
    "beginDate": "example",
    "customerEmail": "example",
    "subscriptionId": "example"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/cycles",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/cycles');
url.searchParams.set('page', '1');
url.searchParams.set('size', '15');
url.searchParams.set('status', 'example');
url.searchParams.set('endDate', 'example');
url.searchParams.set('beginDate', 'example');
url.searchParams.set('customerEmail', 'example');
url.searchParams.set('subscriptionId', 'example');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/cycles")
	q := baseURL.Query()
	q.Set("page", "1")
	q.Set("size", "15")
	q.Set("status", "example")
	q.Set("endDate", "example")
	q.Set("beginDate", "example")
	q.Set("customerEmail", "example")
	q.Set("subscriptionId", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/cycles")
uri.query = URI.encode_www_form({
  "page" => "1",
  "size" => "15",
  "status" => "example",
  "endDate" => "example",
  "beginDate" => "example",
  "customerEmail" => "example",
  "subscriptionId" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/cycles?" . http_build_query([
    "page" => "1",
    "size" => "15",
    "status" => "example",
    "endDate" => "example",
    "beginDate" => "example",
    "customerEmail" => "example",
    "subscriptionId" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET List subscriptions

List subscriptions filtering by some arguments.

https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/subscriptions?page=1&size=15&planId=example&status=example&addressId=example&paymentId=example&customerEmail=example&originalOrderId=example&nextPurchaseDate=example

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/subscriptions?page=1&size=15&planId=example&status=example&addressId=example&paymentId=example&customerEmail=example&originalOrderId=example&nextPurchaseDate=example" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "page": "1",
    "size": "15",
    "planId": "example",
    "status": "example",
    "addressId": "example",
    "paymentId": "example",
    "customerEmail": "example",
    "originalOrderId": "example",
    "nextPurchaseDate": "example"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/subscriptions",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/subscriptions');
url.searchParams.set('page', '1');
url.searchParams.set('size', '15');
url.searchParams.set('planId', 'example');
url.searchParams.set('status', 'example');
url.searchParams.set('addressId', 'example');
url.searchParams.set('paymentId', 'example');
url.searchParams.set('customerEmail', 'example');
url.searchParams.set('originalOrderId', 'example');
url.searchParams.set('nextPurchaseDate', 'example');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/subscriptions")
	q := baseURL.Query()
	q.Set("page", "1")
	q.Set("size", "15")
	q.Set("planId", "example")
	q.Set("status", "example")
	q.Set("addressId", "example")
	q.Set("paymentId", "example")
	q.Set("customerEmail", "example")
	q.Set("originalOrderId", "example")
	q.Set("nextPurchaseDate", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/subscriptions")
uri.query = URI.encode_www_form({
  "page" => "1",
  "size" => "15",
  "planId" => "example",
  "status" => "example",
  "addressId" => "example",
  "paymentId" => "example",
  "customerEmail" => "example",
  "originalOrderId" => "example",
  "nextPurchaseDate" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pub/subscriptions?" . http_build_query([
    "page" => "1",
    "size" => "15",
    "planId" => "example",
    "status" => "example",
    "addressId" => "example",
    "paymentId" => "example",
    "customerEmail" => "example",
    "originalOrderId" => "example",
    "nextPurchaseDate" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET List plans

List plans filtering by some arguments.

https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pvt/plans?page=1&size=15&interval=example&periodicity=example

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pvt/plans?page=1&size=15&interval=example&periodicity=example" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

import requests
params = {
    "page": "1",
    "size": "15",
    "interval": "example",
    "periodicity": "example"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pvt/plans",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pvt/plans');
url.searchParams.set('page', '1');
url.searchParams.set('size', '15');
url.searchParams.set('interval', 'example');
url.searchParams.set('periodicity', 'example');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pvt/plans")
	q := baseURL.Query()
	q.Set("page", "1")
	q.Set("size", "15")
	q.Set("interval", "example")
	q.Set("periodicity", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pvt/plans")
uri.query = URI.encode_www_form({
  "page" => "1",
  "size" => "15",
  "interval" => "example",
  "periodicity" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v3)/1.0/api/rns/pvt/plans?" . http_build_query([
    "page" => "1",
    "size" => "15",
    "interval" => "example",
    "periodicity" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Subscriptions API (v3)?

Subscriptions API (v3) is a Company API. Developers commonly use company APIs for:

enriching CRM records with company firmographics
building lead-generation and prospecting tools
verifying business identity and registration details
monitoring competitors and market intelligence
powering B2B data enrichment pipelines

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Subscriptions API (v3) is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗