Get all products
Retrieves the division's products, newest first, including products created through v1.
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 for Connect marketplace operations. Filter products by seller.
Bolt Cart divisions only. Comma-separated list of product IDs to return, in the order given.
Bolt Cart divisions only. Partial, case-insensitive match on the product name.
Bolt Cart divisions only. Every status is listed when absent.
Value in
- "draft"
- "active"
- "archived"
Bolt Cart divisions only. Page number.
1 <= value1Bolt Cart divisions only. Number of products per page. A larger value is lowered to 400.
value <= 400400Response 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 }}Update dunning settings PUT
Replaces the division's dunning (failed payment recovery) configuration; omitted fields are not merged with the previous settings. Divisions renewing by invoice (Bolt Cart) send `retry_schedule_days` and must not send `retry_schedule_hours` or `final_action`: the subscription always pauses after the last failed retry. `reminder_enabled` and `sms_enabled` are required. Divisions renewing by stored card send `retry_schedule_hours` and `final_action`, and must not send `retry_schedule_days`. `reminder_enabled` keeps its stored value when omitted.
Create a product POST
Creates a product and its plans in one call. A product created here is the same product the v1 endpoints read, update and delete.