Subscriptions API (v2 - DEPRECATED)
vtex · Company
VTEX Subscriptions REST API Documentation This documentation describes the available REST APIs for VTEX Subscription System. With Subscriptions you can set up regularly scheduled deliveries. All requests need authorization (VTEX Id authentication token or VTEX Appkey and Apptoken headers)
Authentication
No authentication requiredFree to use with no key needed.
Sample Requests
GET
Retrieve customer's subscriptions
Retrieves details of a given customer's subscriptions, searching by that customer's `customerId`.
https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v2)/1.0/subscriptions?customerId=[email protected]
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-(v2)/1.0/subscriptions?customerId=user%40vtex.com.br" \ -H "Accept: application/json" \ -H "Content-Type: application/json"
import requests
params = {
"customerId": "[email protected]"
}
headers = {
"Accept": "application/json",
"Content-Type": "application/json"
}
response = requests.get(
"https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v2)/1.0/subscriptions",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v2)/1.0/subscriptions');
url.searchParams.set('customerId', '[email protected]');
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-(v2)/1.0/subscriptions")
q := baseURL.Query()
q.Set("customerId", "[email protected]")
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-(v2)/1.0/subscriptions")
uri.query = URI.encode_www_form({
"customerId" => "[email protected]"
})
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-(v2)/1.0/subscriptions?" . http_build_query([
"customerId" => "[email protected]"
]);
$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
Retrieve Subscription report by date
Retrieves a report with the subscriptions created at the date interval requested
https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v2)/1.0/report/subscriptionsByDate?endDate=20190701&beginDate=20190101&requesterEmail=[email protected]
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-(v2)/1.0/report/subscriptionsByDate?endDate=20190701&beginDate=20190101&requesterEmail=user%40vtex.com.br" \ -H "Accept: application/json" \ -H "Content-Type: application/json"
import requests
params = {
"endDate": "20190701",
"beginDate": "20190101",
"requesterEmail": "[email protected]"
}
headers = {
"Accept": "application/json",
"Content-Type": "application/json"
}
response = requests.get(
"https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v2)/1.0/report/subscriptionsByDate",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v2)/1.0/report/subscriptionsByDate');
url.searchParams.set('endDate', '20190701');
url.searchParams.set('beginDate', '20190101');
url.searchParams.set('requesterEmail', '[email protected]');
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-(v2)/1.0/report/subscriptionsByDate")
q := baseURL.Query()
q.Set("endDate", "20190701")
q.Set("beginDate", "20190101")
q.Set("requesterEmail", "[email protected]")
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-(v2)/1.0/report/subscriptionsByDate")
uri.query = URI.encode_www_form({
"endDate" => "20190701",
"beginDate" => "20190101",
"requesterEmail" => "[email protected]"
})
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-(v2)/1.0/report/subscriptionsByDate?" . http_build_query([
"endDate" => "20190701",
"beginDate" => "20190101",
"requesterEmail" => "[email protected]"
]);
$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
Retrieve Subscription report by Status
Retrieves Subscriptions' reports, filtering by status. The report will be sent by email, to the address inserted in the API's path.
https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v2)/1.0/report/subscriptionsByStatus?status=1&requesterEmail=[email protected]
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-(v2)/1.0/report/subscriptionsByStatus?status=1&requesterEmail=user%40vtex.com.br" \ -H "Accept: application/json" \ -H "Content-Type: application/json"
import requests
params = {
"status": "1",
"requesterEmail": "[email protected]"
}
headers = {
"Accept": "application/json",
"Content-Type": "application/json"
}
response = requests.get(
"https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v2)/1.0/report/subscriptionsByStatus",
params=params,
headers=headers,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Subscriptions-API-(v2)/1.0/report/subscriptionsByStatus');
url.searchParams.set('status', '1');
url.searchParams.set('requesterEmail', '[email protected]');
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-(v2)/1.0/report/subscriptionsByStatus")
q := baseURL.Query()
q.Set("status", "1")
q.Set("requesterEmail", "[email protected]")
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-(v2)/1.0/report/subscriptionsByStatus")
uri.query = URI.encode_www_form({
"status" => "1",
"requesterEmail" => "[email protected]"
})
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-(v2)/1.0/report/subscriptionsByStatus?" . http_build_query([
"status" => "1",
"requesterEmail" => "[email protected]"
]);
$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
- See official documentation for authentication and setup.
What can you build with Subscriptions API (v2 - DEPRECATED)?
Subscriptions API (v2 - DEPRECATED) 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 (v2 - DEPRECATED) 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?