Bolt has moved to boltapp.com. Stores still using bolt.com hosts must update now: see the migration guide.

Skip to content

Get all products

View As MarkdownMCP
GET
/v2/subscriptions/products

Retrieves the division's products, newest first, including products created through v1.

Authorization

X-API-Key<token>

Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard. Send it together with X-Publishable-Key.

In: header

Query Parameters

seller_id?string

Seller ID for Connect marketplace operations. Filter products by seller.

ids?string

Bolt Cart divisions only. Comma-separated list of product IDs to return, in the order given.

name?string

Bolt Cart divisions only. Partial, case-insensitive match on the product name.

status?string

Bolt Cart divisions only. Every status is listed when absent.

Value in

  • "draft"
  • "active"
  • "archived"
page?integer

Bolt Cart divisions only. Page number.

Range1 <= value
Default1
page_size?integer

Bolt Cart divisions only. Number of products per page. A larger value is lowered to 400.

Rangevalue <= 400
Default400

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v2/subscriptions/products?ids=sp_Tlj0Osm0N76T%2Csp_9aXkQ2LmP0Zr&name=canvas&status=active&page=1&page_size=400"
{  "products": [    {      "id": "sp_Tlj0Osm0N76T",      "status": "active",      "created_at": "2023-10-01T12:00:00Z",      "updated_at": "2023-10-01T12:00:00Z",      "activated_at": "2023-10-01T12:00:00Z",      "archived_at": "2024-02-01T12:00:00Z",      "product": {        "name": "Canvas AI Pro",        "description": "Professional plan for Canvas AI.",        "sku": "CANVAS-AI-PRO",        "brand": "Canvas",        "images": [          "https://example.com/canvas-ai-pro.png"        ],        "marketing_features": [          "Unlimited projects",          "Priority support"        ],        "unit_price": 2900,        "currency": "USD",        "taxable": true,        "tax_behavior": "exclusive",        "tax_code": "31000",        "family": "Canvas AI",        "unit_label": "seat"      },      "product_reference": {        "product_id": "37",        "variant_id": "67"      },      "plans": [        {          "id": "spl_ba_PpkW16oIW",          "name": "Monthly",          "sku": "CANVAS-AI-PRO-MONTHLY",          "created_at": "2023-10-01T12:00:00Z",          "updated_at": "2023-10-01T12:00:00Z",          "frequency": 1,          "frequency_unit": "month",          "base_price": 0,          "product_id": "sp_Tlj0Osm0N76T",          "status": "active",          "currency": "USD",          "initial_period": {            "frequency": 2,            "frequency_unit": "week"          },          "trial": {            "trial_days": 14          }        }      ],      "metadata": {        "team": "growth"      },      "name": "string"    }  ],  "pagination": {    "page_size": 400,    "total_count": 2  }}