List Sales Order PayPal Pay Links
GET/api/sales-orders/:salesOrderId/paypal-payment-links
Lists every PayPal pay link on one sales order, newest first, with each link's PayPal payments (fee, refunded and remaining refundable amounts, dispute status, and refund_unavailable_reason — why the payment can't be refunded through SKU.io right now, such as a disconnected PayPal account, or null when it can).
Authentication: Requires Bearer token.
meta.amount_due is what a new link may ask for: the order balance less PayPal payments still clearing. An active link asking for more than this can no longer be paid.
Returns 404 when the sales order does not exist.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
meta.amount_due is 0 for a cancelled order. Each link's attention is set when staff must check a payment still clearing in PayPal themselves: "Account disconnected — check PayPal", "API keys need updating — check PayPal" (PayPal refused the account's keys), or "Still clearing after 30 days — check PayPal" (past the 15-minute check's window); otherwise null.
Request
Responses
- 200
- 401
- 403
- 404
- 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
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.