Get Dunning Settings

GET

/api/accounts/:account_id/dunning-settings

GET

/api/accounts/:account_id/dunning-settings

$ curl https://app.paymentkit.com/api/accounts/account_id/dunning-settings \
>      -H "Authorization: Bearer <token>"

1 {
2   "enable_retries": true,
3   "enable_emails": true,
4   "contact_info": {
5     "from_email": "billing@example.com",
6     "reply_to_email": "support@example.com",
7     "email_signature_title": "Billing Department",
8     "email_signature_name": "John Smith",
9     "cc_recipients": [
10       "cc1@merchant.com",
11       "cc2@merchant.com"
12     ],
13     "bcc_recipients": [
14       "bcc1@merchant.com",
15       "bcc2@merchant.com"
16     ]
17   },
18   "subscription_status_on_failure": "cancel",
19   "invoice_status_on_failure": "mark_uncollectible",
20   "apply_to_product_ids": [
21     "prod_abc123",
22     "prod_def456"
23   ],
24   "settle_past_due_on_pm_update": true,
25   "update_renewal_on_overdue_paid": true
26 }

Get dunning settings for an account.

Authentication

AuthorizationBearer

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

Path parameters

account_idstringRequired

Response

Successful Response

enable_retriesboolean or nullOptionalDefaults to false

Enable automatic failed payment recovery retries. Defaults to False: an account that never configures dunning does not retry failed payments.

enable_emailsboolean or nullOptionalDefaults to false

Enable automatic failed payment recovery emails. Defaults to False: an account that never configures dunning sends no dunning 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), ‘leave_open’, or ‘void’

apply_to_product_idslist of strings or nullOptional

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

settle_past_due_on_pm_updateboolean or nullOptionalDefaults to true

When a customer updates their payment method, immediately charge all past-due invoices. Invoices not yet due are not affected.

update_renewal_on_overdue_paidboolean or nullOptionalDefaults to true

Update subscription renewal date when overdue invoices are paid

Errors

422

Unprocessable Entity Error