Sends a request payment email to the customer using the site's published Collect Payment Email Engage notification template.
Use this operation to manually trigger a payment request email when you want the customer to pay outstanding invoices.
Async-only
This operation is asynchronous only. You must send Prefer: respond-async, a unique chargebee-request-id, and a chargebee-async-callback-url. The HTTP response is 202 Accepted with an empty body. When processing completes, Chargebee delivers the outcome to your async callback URL — a successful result contains email_logs.
Prerequisites & Constraints
- Email Engage V2 must be enabled for the site.
- The Collect Payment Email notification template must be published and enabled.
- The from address configured for the notification template must be verified.
- The customer must have a valid email address.
- The customer must have at least one unpaid invoice.
Sample Request
Sample Result[JSON]
URL Format
POST https://[site].chargebee.com/api/v2/customers/{customer-id}/send_payment_request
Returns
always returned
List of email log objects for the send request. Each entry describes one email that was sent or attempted.