Skip to content

Get Dunning Settings

GET
/v1/subscriptions/dunning_settings

Get the merchant division's dunning (failed payment recovery) settings. If the division has never configured these settings, Bolt's defaults are returned.

Authorization

X-API-Key
X-API-Key<token>

Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard.

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-Publishable-Key*string

The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard.

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" \  -H "X-Publishable-Key: string"
{  "retry_schedule_hours": [    24,    72,    168,    336  ],  "reminder_lead_days": [    30,    7,    3  ],  "final_action": "cancel",  "sms_enabled": false}