Attach a receipt email
Records the buyer’s email on a pending order so the receipt and any delivery can be sent.
Order checkouts only — an invoice’s recipient is set by the merchant who issued it. The address is never echoed back; the checkout payload only reports hasCustomerEmail.
Unauthenticated: possession of the checkout id is the credential, so send no API key. The id is unguessable and every payload is redacted for a buyer audience.
Path Parameters
The checkout to read — an order id or an invoice id. Base58 short id, 21–22 characters (never 0, O, I or l), e.g. 7Kq2mVn8pRt3XwYz5Bd4L — the value that appears in checkout and invoice links, and the one this API takes as a path id.
^[1-9A-HJ-NP-Za-km-z]{21,22}$"7Kq2mVn8pRt3XwYz5Bd4L"
Body
Where to send the receipt and any digital delivery. Recorded on the order and never echoed back — reads only report hasCustomerEmail.
"buyer@example.com"
Response
The email was recorded.
Acknowledgement that the buyer's receipt email was recorded.
True once an address is on file. The address itself is never echoed back.
true