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

Skip to content

Update dunning settings

View As MarkdownMCP
PUT
/v1/subscriptions/dunning_settings

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.

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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The full dunning configuration to store; omitted fields are not merged with the previous settings. Which schedule field applies depends on the division's renewal engine - see the endpoint description.

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/subscriptions/dunning_settings" \  -H "Content-Type: application/json" \  -d '{    "reminder_lead_days": [      30,      7,      3    ]  }'
{  "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}