Bolt HelpDocs
SupportMerchant Dashboard
DocumentationAPI ReferenceAI Agents
Skip to content

Get Subscription Orders

GET
/v1/subscriptions/orders

List subscription orders (billing cycles) for the authenticated merchant division.

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.

subscription_ids?string

Filter to orders for these subscription IDs. Comma-separated.

order_ids?string

Filter to orders for these Bolt order IDs. Comma-separated.

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

application/json

curl -X GET "https://example.com/v1/subscriptions/orders" \  -H "X-Publishable-Key: string"
{  "orders": [    {      "id": "sorder_5d4c3b2a19",      "subscription_id": "sub_1a2b3c4d5e",      "order_id": 123456789,      "transaction_reference": "6CEA-ZME1-DACE",      "placement_time": "2019-08-24T14:15:22Z",      "status": "scheduled",      "cancel_reason": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "sequence_number": 3,      "total_amount": {        "amount": 754,        "currency": "USD",        "currency_symbol": "$"      }    }  ]}

Unpause Subscription POST

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.

Get Dunning Settings GET

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