Update Dunning Settings
Update the merchant division’s dunning (failed payment recovery) settings. This replaces the full configuration; omitted fields are not merged with the previous settings.
Authorizations
Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.
Headers
The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard.
For Bolt Connect marketplace integrations, the seller's external ID. When provided, the request acts on the seller's division rather than the caller's own division. Ignored if the seller_id query parameter is also set.
Query Parameters
For Bolt Connect marketplace integrations, the seller's external ID. When provided, the request acts on the seller's division rather than the caller's own division. Takes precedence over the X-Bolt-Connect-Seller-Id header if both are set.
Body
Dunning Settings
A merchant division's dunning (failed payment recovery) configuration.
Hour offsets from the initial payment failure at which Bolt retries the payment. Must be 1-10 strictly increasing, positive values, each at most 2160 (90 days).
Days before a subscription's renewal at which Bolt sends the shopper a reminder. Must be 1-10 unique values between 1 and 90.
The action Bolt takes on a subscription once the retry schedule is exhausted without a successful payment.
cancel, pause "cancel"
Whether Bolt sends SMS reminders and payment-failure notifications to the shopper, in addition to email.
false
Response
Success
A merchant division's dunning (failed payment recovery) configuration.
Hour offsets from the initial payment failure at which Bolt retries the payment. Must be 1-10 strictly increasing, positive values, each at most 2160 (90 days).
Days before a subscription's renewal at which Bolt sends the shopper a reminder. Must be 1-10 unique values between 1 and 90.
The action Bolt takes on a subscription once the retry schedule is exhausted without a successful payment.
cancel, pause "cancel"
Whether Bolt sends SMS reminders and payment-failure notifications to the shopper, in addition to email.
false