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

Skip to content

Get a product

View As MarkdownMCP
GET
/v2/subscriptions/products/{productId}

Retrieves a product by its ID, including a product 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

Path Parameters

productId*string

ID of the product to retrieve.

Query Parameters

seller_id?string

Seller ID for Connect marketplace operations. Send it to read a product that belongs to a seller's Bolt Cart division.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/subscriptions/products/sp_Tlj0Osm0N76T"
{  "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"}