Products
Create, retrieve, update, delete, and list products.
A product describes a good or service you sell. Products are the top-level catalog object; pricing information is attached separately via Prices.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The product objectAsk
idstringUnique identifier for the product, e.g. prod_7Kc4mNpQ.
namestringThe product's display name, shown on invoices and the customer portal.
descriptionstringAn optional description of the product. Shown on invoices.
activebooleanWhether the product is currently available for purchase. Defaults to true.
imagesarrayA list of up to 8 URLs of images for this product.
createdintegerUnix timestamp of when the product was created, e.g. 1716300000.
Create a productAsk
Pass a name and optional description to create a new product in your catalog.
Retrieve a productAsk
Update a productAsk
Delete a productAsk
Deleting a product removes it from the catalog. Products with active prices cannot be deleted;
archive them by setting active: false instead.
List productsAsk
Returns a paginated list of products. Pass active=true to show only purchasable products.
Related eventsAsk
product.created, product.updated, and product.deleted. See Events.
