v2

latestOpenAPI 3.0.02026-07-3139594346.4 KB

Subscriptions

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

get/v1/subscriptions/dunning_settings

Query parameters

seller_idstring

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.

Headers

X-Publishable-Keystring 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-Idstring

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

Success

retry_schedule_hoursinteger[] 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).

reminder_lead_daysinteger[] 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.

final_action'cancel' | 'pause' required

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

sms_enabledboolean required

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

Example response

{
  "retry_schedule_hours": [
    24,
    72,
    168,
    336
  ],
  "reminder_lead_days": [
    30,
    7,
    3
  ],
  "final_action": "cancel"
}