Emails the customer a link to pay for the order. The response also returns the link, so you can show or store it.

The link opens the order's payment page. There, the customer enters their own card and pays.

This call changes the order:

• A draft order moves to pending. An order past draft keeps its status.
• The order's channel becomes ECOM, because the customer enters their own card.
• initial_email_sent_on is set to the time of the call.

The link contains the order's access token. Anyone who has it can open the order's payment page. Don't log it or share it anywhere else.

You can't share a link for an order that is active or complete, or that has already taken a payment.

The customer needs a valid email address on their customer record, or the link can't reach them. Add it when you create the customer, or update the customer.

The link stops working if the order is cancelled before the customer pays. If your profile cancels unpaid orders automatically (Auto-Cancel After in the dashboard's processing details), a link left pending expires after that time.

Your user account needs Payment Link access turned on.