# Get all products

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

Source: https://help.boltapp.com/api-reference/subscriptions/products-v2/listproductsv2

`GET /v2/subscriptions/products`

## OpenAPI definition

This endpoint as it appears in the OpenAPI document, with every schema it references included.

```json
{
  "openapi": "3.2.0",
  "info": {
    "title": "Subscriptions API",
    "version": "v1",
    "description": "API for managing subscriptions and products."
  },
  "servers": [
    {
      "url": "https://api.boltapp.com",
      "description": "The Production URL (Live Data)."
    },
    {
      "url": "https://api-sandbox.boltapp.com",
      "description": "The Sandbox URL (Test Data)."
    },
    {
      "url": "https://api-staging.boltapp.com",
      "description": "The Staging URL (Staged Data)."
    }
  ],
  "security": [
    {
      "X-API-Key": []
    },
    {
      "X-Publishable-Key": []
    }
  ],
  "paths": {
    "/v2/subscriptions/products": {
      "get": {
        "operationId": "listProductsV2",
        "summary": "Get all products",
        "description": "Retrieves the division's products, newest first, including products created through v1.",
        "tags": [
          "Products v2"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "seller_id",
            "schema": {
              "type": "string"
            },
            "required": false,
            "description": "Seller ID for Connect marketplace operations. Filter products by seller."
          },
          {
            "in": "query",
            "name": "ids",
            "schema": {
              "type": "string"
            },
            "required": false,
            "description": "Bolt Cart divisions only. Comma-separated list of product IDs to return, in the order given.",
            "examples": {
              "default": {
                "value": "sp_Tlj0Osm0N76T,sp_9aXkQ2LmP0Zr"
              }
            }
          },
          {
            "in": "query",
            "name": "name",
            "schema": {
              "type": "string"
            },
            "required": false,
            "description": "Bolt Cart divisions only. Partial, case-insensitive match on the product name.",
            "examples": {
              "default": {
                "value": "canvas"
              }
            }
          },
          {
            "in": "query",
            "name": "status",
            "schema": {
              "type": "string",
              "enum": [
                "draft",
                "active",
                "archived"
              ]
            },
            "required": false,
            "description": "Bolt Cart divisions only. Every status is listed when absent.",
            "examples": {
              "default": {
                "value": "active"
              }
            }
          },
          {
            "in": "query",
            "name": "page",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "default": 1
            },
            "required": false,
            "description": "Bolt Cart divisions only. Page number.",
            "examples": {
              "default": {
                "value": 1
              }
            }
          },
          {
            "in": "query",
            "name": "page_size",
            "schema": {
              "type": "integer",
              "maximum": 400,
              "default": 400
            },
            "required": false,
            "description": "Bolt Cart divisions only. Number of products per page. A larger value is lowered to 400.",
            "examples": {
              "default": {
                "value": 400
              }
            }
          }
        ],
        "security": [
          {
            "X-API-Key": []
          },
          {
            "X-Publishable-Key": []
          }
        ],
        "responses": {
          "200": {
            "description": "List of products.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "products": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/ProductV2"
                      }
                    },
                    "pagination": {
                      "type": "object",
                      "description": "Bolt Cart divisions only. Absent on other divisions, which return every product in one response.",
                      "properties": {
                        "page_size": {
                          "type": "integer",
                          "description": "Page size the response used.",
                          "examples": [
                            400
                          ]
                        },
                        "total_count": {
                          "type": "integer",
                          "description": "Number of products that match the filters, across all pages.",
                          "examples": [
                            2
                          ]
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request. `status` is not one of `draft`, `active` or `archived`.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                },
                "examples": {
                  "default": {
                    "value": {
                      "result": {
                        "success": false
                      },
                      "errors": [
                        {
                          "code": 50,
                          "message": "status must be draft, active or archived",
                          "field": "status"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized - Invalid or missing API key.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                },
                "examples": {
                  "default": {
                    "value": {
                      "result": {
                        "success": false
                      },
                      "errors": [
                        {
                          "code": 1005,
                          "message": "X-API-Key header is missing, invalid, or associated with a merchant that is no longer active."
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ProductV2": {
        "type": "object",
        "description": "Product object returned by the v2 product endpoints. `product` and `product_reference` are always present, and at most one of them is not `null`.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the product.",
            "examples": [
              "sp_Tlj0Osm0N76T"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "active",
              "archived"
            ],
            "description": "Bolt Cart divisions only. Read-only. Absent on other divisions.",
            "examples": [
              "active"
            ]
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-10-01T12:00:00Z"
            ]
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-10-01T12:00:00Z"
            ]
          },
          "activated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Bolt Cart divisions only. When the product became active. Absent on a product that was never activated.",
            "examples": [
              "2023-10-01T12:00:00Z"
            ]
          },
          "archived_at": {
            "type": "string",
            "format": "date-time",
            "description": "Bolt Cart divisions only. When the product was archived. Absent on a product that is not archived.",
            "examples": [
              "2024-02-01T12:00:00Z"
            ]
          },
          "product": {
            "description": "The Bolt Cart catalog product. `null` on physical and payment-only divisions.",
            "anyOf": [
              {
                "$ref": "#/components/schemas/ProductV2Details"
              },
              {
                "type": "null"
              }
            ]
          },
          "product_reference": {
            "description": "The reference to your own catalog. `null` on a Bolt Cart division, and on a global product created through v1.",
            "anyOf": [
              {
                "$ref": "#/components/schemas/ProductV2Reference"
              },
              {
                "type": "null"
              }
            ]
          },
          "plans": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PlanV2"
            }
          },
          "metadata": {
            "type": "object",
            "additionalProperties": true,
            "description": "Metadata stored on the Bolt Cart product.",
            "examples": [
              {
                "team": "growth"
              }
            ]
          },
          "name": {
            "type": "string",
            "readOnly": true,
            "description": "Name stored for a product that was created and named through a v1 endpoint. Absent on products created through v2."
          }
        }
      },
      "ProductV2Details": {
        "type": "object",
        "description": "Product in your Bolt Cart catalog. Bolt Cart divisions only.",
        "required": [
          "name",
          "description",
          "sku",
          "currency",
          "taxable"
        ],
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 250,
            "description": "Name of the product.",
            "examples": [
              "Canvas AI Pro"
            ]
          },
          "description": {
            "type": "string",
            "description": "Description of the product.",
            "examples": [
              "Professional plan for Canvas AI."
            ]
          },
          "sku": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64,
            "description": "SKU of the product. Unique among the division's live products.",
            "examples": [
              "CANVAS-AI-PRO"
            ]
          },
          "brand": {
            "type": [
              "string",
              "null"
            ],
            "description": "Brand of the product.",
            "examples": [
              "Canvas"
            ]
          },
          "images": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "URL"
            },
            "description": "Array of image URLs for the product.",
            "examples": [
              [
                "https://example.com/canvas-ai-pro.png"
              ]
            ]
          },
          "marketing_features": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Marketing feature statements for the product.",
            "examples": [
              [
                "Unlimited projects",
                "Priority support"
              ]
            ]
          },
          "unit_price": {
            "type": [
              "integer",
              "null"
            ],
            "format": "int64",
            "minimum": 0,
            "description": "Unit price of the product in cents.",
            "examples": [
              2900
            ]
          },
          "currency": {
            "type": "string",
            "pattern": "^[A-Z]{3}$",
            "description": "ISO4217 currency code, three upper-case letters.",
            "examples": [
              "USD"
            ]
          },
          "taxable": {
            "type": "boolean",
            "description": "Whether the product is taxable.",
            "examples": [
              true
            ]
          },
          "tax_behavior": {
            "type": "string",
            "enum": [
              "exclusive",
              "inclusive"
            ],
            "default": "exclusive",
            "description": "Whether `unit_price` excludes or includes tax.",
            "examples": [
              "exclusive"
            ]
          },
          "tax_code": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 32,
            "description": "Tax code of the product. A code Bolt does not list is rejected. Without one, the product is taxed at the standard rate.",
            "examples": [
              "31000"
            ]
          },
          "family": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 100,
            "description": "Family the product belongs to.",
            "examples": [
              "Canvas AI"
            ]
          },
          "unit_label": {
            "type": [
              "string",
              "null"
            ],
            "description": "Label for one unit of the product.",
            "examples": [
              "seat"
            ]
          }
        }
      },
      "ProductV2Reference": {
        "type": "object",
        "description": "Reference to a product in your own catalog. Physical and payment-only divisions only.",
        "required": [
          "product_id"
        ],
        "properties": {
          "product_id": {
            "type": "string",
            "minLength": 1,
            "description": "Your ID for the product.",
            "examples": [
              "37"
            ]
          },
          "variant_id": {
            "type": "string",
            "minLength": 1,
            "description": "Your ID for the product variant. Optional, but not empty when sent.",
            "examples": [
              "67"
            ]
          }
        }
      },
      "PlanV2": {
        "type": "object",
        "description": "Plan object returned by the v2 product endpoints. It has no `checkout_link`. `GET /v1/subscriptions/plans` returns the checkout link of a plan.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the plan.",
            "examples": [
              "spl_ba_PpkW16oIW"
            ]
          },
          "name": {
            "type": "string",
            "description": "Name of the plan.",
            "examples": [
              "Monthly"
            ]
          },
          "sku": {
            "type": "string",
            "description": "SKU of the plan.",
            "examples": [
              "CANVAS-AI-PRO-MONTHLY"
            ]
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-10-01T12:00:00Z"
            ]
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2023-10-01T12:00:00Z"
            ]
          },
          "frequency": {
            "type": "integer",
            "format": "int64",
            "description": "Number of `frequency_unit` periods between renewals.",
            "examples": [
              1
            ]
          },
          "frequency_unit": {
            "type": "string",
            "description": "Unit of frequency.",
            "enum": [
              "day",
              "week",
              "month",
              "year",
              "one_time"
            ],
            "examples": [
              "month"
            ]
          },
          "base_price": {
            "type": "integer",
            "format": "int64",
            "description": "Base price stored on the plan, as an integer in minor units of `currency`. `0` on a plan with no base price. Renewals are not billed from this field.",
            "examples": [
              0
            ]
          },
          "product_id": {
            "type": "string",
            "description": "ID of the product associated with the plan.",
            "examples": [
              "sp_Tlj0Osm0N76T"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "archived"
            ],
            "description": "Status of the plan.",
            "examples": [
              "active"
            ]
          },
          "currency": {
            "type": "string",
            "description": "ISO4217 currency code of the plan. Absent on a plan that stores no currency.",
            "examples": [
              "USD"
            ]
          },
          "initial_period": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PlanInitialPeriod"
              }
            ],
            "description": "Present only when the plan has an initial period."
          },
          "trial": {
            "description": "Bolt Cart divisions only. `null` when the plan has no trial. Absent on other divisions.",
            "anyOf": [
              {
                "$ref": "#/components/schemas/PlanTrial"
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "PlanInitialPeriod": {
        "type": "object",
        "description": "Duration of the initial period before the subscription moves to the plan's regular frequency.",
        "required": [
          "frequency",
          "frequency_unit"
        ],
        "properties": {
          "frequency": {
            "type": "integer",
            "format": "int64",
            "minimum": 1,
            "maximum": 32767,
            "description": "Number of units the initial period lasts.",
            "examples": [
              2
            ]
          },
          "frequency_unit": {
            "type": "string",
            "enum": [
              "day",
              "week",
              "month",
              "year"
            ],
            "description": "Unit of the initial period.",
            "examples": [
              "week"
            ]
          }
        }
      },
      "PlanTrial": {
        "type": "object",
        "description": "Free trial on a plan. Bolt Cart divisions only.",
        "required": [
          "trial_days"
        ],
        "properties": {
          "trial_days": {
            "type": "integer",
            "format": "int64",
            "minimum": 1,
            "maximum": 730,
            "description": "Length of the trial in days.",
            "examples": [
              14
            ]
          }
        }
      },
      "ApiErrorResponse": {
        "type": "object",
        "description": "Standard error envelope returned by every non-2xx response.",
        "required": [
          "result",
          "errors"
        ],
        "properties": {
          "result": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean",
                "description": "Always `false` on an error.",
                "examples": [
                  false
                ]
              }
            }
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ApiError"
            }
          }
        },
        "examples": [
          {
            "result": {
              "success": false
            },
            "errors": [
              {
                "code": 15,
                "message": "A valid value must be provided.",
                "field": "frequency"
              }
            ]
          }
        ]
      },
      "ApiError": {
        "type": "object",
        "description": "One error of a failed request.",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "integer",
            "description": "Bolt error code.",
            "examples": [
              15
            ]
          },
          "message": {
            "type": "string",
            "description": "What went wrong.",
            "examples": [
              "A valid value must be provided."
            ]
          },
          "field": {
            "type": "string",
            "description": "Path of the request field the error is about, such as `product.taxable` or `plans[1].sku`. Absent when the error is not about one field.",
            "examples": [
              "frequency"
            ]
          }
        }
      }
    },
    "securitySchemes": {
      "X-API-Key": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard. Send it together with `X-Publishable-Key`."
      },
      "X-Publishable-Key": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Publishable-Key",
        "description": "The publicly viewable identifier used to identify a merchant division. This key is found in the Developer > API section of the Bolt Merchant Dashboard. Required. Send it together with `X-API-Key`."
      }
    }
  }
}
```
