Get Payment Request
GET/api/sales-payment-requests/:salesPaymentRequest
Get one payment request. paid_amount is derived from the money recorded on the sales order (oldest document first); settled_on lists the invoices that money was later applied to; pay_links are the order's online pay links (PayPal, Stripe hosted invoice, buyer portal); send_blocked_reason explains why the request can't be emailed (for example, the customer has no billing email).
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Requires permission sales_payment_requests.show.
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.