Preview New PayPal Pay Link Email
POST/api/sales-orders/:salesOrderId/paypal-payment-links/email-preview
Returns the PayPal Payment Request email a pay link about to be created would be sent with. The amount and expiry date are the ones given; the link's address, which doesn't exist yet, appears as a placeholder.
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.
Body fields:
amount(number, required, min 0.01) — the link amount.expires_in_days(integer, optional, 1-365, default 30).recipient_email(string, optional) — shown astoinstead of the customer's email.cc(array of strings, optional, max 10) — extra CC addresses; each must be a valid email.
Returns 422 when validation fails or the template is missing or turned off; 404 when the sales order 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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.