Generate customer portal magic link

Generates a secure, time-limited magic link that allows customers to access and manage their subscriptions. This passwordless authentication link directs customers to the subscription management portal.

Full behavior, validation rules, and side effects

Magic Link Features:

• Passwordless Access: No login credentials required, link serves as authentication
• Time-Limited: Link expires after configured duration (typically 24-72 hours)
• Single Customer: Link is bound to specific customer ID, cannot be reused for others
• Secure Token: Uses cryptographically secure JWT tokens for authentication
• Customer Portal: Directs to full-featured self-service subscription portal

Returned Information:

• Magic Link URL: Full URL to customer portal with embedded authentication token
• Token: JWT token value (can be used separately if needed)
• Expiration Time: When the magic link will expire (ISO 8601 format)
• Customer ID: Shopify customer ID the link is generated for
• Shop Domain: Store domain where subscriptions are hosted

Customer Portal Capabilities (via Magic Link):

• View all active and paused subscription contracts
• Update shipping address for upcoming deliveries
• Change payment method for future billing
• Pause or resume subscription deliveries
• Skip upcoming delivery orders
• Modify delivery frequency (e.g., monthly to bi-monthly)
• Add or remove products from subscription
• Swap product variants (size, flavor, color)
• Cancel subscription with reason feedback
• View order history and upcoming deliveries
• Apply discount codes to subscription

Common Use Cases:

• Send magic link via email for customer self-service
• Include link in transactional emails (order confirmation, shipping notices)
• Customer support: provide link to customers over phone/chat
• Embed link in customer account page or dashboard
• Automated email campaigns for subscription management reminders
• Post-purchase flows to encourage subscription modifications
• Win-back campaigns: send magic link to cancelled/paused customers

Security Notes:

• Links are single-use per session (new token generated each time)
• Tokens include shop and customer validation to prevent tampering
• Expired links automatically redirect to token request page
• Links should be sent via secure channels (HTTPS, encrypted email)

Integration Best Practices:

• Always send magic links via email or SMS (don’t display on public pages)
• Set appropriate expiration time based on use case
• Include clear call-to-action in emails (“Manage Your Subscription”)
• Handle expired tokens gracefully with re-send functionality
• Track magic link generation for security audit logs

Authentication: Requires API key authentication via X-API-Key header or api_key parameter

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

Generate customer portal magic link

cURL

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/manage-subscription-link/{customerId}

200

{
  "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

200

application/json

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