Send payment reminder
send_reminderEmails a payment reminder, with the invoice PDF attached, to the recipient email stored on the invoice. Use it to chase an unpaid invoice. The email goes to a third party and cannot be recalled. It fails if the invoice is not finalized, is a credit note, is paid, is not past its due date or has no recipient email, and a second reminder for the same invoice shortly after the last one is refused. Without a tier it sends the tier the automatic reminders would send now (friendly, second_notice, final_notice) and fails if none is due yet. With a tier it sends that tier whatever the day thresholds say, and fails if that tier was already sent; get_email_history lists the reminders already sent. The remindersEnabled setting of the account only governs the automatic reminders and does not stop this tool, and neither does the reminders switch on the invoice itself. The wording of the reminder cannot be changed. The reminder is recorded in the email history.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tier | No | Reminder tier. If omitted, auto-detects the next tier. | |
| invoiceId | Yes | Invoice ID |