Preview PayPal Pay Link Email
GET/api/paypal-payment-links/:id/email-preview
Returns the PayPal Payment Request email exactly as Email PayPal Pay Link would send it for this link: to (the order's customer email, or null when it has none), cc (the template's CC addresses), subject and the HTML body with every placeholder filled.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token with permission to manage sales order payments.
An archived store-specific template is skipped in favour of the default store's template. Returns 422 when the link can't be emailed (not active, or the order now owes less than the link) or the template is missing or turned off; 404 when the link does not exist.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.