PUT
Update Dunning Settings

Authorizations

X-API-Key
string
header
required

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

Headers

X-Publishable-Key
string
required

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.

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.

Body

application/json

Dunning Settings

A merchant division's dunning (failed payment recovery) configuration.

retry_schedule_hours
integer[]
required

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).

Example:
reminder_lead_days
integer[]
required

Days before a subscription's renewal at which Bolt sends the shopper a reminder. Must be 1-10 unique values between 1 and 90.

Example:
final_action
enum<string>
required

The action Bolt takes on a subscription once the retry schedule is exhausted without a successful payment.

Available options:
cancel,
pause
Example:

"cancel"

sms_enabled
boolean
required

Whether Bolt sends SMS reminders and payment-failure notifications to the shopper, in addition to email.

Example:

false

Response

Success

A merchant division's dunning (failed payment recovery) configuration.

retry_schedule_hours
integer[]
required

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).

Example:
reminder_lead_days
integer[]
required

Days before a subscription's renewal at which Bolt sends the shopper a reminder. Must be 1-10 unique values between 1 and 90.

Example:
final_action
enum<string>
required

The action Bolt takes on a subscription once the retry schedule is exhausted without a successful payment.

Available options:
cancel,
pause
Example:

"cancel"

sms_enabled
boolean
required

Whether Bolt sends SMS reminders and payment-failure notifications to the shopper, in addition to email.

Example:

false