Bolt has moved to boltapp.com. Stores still using bolt.com hosts must update now: see the migration guide.

Skip to content

Get dunning settings

View As MarkdownMCP
GET
/v1/subscriptions/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.

Authorization

X-API-Key<token>

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

seller_id?string

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

X-Bolt-Connect-Seller-Id?string

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}