Subscription Information
curl --request GET \
--url https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "active",
"expiresAt": 1731984105000,
"tokenLocator": "base:0xdC46584d76aCcc879d682Ed2d9c7338f8FdbF1cC:1",
"collection": {
"id": "28c5bc10-1964-4d94-b45b-0e1dab1cd346"
},
"owner": "0x62e2cb5f9Ac87cf91358395fdB6797ADb7EA9E38",
"payment": {
"type": "recurring-credit-card",
"status": "active",
"recurring": {
"interval": "month",
"intervalCount": 1
},
"lastChargeDate": 1731984105000,
"nextChargeDate": 1731984105000
}
}{
"error": true,
"message": "Invalid subscription ID format or missing required parameters."
}{
"error": true,
"message": "API key provided doesn't have the required scopes or is invalid."
}{
"error": true,
"message": "Subscription not found."
}{
"error": true,
"message": "Service is temporarily unavailable. Please try again later or contact support if the issue persists."
}Subscription Information
Retrieve information about an existing subscription, including expiry time, payment information and recurrency status.
API scope required: subscriptions.read
GET
/
2022-06-09
/
subscriptions
/
{subscriptionLocator}
Subscription Information
curl --request GET \
--url https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.crossmint.com/api/2022-06-09/subscriptions/{subscriptionLocator}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "active",
"expiresAt": 1731984105000,
"tokenLocator": "base:0xdC46584d76aCcc879d682Ed2d9c7338f8FdbF1cC:1",
"collection": {
"id": "28c5bc10-1964-4d94-b45b-0e1dab1cd346"
},
"owner": "0x62e2cb5f9Ac87cf91358395fdB6797ADb7EA9E38",
"payment": {
"type": "recurring-credit-card",
"status": "active",
"recurring": {
"interval": "month",
"intervalCount": 1
},
"lastChargeDate": 1731984105000,
"nextChargeDate": 1731984105000
}
}{
"error": true,
"message": "Invalid subscription ID format or missing required parameters."
}{
"error": true,
"message": "API key provided doesn't have the required scopes or is invalid."
}{
"error": true,
"message": "Subscription not found."
}{
"error": true,
"message": "Service is temporarily unavailable. Please try again later or contact support if the issue persists."
}Authorizations
Obtained in the Crossmint developer console
Path Parameters
The unique identifier for the subscription, formatted as chain:contractAddress:tokenId.
This locator references the specific token associated with the subscription.
Example:
"base:0x1234567890123456789012345678901234567890:1"
Response
Subscription information
Available options:
active, expired Example:
1731984105000
Example:
"base:0xdC46584d76aCcc879d682Ed2d9c7338f8FdbF1cC:1"
Show child attributes
Show child attributes
Example:
"0x62e2cb5f9Ac87cf91358395fdB6797ADb7EA9E38"
Show child attributes
Show child attributes
Was this page helpful?

