Checkout (public)

Ask for a receipt email

Saves the customer's email address so a receipt is sent once the invoice is paid. It only works when the server can send email, and only while the invoice has no email address yet. It never works for demo store (test mode) invoices; those answer 409 invalid_state. Rate limit: 5 per minute per IP address.

POST
/api/v1/invoices/{id}/email

Path Parameters

id*string

Invoice id, starting with inv_.

Request Body

application/json
  1. body
email*string
Formatemail
Lengthlength <= 200

Response Body

The email address was saved.

Example Request
curl -X POST 'https://example.com/api/v1/invoices/string/email' \  -H 'Content-Type: application/json' \  -d '{  "email": "user@example.com"}'
Example Response
Empty