Get dunning settings
Returns the division's dunning (failed payment recovery) settings. A division that has never configured them returns Bolt's defaults.
The retry schedule's shape depends on how the division renews. Divisions renewing by invoice (Bolt Cart) return retry_schedule_days and no final_action: the subscription pauses after the last failed retry and resumes on its own once the invoice is paid or voided. Divisions renewing by stored card return retry_schedule_hours and final_action.
Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard. Send it together with X-Publishable-Key.
In: header
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.
Header 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. Ignored if the seller_id query parameter is also set.
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/subscriptions/dunning_settings"{ "retry_schedule_hours": [ 24, 72, 168, 336 ], "retry_schedule_days": [ 3, 7, 14 ], "reminder_lead_days": [ 30, 7, 3 ], "reminder_enabled": false, "final_action": "cancel", "sms_enabled": false}Revoke a scheduled cancellation POST
Withdraws a cancel that was scheduled with `at_period_end=true`. The subscription keeps renewing as if the cancel was never requested. Only subscriptions that renew by invoice support scheduled cancels.
Update dunning settings PUT
Replaces the division's dunning (failed payment recovery) configuration; omitted fields are not merged with the previous settings. Divisions renewing by invoice (Bolt Cart) send `retry_schedule_days` and must not send `retry_schedule_hours` or `final_action`: the subscription always pauses after the last failed retry. `reminder_enabled` and `sms_enabled` are required. Divisions renewing by stored card send `retry_schedule_hours` and `final_action`, and must not send `retry_schedule_days`. `reminder_enabled` keeps its stored value when omitted.