Update Dunning Settings
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Request
Enable end-of-dunning outcome emails (subscription paused/canceled/left active). When unset, these follow the enable_emails toggle.
What to do with subscription if all payment attempts fail. Options: ‘cancel’ (default) or ‘leave_active’
What to do with invoice if all payment attempts fail. Options: ‘mark_uncollectible’ (default), ‘leave_open’, or ‘void’
Product IDs to exclude from dunning (empty or unset = dun all)
When a customer updates their payment method, immediately charge all past-due invoices. Invoices not yet due are not affected.
Retry the failed initial charge on incomplete subscriptions created outside of checkout (including via the dashboard or direct API calls). Subscriptions created through checkout are never dunned.
Enable reminder emails for unpaid invoices customers pay by link (send_invoice). Does not apply to automatically charged invoices.
Days before the due date to send the ‘invoice due soon’ reminder (1-14).
Days after the due date to send the ‘invoice overdue’ reminder (1-60).
Days after an unpaid invoice’s due date before failure handling applies (0-60). Applies to send_invoice invoices only.
Response
Enable automatic failed payment recovery retries. Defaults to False: an account that never configures dunning does not retry failed payments.
Enable automatic failed payment recovery (in-cycle retry) emails. Requires enable_retries: with retries off there is no retry cycle, so these are not sent (end-of-dunning outcome emails are separate — see enable_outcome_emails). Defaults to False: an account that never configures dunning sends no dunning emails.
Enable end-of-dunning outcome emails (subscription paused/canceled/left active). When unset (null), these follow the enable_emails toggle, preserving prior behavior; set explicitly to control them independently.
What to do with subscription if all payment attempts fail. Options: ‘cancel’ (default) or ‘leave_active’
What to do with invoice if all payment attempts fail. Options: ‘mark_uncollectible’ (default), ‘leave_open’, or ‘void’
Product IDs to exclude from dunning: an invoice is not dunned when every product on it is excluded (empty or unset means every product is dunned).
When a customer updates their payment method, immediately charge all past-due invoices. Invoices not yet due are not affected.
Retry the failed initial charge on incomplete subscriptions created outside of checkout (including via the dashboard or direct API calls). Requires enable_retries: with retries off the initial charge is not dunned. Defaults to False. Subscriptions created through checkout are never dunned.
Enable reminder emails for unpaid invoices customers pay by link (send_invoice). Defaults to False: an account that never configures reminders sends none. Does not apply to automatically charged invoices.
Days before the due date to send the ‘invoice due soon’ reminder (1-14).
Days after the due date to send the ‘invoice overdue’ reminder (1-60).
Days after an unpaid invoice’s due date before failure handling applies (0-60). Applies to send_invoice invoices only; automatically charged invoices are unaffected.