Create Payment Request Stripe Invoice

POST 
/api/sales-payment-requests/:salesPaymentRequest/stripe-checkout

Send the customer a Stripe hosted invoice for the payment request's balance. The Stripe invoice is raised on the sales order, so the payment Stripe records lands on the order and pays the request.

Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Requires permission sales_payment_requests.send.

Body fields:

• integration_instance_id (integer, required — the Stripe account)
• customer_email (string email, optional — overrides the customer's email)

Request

Responses

201

Created

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not Found

Response Headers

Content-Type

422

Unprocessable Entity

Response Headers

Content-Type

429

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.