Skip to main content
GET
Generate customer portal access link by customer ID or email

Headers

X-API-Key
string

Query Parameters

api_key
string
customerId
integer<int64>

The customer's Shopify ID: the number at the end of gid://shopify/Customer/987654321. Send this or emailId

emailId
string

The customer's email, as saved on their subscription. Send this or customerId

Response

The link and the time it expires

The link that opens the customer portal signed in as the customer

Example:

"https://your-store.myshopify.com/apps/subscriptions?token=TOKEN"

tokenExpirationTime
string<date-time>

When the link expires, 2 hours after it was generated

Example:

"2026-11-13T00:43:23.175875994Z"