Customers
Generate customer portal access link by customer ID or email
Generates a link that opens the Subscriptions customer portal signed in as the customer, with no password. Identify the customer with customerId or emailId. Call it from your server, never from a browser, where your API key would be exposed.
Finding the customer:
- Send
customerIdoremailId. If you send both,customerIdis used andemailIdis ignored customerIdisn’t looked up: any numeric customer ID gets a link, so send a Shopify customer ID you knowemailIdonly finds a customer who has, or had, a subscription on the store, using the email saved on that subscription. URL-encode it, because+in an address must be sent as%2B
How the link works:
- The response has
manageSubscriptionLinkandtokenExpirationTime - A link can be opened any number of times until it expires, 2 hours after it was generated. The window is fixed: no parameter or setting changes it
- Generate a new link each time you send one, and treat links like passwords
- The link’s host is the Public Domain in Shop Settings when the store has one, and its myshopify.com domain otherwise
Authentication: Send a Read & Write API key in the X-API-Key header. A Read only key gets 403.
GET
/
api
/
external
/
v2
/
manage-subscription-link
Generate customer portal access link by customer ID or email
curl --request GET \
--url https://subscription-admin.appstle.com/api/external/v2/manage-subscription-linkimport requests
url = "https://subscription-admin.appstle.com/api/external/v2/manage-subscription-link"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://subscription-admin.appstle.com/api/external/v2/manage-subscription-link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://subscription-admin.appstle.com/api/external/v2/manage-subscription-link';
const options = {method: 'GET'};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://subscription-admin.appstle.com/api/external/v2/manage-subscription-link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://subscription-admin.appstle.com/api/external/v2/manage-subscription-link"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://subscription-admin.appstle.com/api/external/v2/manage-subscription-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"manageSubscriptionLink": "https://your-store.myshopify.com/apps/subscriptions?token=TOKEN",
"tokenExpirationTime": "2026-11-13T00:43:23.175875994Z"
}{
"detail": "An unexpected error occurred. Please try again later.",
"message": "error.http.500",
"path": "/api/external/v2/manage-subscription-link",
"status": 500,
"title": "Internal Server Error",
"type": "https://appstle.com/problem/problem-with-message"
}{
"error": "Unauthorized",
"path": "/api/external/v2/manage-subscription-link",
"status": 401,
"timestamp": "2026-11-13T04:03:05.733+00:00"
}{
"detail": "This API key is read-only and cannot perform write operations.",
"status": 403,
"title": "Forbidden"
}Query Parameters
Response
The link and the time it expires
⌘I
Generate customer portal access link by customer ID or email
curl --request GET \
--url https://subscription-admin.appstle.com/api/external/v2/manage-subscription-linkimport requests
url = "https://subscription-admin.appstle.com/api/external/v2/manage-subscription-link"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://subscription-admin.appstle.com/api/external/v2/manage-subscription-link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://subscription-admin.appstle.com/api/external/v2/manage-subscription-link';
const options = {method: 'GET'};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://subscription-admin.appstle.com/api/external/v2/manage-subscription-link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://subscription-admin.appstle.com/api/external/v2/manage-subscription-link"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://subscription-admin.appstle.com/api/external/v2/manage-subscription-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"manageSubscriptionLink": "https://your-store.myshopify.com/apps/subscriptions?token=TOKEN",
"tokenExpirationTime": "2026-11-13T00:43:23.175875994Z"
}{
"detail": "An unexpected error occurred. Please try again later.",
"message": "error.http.500",
"path": "/api/external/v2/manage-subscription-link",
"status": 500,
"title": "Internal Server Error",
"type": "https://appstle.com/problem/problem-with-message"
}{
"error": "Unauthorized",
"path": "/api/external/v2/manage-subscription-link",
"status": 401,
"timestamp": "2026-11-13T04:03:05.733+00:00"
}{
"detail": "This API key is read-only and cannot perform write operations.",
"status": 403,
"title": "Forbidden"
}