Generate customer portal link

Generates a secure, time-limited link that allows customers to access their subscription management portal. This link provides customers with self-service capabilities to manage their subscriptions without requiring login credentials.

Full behavior, validation rules, and side effects

Key Features:

• Generates unique encrypted token for customer authentication
• Token expires after 2 hours for security
• Direct access to subscription management without password
• Uses store’s custom domain when available
• Supports white-label customer portals

Token Security:

• Token contains encrypted customer ID, shop, and timestamp
• Cannot be reused after expiration
• Unique token generated for each request
• Cryptographically secure encryption

Customer Portal Access: Once customers click the link, they can:

• View all active subscriptions
• Update payment methods
• Change delivery addresses
• Modify product quantities
• Pause or cancel subscriptions
• Update delivery schedules
• Apply discount codes
• View order history

Use Cases:

• Email campaigns with ‘Manage Subscription’ CTAs
• Customer service providing quick access
• Post-purchase email flows
• Account management integrations
• Reducing support ticket volume

URL Structure: The generated URL follows this pattern: https://[store-domain]/[manage-subscription-path]?token=[encrypted-token]

Important Notes:

• Links are single-use and expire after 2 hours
• New link must be generated after expiration
• Customer ID must be valid and active
• Store must have customer portal configured

Authentication: Requires valid X-API-Key header

GET /api/external/v2/manage-subscription-link/{customerId}

Generate customer portal link

cURL

curl --request GET \
  --url https://subscription-admin.appstle.com/api/external/v2/manage-subscription-link/{customerId} \
  --header 'X-API-Key: <x-api-key>'

200

Success Response

{
  "manageSubscriptionLink": "https://store.example.com/pages/manage-subscriptions?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaG9wIjoic3RvcmUuZXhhbXBsZS5jb20iLCJjdXN0b21lcklkIjo5ODc2NTQzMjEsImNyZWF0ZWRBdCI6MTcxMDUxMjQwMDAwMH0.dGhpcyBpcyBhIHNhbXBsZSB0b2tlbiBmb3IgZG9jdW1lbnRhdGlvbg",
  "tokenExpirationTime": "2024-03-15T16:30:00.000Z",
  "expiresInMinutes": 120,
  "customerId": 987654321,
  "portalUrl": "https://store.example.com/pages/manage-subscriptions"
}

Headers

X-API-Key · string · required

API Key for authentication

Path Parameters

customerId · integer<int64> · required

Customer ID to generate portal link for. Provide the numeric ID without the gid:// prefix

Required range: x >= 1

Query Parameters

api_key · string

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

Response

200

application/json

Manage subscription link successfully generated

manageSubscriptionLink · string

tokenExpirationTime · string<date-time>