Update Dunning Settings | PaymentKit

Update dunning settings for an account.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Request

This endpoint expects an object.

enable_retriesboolean or nullOptional

Enable automatic failed payment recovery retries

enable_emailsboolean or nullOptional

Enable automatic failed payment recovery emails

contact_infoobject or nullOptional

Contact information for dunning emails

subscription_status_on_failurestring or nullOptional

What to do with subscription if all payment attempts fail. Options: ‘cancel’ (default) or ‘leave_active’

invoice_status_on_failurestring or nullOptional

What to do with invoice if all payment attempts fail. Options: ‘mark_uncollectible’ (default) or ‘leave_open’

apply_to_product_idslist of strings or nullOptional

List of product IDs to apply dunning to

settle_past_due_on_pm_updateboolean or nullOptional

Settle all open past due invoices when a payment method is updated

update_renewal_on_overdue_paidboolean or nullOptional

Update subscription renewal date when overdue invoices are paid

Response

Successful Response

enable_retriesboolean or nullDefaults to true

Enable automatic failed payment recovery retries

enable_emailsboolean or nullDefaults to true

Enable automatic failed payment recovery emails

contact_infoobject or null

Contact information for dunning emails

subscription_status_on_failurestring or null

What to do with subscription if all payment attempts fail. Options: ‘cancel’ (default) or ‘leave_active’

invoice_status_on_failurestring or null

What to do with invoice if all payment attempts fail. Options: ‘mark_uncollectible’ (default) or ‘leave_open’

apply_to_product_idslist of strings or null

List of product IDs to apply dunning to (empty means all products)

settle_past_due_on_pm_updateboolean or nullDefaults to true