v2

latestOpenAPI 3.0.02026-07-3139594346.4 KB

Subscriptions

Get Subscription Orders

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

get/v1/subscriptions/orders

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.

subscription_idsstring

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

order_idsstring

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

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

Example response

{
  "orders": [
    {
      "id": "sorder_5d4c3b2a19",
      "subscription_id": "sub_1a2b3c4d5e",
      "order_id": 123456789,
      "transaction_reference": "6CEA-ZME1-DACE",
      "status": "scheduled",
      "sequence_number": 3,
      "total_amount": {
        "amount": 754,
        "currency": "USD",
        "currency_symbol": "$"
      }
    }
  ]
}