> For the complete documentation index, see [llms.txt](https://docs.zero.inc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zero.inc/developers/api/products.md). # Products Manage the workspace product catalog. Products hold one or more price variants (`prices`) that quotes reference as line items. Write operations (create, update, delete) require the authenticated user to be a workspace **admin**. ## List products > Returns catalog products the user has access to. Filter by workspace using the \`where\` parameter: \`{"workspaceId": "\"}\`.
````json {"openapi":"3.0.3","info":{"title":"Zero API","version":"1.14.0"},"tags":[{"name":"Products","description":"Manage the workspace product catalog. Products hold one or more price variants (`prices`) that quotes reference as line items.\n\nWrite operations (create, update, delete) require the authenticated user to be a workspace **admin**.\n"}],"servers":[{"url":"https://api.zero.inc","description":"Production server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"All API requests require a Bearer token in the Authorization header. Create an API key from [Workspace Settings → API keys](https://app.zero.inc/settings/workspace/api)"}},"parameters":{"fields":{"name":"fields","in":"query","description":"Comma-separated list of fields to return. Defaults to all fields.\n\nSupports **relation expansion** with dot-notation: a path like `company.name` embeds the named field of the related record, and `quotes.id` embeds the `id` of each related quote. Use `.*` to embed full related objects, e.g. `quotes.*`. Related records are returned nested on the response — as an object for to-one relations (e.g. `company`) or an array for to-many relations (e.g. `quotes`). Archived related records are excluded.\n\nExample: `GET /api/deals/{dealId}?fields=id,name,quotes.id` returns the deal with a `quotes` array of `{\"id\": \"\"}` entries.\n","schema":{"type":"string"}},"where":{"name":"where","in":"query","description":"JSON-encoded filter object. All top-level conditions are combined with AND logic. Use `$or` for OR logic.\n\nThe available operators depend on the **data type** of the field you are filtering on.\n\n---\n\n## String fields\nFields like `name`, `domain`, `description`, `linkedin`, `source`, `externalId`, `location`.\n\n| Operator | Description | Example |\n|----------|-------------|---------|\n| *(exact)* | Exact match | `{\"name\": \"Linear\"}` |\n| `$eq` | Explicit exact match | `{\"name\": {\"$eq\": \"Linear\"}}` |\n| `$not` | Not equal | `{\"source\": {\"$not\": \"import\"}}` |\n| `$in` | Matches any value in array | `{\"domain\": {\"$in\": [\"linear.app\", \"granola.so\"]}}` |\n| `$notIn` | Matches none of the values | `{\"source\": {\"$notIn\": [\"import\", \"api\"]}}` |\n| `$contains` | Case-insensitive word-boundary substring match | `{\"name\": {\"$contains\": \"YC\"}}` |\n| `$notContains` | Does not contain | `{\"name\": {\"$notContains\": \"Test\"}}` |\n| `$containsAny` | Contains any of the given strings | `{\"name\": {\"$containsAny\": [\"YC\", \"Techstars\"]}}` |\n| `$startsWith` | Starts with prefix | `{\"domain\": {\"$startsWith\": \"app.\"}}` |\n| `$endsWith` | Ends with suffix | `{\"email\": {\"$endsWith\": \"@zero.inc\"}}` |\n| `$exists` | Field is present and truthy | `{\"linkedin\": {\"$exists\": true}}` |\n| `$notExists` | Field is absent, null, or empty | `{\"linkedin\": {\"$notExists\": true}}` |\n\n---\n\n## Number fields\nFields like `value`, `confidence`.\n\n| Operator | Description | Example |\n|----------|-------------|---------|\n| *(exact)* | Exact match | `{\"value\": 5000}` |\n| `$eq` | Explicit exact match | `{\"value\": {\"$eq\": 5000}}` |\n| `$not` | Not equal | `{\"value\": {\"$not\": 0}}` |\n| `$gt` | Greater than | `{\"value\": {\"$gt\": 10000}}` |\n| `$gte` | Greater than or equal | `{\"value\": {\"$gte\": 5000}}` |\n| `$lt` | Less than | `{\"value\": {\"$lt\": 10000}}` |\n| `$lte` | Less than or equal | `{\"value\": {\"$lte\": 50000}}` |\n| `$in` | Matches any value in array | `{\"confidence\": {\"$in\": [0.25, 0.5, 0.75]}}` |\n| `$notIn` | Matches none of the values | `{\"confidence\": {\"$notIn\": [0, 1]}}` |\n| `$exists` | Field is present and truthy | `{\"value\": {\"$exists\": true}}` |\n| `$notExists` | Field is absent, null, or zero | `{\"value\": {\"$notExists\": true}}` |\n\nMultiple operators can be combined on one field:\n```json\n{\"value\": {\"$gte\": 5000, \"$lt\": 10000}}\n```\n\n---\n\n## Date fields\nFields like `closeDate`, `startDate`, `endDate`, `createdAt`, `updatedAt`.\n\nValues can be ISO 8601 strings (`\"2026-01-01\"`, `\"2026-01-01T00:00:00Z\"`) or **relative time macros**.\n\n**Relative time macros:** `+Nd` / `-Nd` (days), `+Nw` / `-Nw` (weeks), `+Nm` / `-Nm` (months), `+Ny` / `-Ny` (years), `+Nh` / `-Nh` (hours), `+Ns` / `-Ns` (seconds), `now()`.\n\n| Operator | Description | Example |\n|----------|-------------|---------|\n| `$gte` | On or after | `{\"closeDate\": {\"$gte\": \"2026-01-01\"}}` |\n| `$lte` | On or before | `{\"closeDate\": {\"$lte\": \"2026-03-31\"}}` |\n| `$gt` | After | `{\"createdAt\": {\"$gt\": \"2026-01-01T00:00:00Z\"}}` |\n| `$lt` | Before | `{\"createdAt\": {\"$lt\": \"now()\"}}` |\n| `$date` | Exact date match (compares date portion only) | `{\"closeDate\": {\"$date\": \"2026-01-15\"}}` |\n| `$exists` | Field is present and truthy | `{\"closeDate\": {\"$exists\": true}}` |\n| `$notExists` | Field is absent or null | `{\"closeDate\": {\"$notExists\": true}}` |\n\nDate range example:\n```json\n{\"closeDate\": {\"$gte\": \"2026-01-01\", \"$lte\": \"2026-03-31\"}}\n```\nRelative date example (closing in next 30 days):\n```json\n{\"closeDate\": {\"$gte\": \"now()\", \"$lte\": \"+30d\"}}\n```\n\n---\n\n## Array fields\nFields like `listIds`, `ownerIds`, `contactIds`.\n\n| Operator | Description | Example |\n|----------|-------------|---------|\n| `$includes` | Array contains the given value (use this — bare exact match is not supported) | `{\"listIds\": {\"$includes\": \"\"}}` |\n| `$notIncludes` | Array does not contain the given value | `{\"ownerIds\": {\"$notIncludes\": \"\"}}` |\n| `$overlaps` | Array contains at least one of the given values | `{\"ownerIds\": {\"$overlaps\": [\"\", \"\"]}}` |\n| `$notOverlaps` | Array contains none of the given values | `{\"listIds\": {\"$notOverlaps\": [\"\", \"\"]}}` |\n| `$all` | Array contains all of the given values | `{\"listIds\": {\"$all\": [\"\", \"\"]}}` |\n| `$length` | Filter by array length (supports nested operators) | `{\"contactIds\": {\"$length\": {\"$gte\": 2}}}` |\n| `$exists` | Field is present and non-empty | `{\"ownerIds\": {\"$exists\": true}}` |\n| `$notExists` | Field is absent or empty | `{\"ownerIds\": {\"$notExists\": true}}` |\n\n---\n\n## UUID / ID fields\nFields like `id`, `workspaceId`, `companyId`, `stage`.\n\n| Operator | Description | Example |\n|----------|-------------|---------|\n| *(exact)* | Exact match | `{\"stage\": \"\"}` |\n| `$in` | Matches any value in array | `{\"stage\": {\"$in\": [\"\", \"\"]}}` |\n| `$notIn` | Matches none of the values | `{\"stage\": {\"$notIn\": [\"\"]}}` |\n| `$not` | Not equal | `{\"stage\": {\"$not\": \"\"}}` |\n\n---\n\n## Boolean fields\nFields like `archived`.\n\n| Operator | Description | Example |\n|----------|-------------|---------|\n| *(exact)* | Exact match | `{\"archived\": false}` |\n| `$not` | Not equal | `{\"archived\": {\"$not\": true}}` |\n\n---\n\n## Logical operators\nThese work across all data types.\n\n`$or` — matches if **any** sub-condition is true:\n```json\n{\n \"workspaceId\": \"\",\n \"$or\": [\n {\"ownerIds\": {\"$overlaps\": [\"\", \"\"]}},\n {\"closeDate\": {\"$gte\": \"2026-01-01\"}}\n ]\n}\n```\n\n`$and` — matches if **all** sub-conditions are true (useful when you need multiple conditions on the same field):\n```json\n{\n \"$and\": [\n {\"name\": {\"$contains\": \"Enterprise\"}},\n {\"name\": {\"$notContains\": \"Test\"}}\n ]\n}\n```\n\n---\n\n## Dot-notation (relation filtering)\nUse dot-syntax to filter records based on properties of related objects:\n```json\n{\"company.name\": \"Linear\"}\n{\"company.domain\": {\"$in\": [\"linear.app\", \"granola.so\"]}}\n{\"company.location.city\": \"San Francisco\"}\n{\"companyProfile.categories\": {\"$overlaps\": [\"Sales\", \"Marketing\"]}}\n```\nAll operators available for the target field's data type can be used with dot-notation.\n\n---\n\n## Custom property filtering\nCustom properties are stored in the `custom` object on records, keyed by UUID. Use `GET /api/columns` to discover the available custom property IDs, types, and options for a workspace.\n\nFilter on custom properties using `custom.` with operators appropriate for the column's type.\n\n> **Note:** For `select` and `multiselect` columns, option values are UUIDs (the `key` field from the column's `options` array). Use the UUID, not the human-readable name.\n\n```json\n// Text custom property\n{\"custom.54e1ca7d-69c3-4b77-8266-8085b5834116\": {\"$contains\": \"enterprise\"}}\n\n// Select custom property (use the option key UUID)\n{\"custom.a1b2c3d4-e5f6-7890-abcd-ef1234567890\": \"3e839b5c-b311-4887-b2da-727d2d75cdd6\"}\n\n// Multi-select custom property (use option key UUIDs)\n{\"custom.b2c3d4e5-f6a7-8901-bcde-f12345678901\": {\"$overlaps\": [\"a1b1c1d1-e1f1-1111-aaaa-111111111111\", \"b2b2c2d2-e2f2-2222-bbbb-222222222222\"]}}\n\n// Currency/number custom property\n{\"custom.c3d4e5f6-a7b8-9012-cdef-123456789012\": {\"$gte\": 100000}}\n\n// Date custom property\n{\"custom.d4e5f6a7-b8c9-0123-defa-234567890123\": {\"$gte\": \"2026-01-01\"}}\n\n// Boolean custom property\n{\"custom.e5f6a7b8-c9d0-1234-efab-345678901234\": true}\n\n// Check if custom property has a value\n{\"custom.f6a7b8c9-d0e1-2345-fabc-456789012345\": {\"$exists\": true}}\n```\n\n---\n\n## Complex example\nAll top-level keys are ANDed together:\n```json\n{\n \"name\": {\"$contains\": \"Zero\"},\n \"location.city\": \"Helsinki\",\n \"location.country\": {\"$in\": [\"United Kingdom\", \"Germany\", \"Sweden\"]},\n \"value\": {\"$gte\": 10000},\n \"closeDate\": {\"$gte\": \"2026-01-01\", \"$lte\": \"2026-03-31\"},\n \"ownerIds\": {\"$includes\": \"\"},\n \"stage\": {\"$in\": [\"\", \"\"]},\n \"lastActivity\": {\"$exists\": true},\n \"companyProfile.categories\": {\"$overlaps\": [\"Sales\", \"Marketing\"]},\n \"custom.54e1ca7d-69c3-4b77-8266-8085b5834116\": {\"$contains\": \"enterprise\"}\n}\n```\n","schema":{"type":"string"}},"limit":{"name":"limit","in":"query","description":"Maximum number of records to return","schema":{"type":"integer","default":100}},"offset":{"name":"offset","in":"query","description":"Pagination offset","schema":{"type":"integer","default":0}},"orderBy":{"name":"orderBy","in":"query","description":"JSON string for sort order","schema":{"type":"string"}}},"schemas":{"Product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"workspaceId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"sku":{"type":"string","nullable":true},"prices":{"type":"array","items":{"$ref":"#/components/schemas/ProductPrice"}},"isDefault":{"type":"boolean","description":"Default products are prefilled as line items on newly created quotes."},"defaultPriceId":{"type":"string","format":"uuid","nullable":true,"description":"Id of a price entry inside `prices` (not a separate record) used when this product is prefilled on a new quote."},"order":{"type":"integer","nullable":true,"description":"Display order in the catalog."},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdById":{"type":"string","format":"uuid","nullable":true}}},"ProductPrice":{"type":"object","required":["name","amount","currency"],"properties":{"id":{"type":"string","format":"uuid","description":"Stable id of this price entry. Assigned server-side when omitted on create/update. Quote line items reference prices via this id, so keep existing ids when patching `prices`."},"name":{"type":"string","description":"Display name of the price variant (e.g. \"Monthly\", \"Annual\")."},"amount":{"type":"number","description":"Price amount per billing interval (or one-time amount when `interval` is not set)."},"currency":{"type":"string","description":"ISO 4217 currency code (e.g. `USD`, `EUR`)."},"interval":{"type":"string","enum":["day","week","month","quarter","year"],"nullable":true,"description":"Billing interval. Omit or set to `null` for a one-time price."},"discountType":{"type":"string","enum":["absolute","percentage"],"nullable":true,"description":"Type of the default discount applied when this price is added to a quote."},"discount":{"type":"number","nullable":true,"description":"Default discount value — an amount for `absolute` (applied per unit), a percentage (0–100) for `percentage`."},"minimumTermMonths":{"type":"integer","nullable":true,"description":"Explicit minimum contract duration in months for this price. The billing interval adds an implicit minimum on top (e.g. a yearly price implies at least 12 months)."}}}},"responses":{"Unauthorized":{"description":"Authentication failed or token is invalid/expired","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}},"paths":{"/api/products":{"get":{"tags":["Products"],"summary":"List products","description":"Returns catalog products the user has access to. Filter by workspace using the `where` parameter: `{\"workspaceId\": \"\"}`.\n","operationId":"listProducts","parameters":[{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/where"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/orderBy"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"total":{"type":"integer"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ```` ## Create a product > Create a new catalog product. Requires workspace \*\*admin\*\* role.\ > \ > Each entry in \`prices\` is assigned a stable \`id\` server-side when omitted — quote line items reference a specific price via that id, so treat price ids as stable once created.
```json {"openapi":"3.0.3","info":{"title":"Zero API","version":"1.14.0"},"tags":[{"name":"Products","description":"Manage the workspace product catalog. Products hold one or more price variants (`prices`) that quotes reference as line items.\n\nWrite operations (create, update, delete) require the authenticated user to be a workspace **admin**.\n"}],"servers":[{"url":"https://api.zero.inc","description":"Production server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"All API requests require a Bearer token in the Authorization header. Create an API key from [Workspace Settings → API keys](https://app.zero.inc/settings/workspace/api)"}},"schemas":{"ProductCreate":{"type":"object","required":["workspaceId"],"properties":{"workspaceId":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"sku":{"type":"string"},"prices":{"type":"array","items":{"$ref":"#/components/schemas/ProductPrice"}},"isDefault":{"type":"boolean"},"defaultPriceId":{"type":"string","format":"uuid"},"order":{"type":"integer"}}},"ProductPrice":{"type":"object","required":["name","amount","currency"],"properties":{"id":{"type":"string","format":"uuid","description":"Stable id of this price entry. Assigned server-side when omitted on create/update. Quote line items reference prices via this id, so keep existing ids when patching `prices`."},"name":{"type":"string","description":"Display name of the price variant (e.g. \"Monthly\", \"Annual\")."},"amount":{"type":"number","description":"Price amount per billing interval (or one-time amount when `interval` is not set)."},"currency":{"type":"string","description":"ISO 4217 currency code (e.g. `USD`, `EUR`)."},"interval":{"type":"string","enum":["day","week","month","quarter","year"],"nullable":true,"description":"Billing interval. Omit or set to `null` for a one-time price."},"discountType":{"type":"string","enum":["absolute","percentage"],"nullable":true,"description":"Type of the default discount applied when this price is added to a quote."},"discount":{"type":"number","nullable":true,"description":"Default discount value — an amount for `absolute` (applied per unit), a percentage (0–100) for `percentage`."},"minimumTermMonths":{"type":"integer","nullable":true,"description":"Explicit minimum contract duration in months for this price. The billing interval adds an implicit minimum on top (e.g. a yearly price implies at least 12 months)."}}},"Product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"workspaceId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"sku":{"type":"string","nullable":true},"prices":{"type":"array","items":{"$ref":"#/components/schemas/ProductPrice"}},"isDefault":{"type":"boolean","description":"Default products are prefilled as line items on newly created quotes."},"defaultPriceId":{"type":"string","format":"uuid","nullable":true,"description":"Id of a price entry inside `prices` (not a separate record) used when this product is prefilled on a new quote."},"order":{"type":"integer","nullable":true,"description":"Display order in the catalog."},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdById":{"type":"string","format":"uuid","nullable":true}}}},"responses":{"Unauthorized":{"description":"Authentication failed or token is invalid/expired","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}},"paths":{"/api/products":{"post":{"tags":["Products"],"summary":"Create a product","description":"Create a new catalog product. Requires workspace **admin** role.\n\nEach entry in `prices` is assigned a stable `id` server-side when omitted — quote line items reference a specific price via that id, so treat price ids as stable once created.\n","operationId":"createProduct","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCreate"}}}},"responses":{"200":{"description":"Product created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Product"},"sideEffects":{"type":"array","items":{}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## Get a product > Returns a single product by ID. ```json {"openapi":"3.0.3","info":{"title":"Zero API","version":"1.14.0"},"tags":[{"name":"Products","description":"Manage the workspace product catalog. Products hold one or more price variants (`prices`) that quotes reference as line items.\n\nWrite operations (create, update, delete) require the authenticated user to be a workspace **admin**.\n"}],"servers":[{"url":"https://api.zero.inc","description":"Production server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"All API requests require a Bearer token in the Authorization header. Create an API key from [Workspace Settings → API keys](https://app.zero.inc/settings/workspace/api)"}},"schemas":{"Product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"workspaceId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"sku":{"type":"string","nullable":true},"prices":{"type":"array","items":{"$ref":"#/components/schemas/ProductPrice"}},"isDefault":{"type":"boolean","description":"Default products are prefilled as line items on newly created quotes."},"defaultPriceId":{"type":"string","format":"uuid","nullable":true,"description":"Id of a price entry inside `prices` (not a separate record) used when this product is prefilled on a new quote."},"order":{"type":"integer","nullable":true,"description":"Display order in the catalog."},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdById":{"type":"string","format":"uuid","nullable":true}}},"ProductPrice":{"type":"object","required":["name","amount","currency"],"properties":{"id":{"type":"string","format":"uuid","description":"Stable id of this price entry. Assigned server-side when omitted on create/update. Quote line items reference prices via this id, so keep existing ids when patching `prices`."},"name":{"type":"string","description":"Display name of the price variant (e.g. \"Monthly\", \"Annual\")."},"amount":{"type":"number","description":"Price amount per billing interval (or one-time amount when `interval` is not set)."},"currency":{"type":"string","description":"ISO 4217 currency code (e.g. `USD`, `EUR`)."},"interval":{"type":"string","enum":["day","week","month","quarter","year"],"nullable":true,"description":"Billing interval. Omit or set to `null` for a one-time price."},"discountType":{"type":"string","enum":["absolute","percentage"],"nullable":true,"description":"Type of the default discount applied when this price is added to a quote."},"discount":{"type":"number","nullable":true,"description":"Default discount value — an amount for `absolute` (applied per unit), a percentage (0–100) for `percentage`."},"minimumTermMonths":{"type":"integer","nullable":true,"description":"Explicit minimum contract duration in months for this price. The billing interval adds an implicit minimum on top (e.g. a yearly price implies at least 12 months)."}}}},"responses":{"Unauthorized":{"description":"Authentication failed or token is invalid/expired","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}},"paths":{"/api/products/{productId}":{"get":{"tags":["Products"],"summary":"Get a product","description":"Returns a single product by ID.","operationId":"getProduct","parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response. If the product does not exist, the API returns HTTP 200 with an empty body (`{}`).\n","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Product"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## Delete a product > Delete a product. Requires workspace \*\*admin\*\* role. Use archive=true for soft delete. ```json {"openapi":"3.0.3","info":{"title":"Zero API","version":"1.14.0"},"tags":[{"name":"Products","description":"Manage the workspace product catalog. Products hold one or more price variants (`prices`) that quotes reference as line items.\n\nWrite operations (create, update, delete) require the authenticated user to be a workspace **admin**.\n"}],"servers":[{"url":"https://api.zero.inc","description":"Production server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"All API requests require a Bearer token in the Authorization header. Create an API key from [Workspace Settings → API keys](https://app.zero.inc/settings/workspace/api)"}},"schemas":{"Product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"workspaceId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"sku":{"type":"string","nullable":true},"prices":{"type":"array","items":{"$ref":"#/components/schemas/ProductPrice"}},"isDefault":{"type":"boolean","description":"Default products are prefilled as line items on newly created quotes."},"defaultPriceId":{"type":"string","format":"uuid","nullable":true,"description":"Id of a price entry inside `prices` (not a separate record) used when this product is prefilled on a new quote."},"order":{"type":"integer","nullable":true,"description":"Display order in the catalog."},"archived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdById":{"type":"string","format":"uuid","nullable":true}}},"ProductPrice":{"type":"object","required":["name","amount","currency"],"properties":{"id":{"type":"string","format":"uuid","description":"Stable id of this price entry. Assigned server-side when omitted on create/update. Quote line items reference prices via this id, so keep existing ids when patching `prices`."},"name":{"type":"string","description":"Display name of the price variant (e.g. \"Monthly\", \"Annual\")."},"amount":{"type":"number","description":"Price amount per billing interval (or one-time amount when `interval` is not set)."},"currency":{"type":"string","description":"ISO 4217 currency code (e.g. `USD`, `EUR`)."},"interval":{"type":"string","enum":["day","week","month","quarter","year"],"nullable":true,"description":"Billing interval. Omit or set to `null` for a one-time price."},"discountType":{"type":"string","enum":["absolute","percentage"],"nullable":true,"description":"Type of the default discount applied when this price is added to a quote."},"discount":{"type":"number","nullable":true,"description":"Default discount value — an amount for `absolute` (applied per unit), a percentage (0–100) for `percentage`."},"minimumTermMonths":{"type":"integer","nullable":true,"description":"Explicit minimum contract duration in months for this price. The billing interval adds an implicit minimum on top (e.g. a yearly price implies at least 12 months)."}}}},"responses":{"Unauthorized":{"description":"Authentication failed or token is invalid/expired","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"NotFound":{"description":"The requested resource was not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}},"paths":{"/api/products/{productId}":{"delete":{"tags":["Products"],"summary":"Delete a product","description":"Delete a product. Requires workspace **admin** role. Use archive=true for soft delete.","operationId":"deleteProduct","parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"archive","in":"query","description":"If true, soft deletes (archives) the product instead of permanently deleting it.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Product deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"Hard delete (`archive` omitted or `false`): returns `1` on success.\nSoft delete (`archive=true`): returns a single-element array containing the archived product object.\n","oneOf":[{"type":"integer"},{"type":"array","items":{"$ref":"#/components/schemas/Product"}}]},"sideEffects":{"type":"array","items":{}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}}} ``` ## Update a product > Update an existing product. Requires workspace \*\*admin\*\* role.\ > \ > \`prices\` is replaced as a whole — include every price entry (with its existing \`id\`) that should remain, not just the changed ones. New entries without an \`id\` get one assigned server-side.
```json {"openapi":"3.0.3","info":{"title":"Zero API","version":"1.14.0"},"tags":[{"name":"Products","description":"Manage the workspace product catalog. Products hold one or more price variants (`prices`) that quotes reference as line items.\n\nWrite operations (create, update, delete) require the authenticated user to be a workspace **admin**.\n"}],"servers":[{"url":"https://api.zero.inc","description":"Production server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"All API requests require a Bearer token in the Authorization header. Create an API key from [Workspace Settings → API keys](https://app.zero.inc/settings/workspace/api)"}},"schemas":{"ProductUpdate":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"sku":{"type":"string"},"prices":{"type":"array","description":"Replaced as a whole — include every price entry (with its existing `id`) that should remain.","items":{"$ref":"#/components/schemas/ProductPrice"}},"isDefault":{"type":"boolean"},"defaultPriceId":{"type":"string","format":"uuid"},"order":{"type":"integer"}}},"ProductPrice":{"type":"object","required":["name","amount","currency"],"properties":{"id":{"type":"string","format":"uuid","description":"Stable id of this price entry. Assigned server-side when omitted on create/update. Quote line items reference prices via this id, so keep existing ids when patching `prices`."},"name":{"type":"string","description":"Display name of the price variant (e.g. \"Monthly\", \"Annual\")."},"amount":{"type":"number","description":"Price amount per billing interval (or one-time amount when `interval` is not set)."},"currency":{"type":"string","description":"ISO 4217 currency code (e.g. `USD`, `EUR`)."},"interval":{"type":"string","enum":["day","week","month","quarter","year"],"nullable":true,"description":"Billing interval. Omit or set to `null` for a one-time price."},"discountType":{"type":"string","enum":["absolute","percentage"],"nullable":true,"description":"Type of the default discount applied when this price is added to a quote."},"discount":{"type":"number","nullable":true,"description":"Default discount value — an amount for `absolute` (applied per unit), a percentage (0–100) for `percentage`."},"minimumTermMonths":{"type":"integer","nullable":true,"description":"Explicit minimum contract duration in months for this price. The billing interval adds an implicit minimum on top (e.g. a yearly price implies at least 12 months)."}}}},"responses":{"Unauthorized":{"description":"Authentication failed or token is invalid/expired","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}},"paths":{"/api/products/{productId}":{"patch":{"tags":["Products"],"summary":"Update a product","description":"Update an existing product. Requires workspace **admin** role.\n\n`prices` is replaced as a whole — include every price entry (with its existing `id`) that should remain, not just the changed ones. New entries without an `id` get one assigned server-side.\n","operationId":"updateProduct","parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductUpdate"}}}},"responses":{"200":{"description":"Only the changed fields are returned in `data`. Use `GET` on the record to retrieve the full updated object.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"Only the changed fields, not the full object."},"sideEffects":{"type":"array","items":{}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.zero.inc/developers/api/products.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.