Sign in

v2

latestOpenAPI 3.0.02026-07-3139594346.4 KB
Subscriptions

Get Subscriptions

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.

get/v1/subscriptions

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.

product_idsstring

Filter to subscriptions for these subscription product IDs. Comma-separated.

plan_idsstring

Filter to subscriptions on these plan IDs. Comma-separated.

emailsstring

Filter to subscriptions for these shopper emails. Comma-separated.

statusesSubscriptionV2Status[]

Filter to subscriptions with these statuses. Comma-separated.

[
  "active"
]
pageinteger

The page number to retrieve, starting at 1.

page_sizeinteger

The number of subscriptions to return per page.

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

{
  "subscriptions": [
    {
      "id": "sub_1a2b3c4d5e",
      "merchant_name": "Bolt Swag Store",
      "email": "shopper@example.com",
      "status_details": {
        "type": "active",
        "reason": "payment_failed"
      },
      "payment_method": {
        "card_last_4": "4242",
        "card_network": "visa"
      },
      "plan": {
        "id": "plan_9f8e7d6c5b",
        "name": "Monthly",
        "sku": "SUB-MONTHLY-001",
        "frequency": 1,
        "frequency_unit": "month",
        "product_id": "prod_3c2b1a0f9e",
        "checkout_link": "https://subscribe.boltapp.com/plans/plan_9f8e7d6c5b",
        "initial_period": {
          "frequency": 14,
          "frequency_unit": "day"
        }
      },
      "total_amount": {
        "amount": 754,
        "currency": "USD",
        "currency_symbol": "$"
      }
    }
  ],
  "pagination": {
    "page_size": 25,
    "total_count": 132
  }
}