{ "opencollection": "1.0.0", "info": { "name": "Bolt API Reference", "version": "1.0.1" }, "request": { "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "items": [ { "info": { "name": "Account", "type": "folder" }, "items": [ { "info": { "name": "Get Account Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.boltapp.com/v1/account", "headers": [ { "name": "X-Publishable-Key", "value": "" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://api.boltapp.com/v1/oauth/authorize", "accessTokenUrl": "https://api.boltapp.com/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Fetch a shopper's account details to pre-fill checkout fields. This request must come from your backend for security purposes, as it requires the use of your private key to authenticate. For PCI compliance, only limited information is returned for each credit card available in the shopper’s wallet." }, { "info": { "name": "Create Bolt Account", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/account", "headers": [ { "name": "X-Publishable-Key", "value": "" }, { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a Bolt shopping account." }, { "info": { "name": "Update Profile", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.boltapp.com/v1/account/profile", "headers": [ { "name": "X-Publishable-Key", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://api.boltapp.com/v1/oauth/authorize", "accessTokenUrl": "https://api.boltapp.com/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update the identifiers for a shopper's profile (first name or last name)." }, { "info": { "name": "Add Address", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/account/addresses", "headers": [ { "name": "X-Publishable-Key", "value": "" }, { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://api.boltapp.com/v1/oauth/authorize", "accessTokenUrl": "https://api.boltapp.com/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Add an address to a shopper's account address book." }, { "info": { "name": "Replace Address", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/account/addresses/:id", "headers": [ { "name": "X-Publishable-Key", "value": "" }, { "name": "Idempotency-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for an address in the shopper's Address Book." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://api.boltapp.com/v1/oauth/authorize", "accessTokenUrl": "https://api.boltapp.com/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Replace an existing address in a shopper's address book.\nThese changes delete the existing address and create a new one.\n" }, { "info": { "name": "Edit Address", "type": "http" }, "http": { "method": "PUT", "url": "https://api.boltapp.com/v1/account/addresses/:id", "headers": [ { "name": "X-Publishable-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for an address in the shopper's Address Book." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://api.boltapp.com/v1/oauth/authorize", "accessTokenUrl": "https://api.boltapp.com/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Edit an existing address in a shopper's address book.\nThis endpoint fully replaces the information for an existing address while retaining the same address ID.\n" }, { "info": { "name": "Delete Address", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.boltapp.com/v1/account/addresses/:id", "headers": [ { "name": "X-Publishable-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID for an address in the shopper's Address Book." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://api.boltapp.com/v1/oauth/authorize", "accessTokenUrl": "https://api.boltapp.com/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an existing address in a shopper's address book.\n" }, { "info": { "name": "Detect Account", "type": "http" }, "http": { "method": "GET", "url": "https://api.boltapp.com/v1/account/exists", "headers": [ { "name": "X-Publishable-Key", "value": "" } ], "params": [ { "name": "email", "value": "", "type": "query", "description": "The shopper's email address is the primary mechanism for detecting an account. You **must** provide either a value for this parameter or for `sha256_email`." }, { "name": "sha256_email", "value": "", "type": "query", "description": "The sha256 hash of the shopper's normalized email address can be used to detect an account instead of `email`." }, { "name": "phone", "value": "", "type": "query", "description": "The shopper's phone number. Includes country code (e.g. +1); does not include dashes or spaces. Can be used to detect an account instead of `sha256_email` or `email`." } ] }, "docs": "Check whether an account exists using one of `email`, `phone`, or `sha256_email` as the unique identifier." }, { "info": { "name": "Add Payment Method", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/account/payment_methods", "headers": [ { "name": "X-Publishable-Key", "value": "" }, { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://api.boltapp.com/v1/oauth/authorize", "accessTokenUrl": "https://api.boltapp.com/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Add a payment method to a shopper's Bolt account Wallet. For security purposes, this request must come from your backend because authentication requires the use of your private key.\n\n**Note**: Before using this API, the credit card details must be tokenized using Bolt's JavaScript library function, which is documented in [Install the Bolt Tokenizer](https://help.boltapp.com/developers/references/bolt-tokenizer).\n" }, { "info": { "name": "Delete Payment Method", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.boltapp.com/v1/account/payment_methods/:payment_method_id", "headers": [ { "name": "X-Publishable-Key", "value": "" } ], "params": [ { "name": "payment_method_id", "value": "", "type": "path", "description": "The ID for a payment method in the shopper's Bolt account Wallet. This ID can be obtained using [Get Account Details](#tag/Account/operation/GetAccountDetails)." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://api.boltapp.com/v1/oauth/authorize", "accessTokenUrl": "https://api.boltapp.com/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a saved payment method from a shopper's Bolt account Wallet." } ] }, { "info": { "name": "Configuration", "type": "folder" }, "items": [ { "info": { "name": "Get Callback URLs", "type": "http" }, "http": { "method": "GET", "url": "https://api.boltapp.com/v1/merchant/callbacks", "params": [ { "name": "division_id", "value": "", "type": "query", "description": "The unique ID associated to the merchant's Bolt Account division; Merchants can have different divisions to suit multiple use cases (storefronts, pay-by-link, phone order processing). You can view and switch between these divisions from the Bolt Merchant Dashboard." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Retrieves callbacks URLs for a Bolt merchant division." }, { "info": { "name": "Set Callback URLs", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/merchant/callbacks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Configure callbacks URLs for a Bolt merchant division. This will store or override only the callback URLs that are specified in the request. Operations are fully transactional." }, { "info": { "name": "Get Merchant Identifiers", "type": "http" }, "http": { "method": "GET", "url": "https://api.boltapp.com/v1/merchant/identifiers", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "This endpoint returns the merchant's public ID and the [publishable key](https://help.boltapp.com/developers/tools/api-keys/) related to the merchant division." } ] }, { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Create Order Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/merchant/orders", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Make a request to this endpoint to create a Bolt order, generate a Bolt order token, and initiate the checkout process. A Bolt order token is required for Bolt orders; see Non-Bolt orders for alternative use cases." }, { "info": { "name": "Send order tracking details", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/merchant/track_shipment", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Send the carrier and order tracking number to Bolt (after a label has been printed). Bolt then uses EasyPost to forward ongoing tracking event updates to the shopper. This request must include **all** items included in the shipment; their references must also match those found in the original cart generation.\n" } ] }, { "info": { "name": "Statements", "type": "folder" }, "items": [ { "info": { "name": "Fetch a Statement", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/merchant/statement", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a pre-signed URL for the requested statement file." } ] }, { "info": { "name": "Transactions", "type": "folder" }, "items": [ { "info": { "name": "Authorize a Card", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/merchant/transactions/authorize", "headers": [ { "name": "X-Publishable-Key", "value": "" }, { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://api.boltapp.com/v1/oauth/authorize", "accessTokenUrl": "https://api.boltapp.com/v1/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This endpoint authorizes card payments and has three main use cases:\n* • Authorize a payment using an unsaved payment method for a guest or logged-in shopper.\n* • Authorize a payment using a saved payment method for a logged-in shopper.\n* • Re-charge a previous transaction using the `credit_card_id` of the transaction.\n" }, { "info": { "name": "Capture a Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/merchant/transactions/capture", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "This captures funds for the designated transaction. A capture can be done for any partial amount or for the total authorized amount.\n\nAlthough the response returns the standard `transaction_view` object, only `captures` and either `id` or `reference` are needed.\n" }, { "info": { "name": "Refund a Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/merchant/transactions/credit", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "This refunds a captured transaction. Refunds can be done for any partial amount or for the total authorized amount. These refunds are processed synchronously and return information about the refunded transaction in the standard `transaction_view` object." }, { "info": { "name": "Review Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/merchant/transactions/review", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "This endpoint is used to manually approve or reject orders for a specified transaction." }, { "info": { "name": "Void a Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/merchant/transactions/void", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "This voids the authorization for a given transaction. Voids must be completed before the authorization is captured.\nIn the request, either `transaction_id` or `transaction_reference` is required.\nAlthough the response returns the standard `transaction_view` object, only `status` and either `id` or `reference` are needed.\n" }, { "info": { "name": "Transaction Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.boltapp.com/v1/merchant/transactions/:REFERENCE", "params": [ { "name": "REFERENCE", "value": "", "type": "path", "description": "This is the Bolt transaction reference. (ex. N7Y3-NFKC-VFRF)" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "This allows you to pull the full transaction details for a given transaction.\n\n **Note**: All objects and fields marked `required` in the Transaction Details response are also **nullable**. This includes any sub-components (objects or fields) also marked `required`.\n" }, { "info": { "name": "Update a Transaction", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.boltapp.com/v1/merchant/transactions/:REFERENCE", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "params": [ { "name": "REFERENCE", "value": "", "type": "path", "description": "This is the Bolt transaction reference. (ex. N7Y3-NFKC-VFRF)" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "This allows you to update certain transaction properties post-authorization." } ] }, { "info": { "name": "OAuth", "type": "folder" }, "items": [ { "info": { "name": "OAuth Token Endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/oauth/token", "headers": [ { "name": "X-Publishable-Key", "value": "" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Endpoint for receiving access, ID, and refresh tokens from Bolt's OAuth server. \n\nTo use this endpoint, first use the Authorization Code Request flow by using the `authorization_code` Grant Type (`grant_type`). Then, in the event that you would need a second or subsequent code, use the `refresh_token` value returned from a successful request as the `refresh_token` input value in your subsequent `refresh_token` Grant Type (`grant_type`) request.\n\n **Reminder - the Content-Type of this request mus" } ] }, { "info": { "name": "Testing", "type": "folder" }, "items": [ { "info": { "name": "Test Shipping", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/shipments/mock_bolt_shipping", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "This endpoint simulates tracking an order's shipment and is for testing purposes only." }, { "info": { "name": "Create Testing Shopper Account", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/testing/shopper/create", "headers": [ { "name": "X-Publishable-Key", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a Bolt shopper account for testing purposes. Available for sandbox use only and the created account will be recycled after a certain time." }, { "info": { "name": "Fetch a Test Credit Card Token", "type": "http" }, "http": { "method": "GET", "url": "https://api.boltapp.com/v1/testing/card_token", "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "This endpoint fetches a new credit card token for Bolt's universal test credit card number `4111 1111 1111 1004`. This is for testing and is available only in sandbox." } ] }, { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "Query Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.boltapp.com/v1/webhooks", "params": [ { "name": "division_id", "value": "", "type": "query", "description": "The unique ID associated to the merchant's Bolt Account division; Merchants can have different divisions to suit multiple use cases (storefronts, pay-by-link, phone order processing). You can view and switch between these divisions from the Bolt Merchant Dashboard." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Find webhook configurations belonging to a merchant division. Results are limited to only show webhooks authorized by the X-API-Key." }, { "info": { "name": "Create Bolt Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/webhooks", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Create a new webhook to receive notifications from Bolt about various events, such as transaction status. Webhooks must have unique configuration.\n\n**Transaction & account events**:\n* `pending` - The payment pre-authorization was successful, and the transaction is now pending fraud review.\n* `failed_payment` - The payment failed pre-authorization.\n* `payment` - An automatic capture transaction passed authorization and fraud review, and the system captured the funds.\n* `auth` - A manual capture t" }, { "info": { "name": "Get Webhook", "type": "http" }, "http": { "method": "GET", "url": "https://api.boltapp.com/v1/webhooks/:webhook_id", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "Webhook ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get Webhook information by its Webhook ID. Results only include webhooks authorized by the X-API-Key." }, { "info": { "name": "Delete a Bolt Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.boltapp.com/v1/webhooks/:webhook_id", "params": [ { "name": "webhook_id", "value": "", "type": "path", "description": "Webhook ID" } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Delete a Bolt webhook. Provide an authorized X-API-Key to perform this action." } ] }, { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Get Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.boltapp.com/v1/subscriptions", "headers": [ { "name": "X-Publishable-Key", "value": "" }, { "name": "X-Bolt-Connect-Seller-Id", "value": "" } ], "params": [ { "name": "seller_id", "value": "", "type": "query", "description": "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." }, { "name": "product_ids", "value": "", "type": "query", "description": "Filter to subscriptions for these subscription product IDs. Comma-separated." }, { "name": "plan_ids", "value": "", "type": "query", "description": "Filter to subscriptions on these plan IDs. Comma-separated." }, { "name": "emails", "value": "", "type": "query", "description": "Filter to subscriptions for these shopper emails. Comma-separated." }, { "name": "statuses", "value": "", "type": "query", "description": "Filter to subscriptions with these statuses. Comma-separated." }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve, starting at 1." }, { "name": "page_size", "value": "", "type": "query", "description": "The number of subscriptions to return per page." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List subscriptions belonging to the authenticated merchant division. Results are limited to only show subscriptions authorized by the X-API-Key and X-Publishable-Key." }, { "info": { "name": "Get Subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.boltapp.com/v1/subscriptions/:subscription_id", "headers": [ { "name": "X-Publishable-Key", "value": "" } ], "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "The unique ID for the subscription." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get a single subscription by its ID. Results are limited to only show subscriptions authorized by the X-API-Key and X-Publishable-Key." }, { "info": { "name": "Cancel Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/subscriptions/:subscription_id/cancel", "headers": [ { "name": "X-Publishable-Key", "value": "" } ], "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "The unique ID for the subscription." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Cancel a subscription. This cancels any of the subscription's orders that are currently `scheduled`, `paused`, or `payment_failed`; no further orders will be placed." }, { "info": { "name": "Pause Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/subscriptions/:subscription_id/pause", "headers": [ { "name": "X-Publishable-Key", "value": "" } ], "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "The unique ID for the subscription." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Pause a subscription. This transitions the subscription's next `scheduled` order to `paused`, skipping its next billing cycle. Returns an error if the subscription is already paused." }, { "info": { "name": "Unpause Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.boltapp.com/v1/subscriptions/:subscription_id/unpause", "headers": [ { "name": "X-Publishable-Key", "value": "" } ], "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "The unique ID for the subscription." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Unpause a previously paused subscription. This computes the next billing date from the plan's frequency and reschedules the subscription's order. Returns an error if the subscription is not currently paused." }, { "info": { "name": "Get Subscription Orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.boltapp.com/v1/subscriptions/orders", "headers": [ { "name": "X-Publishable-Key", "value": "" }, { "name": "X-Bolt-Connect-Seller-Id", "value": "" } ], "params": [ { "name": "seller_id", "value": "", "type": "query", "description": "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." }, { "name": "subscription_ids", "value": "", "type": "query", "description": "Filter to orders for these subscription IDs. Comma-separated." }, { "name": "order_ids", "value": "", "type": "query", "description": "Filter to orders for these Bolt order IDs. Comma-separated." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "List subscription orders (billing cycles) for the authenticated merchant division." }, { "info": { "name": "Get Dunning Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.boltapp.com/v1/subscriptions/dunning_settings", "headers": [ { "name": "X-Publishable-Key", "value": "" }, { "name": "X-Bolt-Connect-Seller-Id", "value": "" } ], "params": [ { "name": "seller_id", "value": "", "type": "query", "description": "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." } ], "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Get the merchant division's dunning (failed payment recovery) settings. If the division has never configured these settings, Bolt's defaults are returned." }, { "info": { "name": "Update Dunning Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.boltapp.com/v1/subscriptions/dunning_settings", "headers": [ { "name": "X-Publishable-Key", "value": "" }, { "name": "X-Bolt-Connect-Seller-Id", "value": "" } ], "params": [ { "name": "seller_id", "value": "", "type": "query", "description": "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": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "docs": "Update the merchant division's dunning (failed payment recovery) settings. This replaces the full configuration; omitted fields are not merged with the previous settings." } ] } ], "bundled": true }