Skip to main content
GET
/
api
/
external
/
v2
/
manage-subscription-link
/
{customerId}
Generate customer portal magic link
curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/manage-subscription-link/{customerId}
import requests

url = "https://membership-admin.appstle.com/api/external/v2/manage-subscription-link/{customerId}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://membership-admin.appstle.com/api/external/v2/manage-subscription-link/{customerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
const url = 'https://membership-admin.appstle.com/api/external/v2/manage-subscription-link/{customerId}';
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://membership-admin.appstle.com/api/external/v2/manage-subscription-link/{customerId}",
  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://membership-admin.appstle.com/api/external/v2/manage-subscription-link/{customerId}"

	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://membership-admin.appstle.com/api/external/v2/manage-subscription-link/{customerId}")

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://myshop.com/apps/memberships/cp/manage?token=abc123",
  "tokenExpirationTime": "2023-11-07T05:31:56Z"
}
{
  "manageSubscriptionLink": "https://myshop.com/apps/memberships/cp/manage?token=abc123",
  "tokenExpirationTime": "2023-11-07T05:31:56Z"
}
{
  "manageSubscriptionLink": "https://myshop.com/apps/memberships/cp/manage?token=abc123",
  "tokenExpirationTime": "2023-11-07T05:31:56Z"
}
{
  "manageSubscriptionLink": "https://myshop.com/apps/memberships/cp/manage?token=abc123",
  "tokenExpirationTime": "2023-11-07T05:31:56Z"
}

Headers

​
X-API-Key
string

Path Parameters

​
customerId
integer<int64>
required

Shopify customer ID

Query Parameters

​
api_key
string

API Key (Deprecated - Use Header X-API-Key instead)

Response

Magic link generated successfully, returns link URL and expiration time

​
manageSubscriptionLink
string

URL link for customers to manage their subscription

Example:

"https://myshop.com/apps/memberships/cp/manage?token=abc123"

​
tokenExpirationTime
string<date-time>

Expiration timestamp of the management token