Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Polar","description":"Payments \u0026 Billing with 6 lines of code. Open Source \u0026 Global Merchant of Record.","colors":{"primary":"#000","light":"#fff","dark":"#000"},"logo":{"light":"https://mintcdn.com/polar/4USyJwN59kbPHT7o/logo/light.png?fit=max\u0026auto=format\u0026n=4USyJwN59kbPHT7o\u0026q=85\u0026s=e950d8c7839bea573a30b2b2f26b279e","dark":"https://mintcdn.com/polar/4USyJwN59kbPHT7o/logo/dark.png?fit=max\u0026auto=format\u0026n=4USyJwN59kbPHT7o\u0026q=85\u0026s=0cb4a91e4d18beb58a8a8ca4dd31e2bc","href":"https://polar.sh"},"favicon":"https://mintcdn.com/polar/4USyJwN59kbPHT7o/logo/favicon.png?fit=max\u0026auto=format\u0026n=4USyJwN59kbPHT7o\u0026q=85\u0026s=0cc6bd7c8b4641686d063d38f2d95c29","appearance":{"default":"system"},"background":{"color":{"dark":"#131316"}},"navbar":{"links":[{"href":"https://polar.sh/docs/llms-full.txt","label":"llms-full.txt"},{"href":"https://polar.sh/docs/support","label":"Contact support"}],"primary":{"type":"button","label":"Dashboard","href":"https://polar.sh"}},"footer":{"socials":{"x":"https://x.com/polar_sh","github":"https://github.com/polarsource/polar","discord":"https://dub.sh/polar-discord"}},"seo":{"metatags":{"og:site_name":"Polar","og:image":"https://polar.sh/assets/brand/polar_og.jpg","og:type":"website","twitter:card":"summary_large_image","twitter:site":"@polar_sh"}},"styling":{"latex":false},"integrations":{"ga4":{"measurementId":"G-MBYW1QZFHE"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"polar","hasAudioNarration":false,"actualSubdomain":"polar","customDomains":["polar.sh","buy.polar.sh","sandbox.polar.sh","vcpypolar.xyz"],"gitSource":{"type":"github","owner":"polarsource","repo":"polar","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ada209b67b3b5d0ad9b9edc","collectionId":"dc2af58a-3120-4f5d-81d6-da0d31a07760","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada209b67b3b5d0ad9b9edc"},"feedback":{"edits":true,"thumbs":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ada209b67b3b5d0ad9b9edc","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":521},{"language":"default","tag":"Core API","count":287},{"language":"default","tag":"Docs","count":124},{"language":"default","tag":"Webhook Events","count":117},{"language":"default","tag":"Billing Events","count":81},{"language":"default","tag":"Customer Portal API","count":81},{"language":"default","tag":"Subscriptions","count":65},{"language":"default","tag":"Integrate","count":60},{"language":"default","tag":"Features","count":57},{"language":"default","tag":"Orders","count":48}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@polar.sh"}},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".chat-assistant-floating-input:is(.dark *)::before,.dark\\:bg-background-dark:is(.dark *){background-color:#070708}#content-area{max-width:48rem}.migration-coexistence{--migration-columns:42% 16% 42%;--migration-line:#d4d4d8;--migration-dot:#71717a;margin:2rem 0;padding:1.5rem;color:#18181b;background:#fff;border:1px solid #e4e4e7;border-radius:1.25rem}.migration-coexistence__tree{max-width:28rem;margin:0 auto}.migration-coexistence__node{padding:.75rem .875rem;background:#fafafa;border:1px solid #e4e4e7;border-radius:.875rem}.migration-coexistence__node--app{max-width:14rem;margin:0 auto;text-align:center}.migration-coexistence__node--stripe{border-top:2px solid #635bff}.migration-coexistence__node--polar{border-top:2px solid #18181b}.migration-coexistence__name{display:block;color:#18181b;font-size:.8125rem;font-weight:700}.migration-coexistence__note{display:block;margin-top:.125rem;color:#71717a;font-size:.75rem}.migration-coexistence__branch{display:block;width:100%;aspect-ratio:100/12;overflow:visible}.migration-coexistence__rail{fill:none;stroke:var(--migration-line);stroke-dasharray:4 4;stroke-width:1}.migration-coexistence__dot{fill:var(--migration-dot)}.migration-coexistence__children{display:grid;grid-template-columns:var(--migration-columns)}.migration-coexistence__caption{max-width:32rem;margin:1.25rem auto 0;color:#52525b;font-size:.875rem;line-height:1.55;text-align:center}.migration-switch{margin:1.5rem 0;overflow:hidden;background:#fff;border:1px solid #e4e4e7;border-radius:1rem}.migration-switch__header,.migration-switch__row{display:grid;grid-template-columns:minmax(0,1fr) 3.5rem minmax(0,1fr);align-items:center}.migration-switch__header{padding:.75rem 1rem;background:#fafafa;border-bottom:1px solid #e4e4e7;color:#18181b;font-size:.8125rem;font-weight:700}.migration-switch__header span:nth-child(2){color:#71717a;font-size:.6875rem;font-weight:600;letter-spacing:.06em;text-align:center;text-transform:uppercase}.migration-switch__header span:last-child{text-align:right}.migration-switch__row{min-height:4rem;padding:.75rem 1rem;color:#52525b;font-size:.8125rem}.migration-switch__row+.migration-switch__row{border-top:1px solid #f4f4f5}.migration-switch__arrow{display:grid;width:1.75rem;height:1.75rem;margin:0 auto;place-items:center;color:#52525b;background:#f4f4f5;border-radius:999px}.migration-switch__state--polar{color:#18181b;font-weight:600;text-align:right}.dark .migration-coexistence{--migration-line:#52525b;--migration-dot:#a1a1aa;color:#fafafa;background:#131316;border-color:#3f3f46}.dark .migration-coexistence__node{background:#18181b;border-color:#3f3f46}.dark .migration-coexistence__node--stripe{border-top-color:#635bff}.dark .migration-coexistence__node--polar{border-top-color:#fafafa}.dark .migration-coexistence__name{color:#fafafa}.dark .migration-coexistence__caption,.dark .migration-coexistence__note{color:#a1a1aa}.dark .migration-switch{background:#131316;border-color:#3f3f46}.dark .migration-switch__header{color:#fafafa;background:#18181b;border-bottom-color:#3f3f46}.dark .migration-switch__header span:nth-child(2),.dark .migration-switch__row{color:#a1a1aa}.dark .migration-switch__row+.migration-switch__row{border-top-color:#27272a}.dark .migration-switch__arrow{color:#d4d4d8;background:#27272a}.dark .migration-switch__state--polar{color:#fafafa}@media (max-width:42rem){.migration-coexistence{padding:1.125rem}.migration-coexistence__node--app{max-width:none}.migration-coexistence__caption{font-size:.8125rem}.migration-switch__header,.migration-switch__row{grid-template-columns:minmax(0,1fr) 2.5rem minmax(0,1fr);padding-right:.75rem;padding-left:.75rem}}@media (prefers-reduced-motion:reduce){.migration-coexistence__dot{display:none}}"}],"page":{"pagePath":"api-reference/2026-10/products/list-products","slug":"/api-reference/2026-10/products/list-products","pageMetadata":{"title":"List Products","description":"List products.\n\n**Scopes**: `products:read` `products:write`","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/products/","href":"/api-reference/2026-10/products/list-products","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"List products.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Scopes\"\n }), \": \", _jsx(_components.code, {\n children: \"products:read\"\n }), \" \", _jsx(_components.code, {\n children: \"products:write\"\n })]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List Products","description":"List products.\n\n**Scopes**: `products:read` `products:write`","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/products/","href":"/api-reference/2026-10/products/list-products","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["products","public","mcp","cli"],"summary":"List Products","description":"List products.\n\n**Scopes**: `products:read` `products:write`","operationId":"products:list","security":["f04cc3d0-b3cb-404e-9531-3282a85e40fa","daecde23-21f3-4086-97e7-a227a96b6958","04a5a20b-b496-4f83-92ec-61974a3604ca"],"parameters":["5470b7a6-f64e-4c04-ba77-1a9759182837","107d895a-6fa8-4791-85d6-f4d60103cc49","70d44a06-c6ac-4def-ab45-ab561a7650fe","5e0d556e-d433-48ac-87ff-99cfaffa0864","2db56ce6-15be-47c9-9f5a-f2f1beccb107","0fc35230-92a5-4886-a6b6-c4caa1462a81","75b35dcf-d1f5-42f2-bd61-b42f19514aab","a62edb87-3fee-4635-8974-92de66a8026b","ea4a64cd-d20f-4382-aecb-703b99999486","957b7c16-e644-43f5-9927-14e477128a83","662627ea-69ce-4be7-adf7-ca959f02ed82"],"responses":{"200":"b3d4a1c4-e2f0-45e4-99b4-c249019e4835","422":"eec163a2-dfa8-4f7c-92c2-f31df7a2a0d4"},"x-tool-name":"products_list","x-tool-title":"List Products","x-tool-description":"List products.","x-tool-annotations":["read_only","idempotent"],"x-polar-allowed-subjects":["Organization","User"],"x-speakeasy-pagination":{"type":"offsetLimit","inputs":[{"name":"page","in":"parameters","type":"page"},{"name":"limit","in":"parameters","type":"limit"}],"outputs":{"results":"$.items","numPages":"$.pagination.max_page"}},"x-speakeasy-group":"products","x-speakeasy-name-override":"list","x-polar-pagination":{"type":"page_limit","item_schema":{"$ref":"#/components/schemas/Product"}},"x-codeSamples":[{"lang":"python","source":"from polar.v2026_10 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nfor item in polar.products.iter_list(\n page=1,\n limit=10,\n sorting=['-created_at'],\n):\n print(item)\n"},{"lang":"typescript","source":"import { createPolar } from \"@polar-sh/sdk/2026-10\";\n\nconst polar = createPolar({\n accessToken: \"polar_oat_xxx\",\n});\n\nfor await (const item of polar.products.iterList(\n {\n \"page\": 1,\n \"limit\": 10,\n \"sorting\": [\n \"-created_at\"\n ]\n },\n)) {\n console.log(item);\n}\n"}],"method":"get","type":"path","servers":["0a3cfd4b-9634-4505-9004-41aa566b6b35","81edcbdc-9117-4d62-9bcc-a4eb8c29ac19"],"path":"/v1/products/","baseUrlOptions":["https://api.polar.sh","https://sandbox-api.polar.sh"],"title":"List Products","codeSamples":[{"lang":"python","source":"from polar.v2026_10 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nfor item in polar.products.iter_list(\n page=1,\n limit=10,\n sorting=['-created_at'],\n):\n print(item)\n"},{"lang":"typescript","source":"import { createPolar } from \"@polar-sh/sdk/2026-10\";\n\nconst polar = createPolar({\n accessToken: \"polar_oat_xxx\",\n});\n\nfor await (const item of polar.products.iterList(\n {\n \"page\": 1,\n \"limit\": 10,\n \"sorting\": [\n \"-created_at\"\n ]\n },\n)) {\n console.log(item);\n}\n"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"5470b7a6-f64e-4c04-ba77-1a9759182837":{"name":"id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"ProductID Filter","description":"Filter by product ID.\nThe product ID.","format":"uuid4","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"array","items":{"type":"string","format":"uuid4","description":"The product ID.","uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"string\u003cuuid4>"},"title":"ProductID Filter","description":"Filter by product ID.","uniqueKey":"oneOf.1","typeLabel":"string\u003cuuid4>[]"},{"type":"null","title":"ProductID Filter","description":"Filter by product ID.","uniqueKey":"oneOf.2","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid4> | string\u003cuuid4>[] | null"},"description":"Filter by product ID."},"107d895a-6fa8-4791-85d6-f4d60103cc49":{"name":"organization_id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"OrganizationID Filter","description":"Filter by organization ID.\nThe organization ID.","format":"uuid4","example":"1dbfc517-0bbf-4301-9ba8-555ca42b9737","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"array","items":{"type":"string","format":"uuid4","description":"The organization ID.","examples":["1dbfc517-0bbf-4301-9ba8-555ca42b9737"],"uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"string\u003cuuid4>"},"title":"OrganizationID Filter","description":"Filter by organization ID.","uniqueKey":"oneOf.1","typeLabel":"string\u003cuuid4>[]"},{"type":"null","title":"OrganizationID Filter","description":"Filter by organization ID.","uniqueKey":"oneOf.2","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid4> | string\u003cuuid4>[] | null"},"description":"Filter by organization ID."},"70d44a06-c6ac-4def-ab45-ab561a7650fe":{"name":"query","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Query","description":"Filter by product name.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Query","description":"Filter by product name.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"Filter by product name."},"5e0d556e-d433-48ac-87ff-99cfaffa0864":{"name":"is_archived","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Is Archived","description":"Filter on archived products.","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Archived","description":"Filter on archived products.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"},"description":"Filter on archived products."},"2db56ce6-15be-47c9-9f5a-f2f1beccb107":{"name":"is_recurring","in":"query","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Is Recurring","description":"Filter on recurring products. If `true`, only subscriptions tiers are returned. If `false`, only one-time purchase products are returned. ","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Recurring","description":"Filter on recurring products. If `true`, only subscriptions tiers are returned. If `false`, only one-time purchase products are returned. ","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"},"description":"Filter on recurring products. If `true`, only subscriptions tiers are returned. If `false`, only one-time purchase products are returned. "},"0fc35230-92a5-4886-a6b6-c4caa1462a81":{"name":"benefit_id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"BenefitID Filter","description":"Filter products granting specific benefit.\nThe benefit ID.","format":"uuid4","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"array","items":{"type":"string","format":"uuid4","description":"The benefit ID.","uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"string\u003cuuid4>"},"title":"BenefitID Filter","description":"Filter products granting specific benefit.","uniqueKey":"oneOf.1","typeLabel":"string\u003cuuid4>[]"},{"type":"null","title":"BenefitID Filter","description":"Filter products granting specific benefit.","uniqueKey":"oneOf.2","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid4> | string\u003cuuid4>[] | null"},"description":"Filter products granting specific benefit."},"75b35dcf-d1f5-42f2-bd61-b42f19514aab":{"name":"visibility","in":"query","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","enum":["draft","private","public"],"title":"Visibility","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Visibility","description":"Filter by visibility.","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Visibility","description":"Filter by visibility.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[] | null"},"description":"Filter by visibility."},"a62edb87-3fee-4635-8974-92de66a8026b":{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page","isRequired":false,"uniqueKey":"","typeLabel":"integer"},"description":"Page number, defaults to 1."},"ea4a64cd-d20f-4382-aecb-703b99999486":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 100.","default":10,"title":"Limit","isRequired":false,"uniqueKey":"","typeLabel":"integer"},"description":"Size of a page, defaults to 10. Maximum is 100."},"957b7c16-e644-43f5-9927-14e477128a83":{"name":"sorting","in":"query","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","enum":["created_at","-created_at","name","-name","price_amount_type","-price_amount_type","price_amount","-price_amount"],"title":"ProductSortProperty","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Sorting","description":"Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.","default":["-created_at"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Sorting","description":"Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.","default":["-created_at"],"uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[] | null"},"description":"Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order."},"662627ea-69ce-4be7-adf7-ca959f02ed82":{"name":"metadata","in":"query","required":false,"style":"deepObject","schema":{"oneOf":[{"type":"object","title":"MetadataQuery","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"oneOf.0.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"boolean","uniqueKey":"oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.additionalProperties.oneOf.3.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.additionalProperties.oneOf.3","typeLabel":"string[]"},{"type":"array","items":{"type":"integer","uniqueKey":"oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"oneOf.0.additionalProperties.oneOf.4","typeLabel":"integer[]"},{"type":"array","items":{"type":"boolean","uniqueKey":"oneOf.0.additionalProperties.oneOf.5.items.[INDEX]","typeLabel":"boolean"},"uniqueKey":"oneOf.0.additionalProperties.oneOf.5","typeLabel":"boolean[]"}],"uniqueKey":"oneOf.0.additionalProperties","typeLabel":"string | integer | boolean | string[] | integer[] | boolean[]"},"description":"Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.","uniqueKey":"oneOf.0","typeLabel":"MetadataQuery · object"},{"type":"null","title":"MetadataQuery","description":"Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"MetadataQuery · object | null"},"description":"Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`."}},"responses":{"b3d4a1c4-e2f0-45e4-99b4-c249019e4835":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].modified_at","typeLabel":"string\u003cdate-time> | null"},"trial_interval":{"oneOf":[{"type":"string","title":"TrialInterval","description":"The interval unit for the trial period.","enum":["day","week","month","year"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].trial_interval.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The interval unit for the trial period.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].trial_interval.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].trial_interval","typeLabel":"enum\u003cstring> | null"},"trial_interval_count":{"oneOf":[{"type":"integer","title":"Trial Interval Count","description":"The number of interval units for the trial period.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].trial_interval_count.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Trial Interval Count","description":"The number of interval units for the trial period.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].trial_interval_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].trial_interval_count","typeLabel":"integer | null"},"name":{"type":"string","title":"Name","description":"The name of the product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","title":"Description","description":"The description of the product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","description":"The description of the product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string | null"},"visibility":{"type":"string","enum":["draft","private","public"],"title":"Visibility","description":"The visibility of the product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].visibility","typeLabel":"enum\u003cstring>"},"recurring_interval":{"oneOf":[{"type":"string","title":"RecurringInterval","description":"The recurring interval of the product. If `None`, the product is a one-time purchase.","enum":["day","week","month","year"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].recurring_interval.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The recurring interval of the product. If `None`, the product is a one-time purchase.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].recurring_interval.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].recurring_interval","typeLabel":"enum\u003cstring> | null"},"recurring_interval_count":{"oneOf":[{"type":"integer","title":"Recurring Interval Count","description":"Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].recurring_interval_count.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Recurring Interval Count","description":"Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].recurring_interval_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].recurring_interval_count","typeLabel":"integer | null"},"meter_interval":{"oneOf":[{"type":"string","title":"RecurringInterval","description":"The meter cycle of the product, independent of the billing interval. If `None`, metered concerns follow the billing interval.","enum":["day","week","month","year"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].meter_interval.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The meter cycle of the product, independent of the billing interval. If `None`, metered concerns follow the billing interval.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].meter_interval.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].meter_interval","typeLabel":"enum\u003cstring> | null"},"meter_interval_count":{"oneOf":[{"type":"integer","title":"Meter Interval Count","description":"Number of meter interval units. None when no meter cycle is set.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].meter_interval_count.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Meter Interval Count","description":"Number of meter interval units. None when no meter cycle is set.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].meter_interval_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].meter_interval_count","typeLabel":"integer | null"},"is_recurring":{"type":"boolean","title":"Is Recurring","description":"Whether the product is a subscription.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].is_recurring","typeLabel":"boolean"},"is_archived":{"type":"boolean","title":"Is Archived","description":"Whether the product is archived and no longer available.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].is_archived","typeLabel":"boolean"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].organization_id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].metadata","typeLabel":"object"},"is_deletable":{"type":"boolean","title":"Is Deletable","description":"Whether the product can be permanently deleted. Products referenced by an order, subscription, trial or discount cannot be deleted.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].is_deletable","typeLabel":"boolean"},"prices":{"items":{"oneOf":[{"type":"object","title":"LegacyRecurringProductPriceFixed","description":"A recurring price for a product, i.e. a subscription.\n\n**Deprecated**: The recurring interval should be set on the product itself.","required":["created_at","modified_at","id","source","amount_type","price_currency","tax_behavior","is_archived","product_id","type","recurring_interval","price_amount","legacy"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.id","typeLabel":"string\u003cuuid4>"},"source":{"type":"string","enum":["catalog","ad_hoc"],"title":"ProductPriceSource","description":"The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.source","typeLabel":"enum\u003cstring>"},"amount_type":{"type":"string","const":"fixed","title":"Amount Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.amount_type","typeLabel":"string"},"price_currency":{"type":"string","title":"Price Currency","description":"The currency in which the customer will be charged.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.price_currency","typeLabel":"string"},"tax_behavior":{"oneOf":[{"type":"string","title":"TaxBehaviorOption","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","enum":["location","inclusive","exclusive"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.tax_behavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.tax_behavior.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.tax_behavior","typeLabel":"enum\u003cstring> | null"},"is_archived":{"type":"boolean","title":"Is Archived","description":"Whether the price is archived and no longer available.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.is_archived","typeLabel":"boolean"},"product_id":{"type":"string","format":"uuid4","title":"Product Id","description":"The ID of the product owning the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.product_id","typeLabel":"string\u003cuuid4>"},"type":{"type":"string","const":"recurring","title":"Type","description":"The type of the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.type","typeLabel":"string"},"recurring_interval":{"type":"string","enum":["day","week","month","year"],"title":"RecurringInterval","description":"The recurring interval of the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.recurring_interval","typeLabel":"enum\u003cstring>"},"price_amount":{"type":"integer","title":"Price Amount","description":"The price in cents.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.price_amount","typeLabel":"integer"},"legacy":{"type":"boolean","const":true,"title":"Legacy","readOnly":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0.legacy","typeLabel":"boolean"}},"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.0","typeLabel":"LegacyRecurringProductPriceFixed · object"},{"type":"object","title":"LegacyRecurringProductPriceCustom","description":"A pay-what-you-want recurring price for a product, i.e. a subscription.\n\n**Deprecated**: The recurring interval should be set on the product itself.","required":["created_at","modified_at","id","source","amount_type","price_currency","tax_behavior","is_archived","product_id","type","recurring_interval","minimum_amount","maximum_amount","preset_amount","legacy"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.id","typeLabel":"string\u003cuuid4>"},"source":{"type":"string","enum":["catalog","ad_hoc"],"title":"ProductPriceSource","description":"The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.source","typeLabel":"enum\u003cstring>"},"amount_type":{"type":"string","const":"custom","title":"Amount Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.amount_type","typeLabel":"string"},"price_currency":{"type":"string","title":"Price Currency","description":"The currency in which the customer will be charged.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.price_currency","typeLabel":"string"},"tax_behavior":{"oneOf":[{"type":"string","title":"TaxBehaviorOption","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","enum":["location","inclusive","exclusive"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.tax_behavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.tax_behavior.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.tax_behavior","typeLabel":"enum\u003cstring> | null"},"is_archived":{"type":"boolean","title":"Is Archived","description":"Whether the price is archived and no longer available.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.is_archived","typeLabel":"boolean"},"product_id":{"type":"string","format":"uuid4","title":"Product Id","description":"The ID of the product owning the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.product_id","typeLabel":"string\u003cuuid4>"},"type":{"type":"string","const":"recurring","title":"Type","description":"The type of the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.type","typeLabel":"string"},"recurring_interval":{"type":"string","enum":["day","week","month","year"],"title":"RecurringInterval","description":"The recurring interval of the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.recurring_interval","typeLabel":"enum\u003cstring>"},"minimum_amount":{"type":"integer","title":"Minimum Amount","description":"The minimum amount the customer can pay. If 0, the price is 'free or pay what you want'.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.minimum_amount","typeLabel":"integer"},"maximum_amount":{"oneOf":[{"type":"integer","title":"Maximum Amount","description":"The maximum amount the customer can pay.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.maximum_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Maximum Amount","description":"The maximum amount the customer can pay.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.maximum_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.maximum_amount","typeLabel":"integer | null"},"preset_amount":{"oneOf":[{"type":"integer","title":"Preset Amount","description":"The initial amount shown to the customer.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.preset_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Preset Amount","description":"The initial amount shown to the customer.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.preset_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.preset_amount","typeLabel":"integer | null"},"legacy":{"type":"boolean","const":true,"title":"Legacy","readOnly":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1.legacy","typeLabel":"boolean"}},"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.1","typeLabel":"LegacyRecurringProductPriceCustom · object"},{"type":"object","title":"ProductPriceFixed","description":"A fixed price for a product.","required":["created_at","modified_at","id","source","amount_type","price_currency","tax_behavior","is_archived","product_id","price_amount"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.id","typeLabel":"string\u003cuuid4>"},"source":{"type":"string","enum":["catalog","ad_hoc"],"title":"ProductPriceSource","description":"The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.source","typeLabel":"enum\u003cstring>"},"amount_type":{"type":"string","const":"fixed","title":"Amount Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.amount_type","typeLabel":"string"},"price_currency":{"type":"string","title":"Price Currency","description":"The currency in which the customer will be charged.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.price_currency","typeLabel":"string"},"tax_behavior":{"oneOf":[{"type":"string","title":"TaxBehaviorOption","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","enum":["location","inclusive","exclusive"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.tax_behavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.tax_behavior.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.tax_behavior","typeLabel":"enum\u003cstring> | null"},"is_archived":{"type":"boolean","title":"Is Archived","description":"Whether the price is archived and no longer available.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.is_archived","typeLabel":"boolean"},"product_id":{"type":"string","format":"uuid4","title":"Product Id","description":"The ID of the product owning the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.product_id","typeLabel":"string\u003cuuid4>"},"price_amount":{"type":"integer","title":"Price Amount","description":"The price in cents.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2.price_amount","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.2","typeLabel":"ProductPriceFixed · object"},{"type":"object","title":"ProductPriceCustom","description":"A pay-what-you-want price for a product.","required":["created_at","modified_at","id","source","amount_type","price_currency","tax_behavior","is_archived","product_id","minimum_amount","maximum_amount","preset_amount"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.id","typeLabel":"string\u003cuuid4>"},"source":{"type":"string","enum":["catalog","ad_hoc"],"title":"ProductPriceSource","description":"The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.source","typeLabel":"enum\u003cstring>"},"amount_type":{"type":"string","const":"custom","title":"Amount Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.amount_type","typeLabel":"string"},"price_currency":{"type":"string","title":"Price Currency","description":"The currency in which the customer will be charged.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.price_currency","typeLabel":"string"},"tax_behavior":{"oneOf":[{"type":"string","title":"TaxBehaviorOption","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","enum":["location","inclusive","exclusive"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.tax_behavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.tax_behavior.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.tax_behavior","typeLabel":"enum\u003cstring> | null"},"is_archived":{"type":"boolean","title":"Is Archived","description":"Whether the price is archived and no longer available.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.is_archived","typeLabel":"boolean"},"product_id":{"type":"string","format":"uuid4","title":"Product Id","description":"The ID of the product owning the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.product_id","typeLabel":"string\u003cuuid4>"},"minimum_amount":{"type":"integer","title":"Minimum Amount","description":"The minimum amount the customer can pay. If 0, the price is 'free or pay what you want'.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.minimum_amount","typeLabel":"integer"},"maximum_amount":{"oneOf":[{"type":"integer","title":"Maximum Amount","description":"The maximum amount the customer can pay.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.maximum_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Maximum Amount","description":"The maximum amount the customer can pay.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.maximum_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.maximum_amount","typeLabel":"integer | null"},"preset_amount":{"oneOf":[{"type":"integer","title":"Preset Amount","description":"The initial amount shown to the customer.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.preset_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Preset Amount","description":"The initial amount shown to the customer.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.preset_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3.preset_amount","typeLabel":"integer | null"}},"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.3","typeLabel":"ProductPriceCustom · object"},{"type":"object","title":"ProductPriceSeatBased","description":"A seat-based price for a product.","required":["created_at","modified_at","id","source","amount_type","price_currency","tax_behavior","is_archived","product_id","seat_tiers"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.id","typeLabel":"string\u003cuuid4>"},"source":{"type":"string","enum":["catalog","ad_hoc"],"title":"ProductPriceSource","description":"The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.source","typeLabel":"enum\u003cstring>"},"amount_type":{"type":"string","const":"seat_based","title":"Amount Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.amount_type","typeLabel":"string"},"price_currency":{"type":"string","title":"Price Currency","description":"The currency in which the customer will be charged.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.price_currency","typeLabel":"string"},"tax_behavior":{"oneOf":[{"type":"string","title":"TaxBehaviorOption","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","enum":["location","inclusive","exclusive"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.tax_behavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.tax_behavior.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.tax_behavior","typeLabel":"enum\u003cstring> | null"},"is_archived":{"type":"boolean","title":"Is Archived","description":"Whether the price is archived and no longer available.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.is_archived","typeLabel":"boolean"},"product_id":{"type":"string","format":"uuid4","title":"Product Id","description":"The ID of the product owning the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.product_id","typeLabel":"string\u003cuuid4>"},"seat_tiers":{"properties":{"tiers":{"items":{"properties":{"min_seats":{"type":"integer","minimum":1,"title":"Min Seats","description":"Minimum number of seats (inclusive)","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.seat_tiers.tiers.items.[INDEX].min_seats","typeLabel":"integer"},"price_per_seat":{"type":"integer","maximum":9223372036854776000,"minimum":0,"title":"Price Per Seat","description":"Price per seat in cents for this tier","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.seat_tiers.tiers.items.[INDEX].price_per_seat","typeLabel":"integer"},"max_seats":{"oneOf":[{"type":"integer","title":"Max Seats","description":"Maximum number of seats (inclusive). None for unlimited.","minimum":1,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.seat_tiers.tiers.items.[INDEX].max_seats.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Max Seats","description":"Maximum number of seats (inclusive). None for unlimited.","uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.seat_tiers.tiers.items.[INDEX].max_seats.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.seat_tiers.tiers.items.[INDEX].max_seats","typeLabel":"integer | null"}},"type":"object","required":["min_seats","price_per_seat"],"title":"ProductPriceSeatTier","description":"A pricing tier for seat-based pricing.","uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.seat_tiers.tiers.items.[INDEX]","typeLabel":"ProductPriceSeatTier · object"},"type":"array","minItems":1,"title":"Tiers","description":"List of pricing tiers","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.seat_tiers.tiers","typeLabel":"ProductPriceSeatTier · object[]"},"minimum_seats":{"type":"integer","title":"Minimum Seats","description":"Minimum number of seats required for purchase, derived from first tier.","readOnly":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.seat_tiers.minimum_seats","typeLabel":"integer"},"maximum_seats":{"oneOf":[{"type":"integer","title":"Maximum Seats","description":"Maximum number of seats allowed for purchase, derived from last tier. None for unlimited.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.seat_tiers.maximum_seats.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Maximum Seats","description":"Maximum number of seats allowed for purchase, derived from last tier. None for unlimited.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.seat_tiers.maximum_seats.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.seat_tiers.maximum_seats","typeLabel":"integer | null"},"seat_tier_type":{"type":"string","enum":["volume","graduated"],"title":"SeatTierType","description":"How tiers are applied. 'volume' prices all seats at the matching tier's rate. 'graduated' prices each tier's range independently.","default":"volume","uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.seat_tiers.seat_tier_type","typeLabel":"enum\u003cstring>"}},"type":"object","required":["tiers","minimum_seats","maximum_seats"],"title":"ProductPriceSeatTiers","description":"Tiered pricing based on seat quantity","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4.seat_tiers","typeLabel":"ProductPriceSeatTiers · object"}},"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.4","typeLabel":"ProductPriceSeatBased · object"},{"type":"object","title":"ProductPriceUnitBased","description":"A unit-based price for a product: the buyer picks a quantity of units,\npays for it up-front. On subscriptions, quantity changes are prorated.","required":["created_at","modified_at","id","source","amount_type","price_currency","tax_behavior","is_archived","product_id","tiers","minimum_units","unit_label","maximum_units"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.id","typeLabel":"string\u003cuuid4>"},"source":{"type":"string","enum":["catalog","ad_hoc"],"title":"ProductPriceSource","description":"The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.source","typeLabel":"enum\u003cstring>"},"amount_type":{"type":"string","const":"unit_based","title":"Amount Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.amount_type","typeLabel":"string"},"price_currency":{"type":"string","title":"Price Currency","description":"The currency in which the customer will be charged.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.price_currency","typeLabel":"string"},"tax_behavior":{"oneOf":[{"type":"string","title":"TaxBehaviorOption","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","enum":["location","inclusive","exclusive"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.tax_behavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.tax_behavior.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.tax_behavior","typeLabel":"enum\u003cstring> | null"},"is_archived":{"type":"boolean","title":"Is Archived","description":"Whether the price is archived and no longer available.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.is_archived","typeLabel":"boolean"},"product_id":{"type":"string","format":"uuid4","title":"Product Id","description":"The ID of the product owning the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.product_id","typeLabel":"string\u003cuuid4>"},"tiers":{"properties":{"type":{"type":"string","enum":["volume","graduated"],"title":"TierType","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.tiers.type","typeLabel":"enum\u003cstring>"},"tiers":{"items":{"properties":{"unit_amount":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Unit Amount","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.tiers.tiers.items.[INDEX].unit_amount","typeLabel":"string"},"bound":{"oneOf":[{"type":"integer","title":"Bound","minimum":0,"exclusiveMinimum":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.tiers.tiers.items.[INDEX].bound.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Bound","uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.tiers.tiers.items.[INDEX].bound.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.tiers.tiers.items.[INDEX].bound","typeLabel":"integer | null"}},"type":"object","required":["unit_amount"],"title":"Tier","description":"A per-unit rate up to and including `bound`.\n\nEach tier starts where the previous one ended. The first starts at\nzero. `bound` is None on the last tier if it's unbounded. Rates are\nin cents and may be fractional.\n\nRates carry no precision bound: this schema reads stored rows, and a\nbound tightened later would stop them loading. `TierInput` holds the\nrules new rates must meet.","uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.tiers.tiers.items.[INDEX]","typeLabel":"Tier · object"},"type":"array","minItems":1,"title":"Tiers","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.tiers.tiers","typeLabel":"Tier · object[]"}},"type":"object","required":["type","tiers"],"title":"Tiers","description":"Tiered pricing based on the purchased unit quantity.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.tiers","typeLabel":"Tiers · object"},"minimum_units":{"oneOf":[{"type":"integer","title":"Minimum Units","description":"The minimum purchasable quantity (inclusive).","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.minimum_units.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Minimum Units","description":"The minimum purchasable quantity (inclusive).","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.minimum_units.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.minimum_units","typeLabel":"integer | null"},"unit_label":{"oneOf":[{"type":"object","title":"Unit Label","description":"Per-locale unit nouns shown at checkout and on invoices. `null` defaults to \"unit\"/\"units\".","minLength":1,"example":{"en":{"=1":"seat","other":"seats"}},"additionalProperties":{"additionalProperties":{"type":"string","uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.unit_label.oneOf.0.additionalProperties.additionalProperties","typeLabel":"string"},"type":"object","uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.unit_label.oneOf.0.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.unit_label.oneOf.0","typeLabel":"Unit Label · object"},{"type":"null","title":"Unit Label","description":"Per-locale unit nouns shown at checkout and on invoices. `null` defaults to \"unit\"/\"units\".","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.unit_label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.unit_label","typeLabel":"Unit Label · object | null"},"maximum_units":{"oneOf":[{"type":"integer","title":"Maximum Units","description":"The maximum purchasable quantity, from the last tier's bound. `null` for unlimited.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.maximum_units.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Maximum Units","description":"The maximum purchasable quantity, from the last tier's bound. `null` for unlimited.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.maximum_units.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5.maximum_units","typeLabel":"integer | null"}},"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.5","typeLabel":"ProductPriceUnitBased · object"},{"type":"object","title":"ProductPriceMeteredUnit","description":"A metered, usage-based, price for a product, with a fixed unit price.","required":["created_at","modified_at","id","source","amount_type","price_currency","tax_behavior","is_archived","product_id","cap_amount","meter_id","meter","unit_amount"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.id","typeLabel":"string\u003cuuid4>"},"source":{"type":"string","enum":["catalog","ad_hoc"],"title":"ProductPriceSource","description":"The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.source","typeLabel":"enum\u003cstring>"},"amount_type":{"type":"string","const":"metered_unit","title":"Amount Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.amount_type","typeLabel":"string"},"price_currency":{"type":"string","title":"Price Currency","description":"The currency in which the customer will be charged.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.price_currency","typeLabel":"string"},"tax_behavior":{"oneOf":[{"type":"string","title":"TaxBehaviorOption","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","enum":["location","inclusive","exclusive"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.tax_behavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.tax_behavior.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.tax_behavior","typeLabel":"enum\u003cstring> | null"},"is_archived":{"type":"boolean","title":"Is Archived","description":"Whether the price is archived and no longer available.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.is_archived","typeLabel":"boolean"},"product_id":{"type":"string","format":"uuid4","title":"Product Id","description":"The ID of the product owning the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.product_id","typeLabel":"string\u003cuuid4>"},"cap_amount":{"oneOf":[{"type":"integer","title":"Cap Amount","description":"The maximum amount in cents that can be charged, regardless of the number of units consumed.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.cap_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Cap Amount","description":"The maximum amount in cents that can be charged, regardless of the number of units consumed.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.cap_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.cap_amount","typeLabel":"integer | null"},"meter_id":{"type":"string","format":"uuid4","title":"Meter Id","description":"The ID of the meter associated to the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.meter_id","typeLabel":"string\u003cuuid4>"},"meter":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.meter.id","typeLabel":"string\u003cuuid4>"},"name":{"type":"string","title":"Name","description":"The name of the meter.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.meter.name","typeLabel":"string"},"unit":{"type":"string","enum":["scalar","token","custom"],"title":"MeterUnit","description":"The unit of the meter.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.meter.unit","typeLabel":"enum\u003cstring>"},"custom_label":{"oneOf":[{"type":"string","title":"Custom Label","description":"The label for the custom unit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.meter.custom_label.oneOf.0","typeLabel":"string"},{"type":"null","title":"Custom Label","description":"The label for the custom unit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.meter.custom_label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.meter.custom_label","typeLabel":"string | null"},"custom_multiplier":{"oneOf":[{"type":"integer","title":"Custom Multiplier","description":"The multiplier to convert from base unit to display scale.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.meter.custom_multiplier.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Custom Multiplier","description":"The multiplier to convert from base unit to display scale.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.meter.custom_multiplier.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.meter.custom_multiplier","typeLabel":"integer | null"}},"type":"object","required":["id","name","unit","custom_label","custom_multiplier"],"title":"ProductPriceMeter","description":"The meter associated to the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.meter","typeLabel":"ProductPriceMeter · object"},"unit_amount":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Unit Amount","description":"The price per unit in cents.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6.unit_amount","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.6","typeLabel":"ProductPriceMeteredUnit · object"},{"type":"object","title":"ProductPriceMeteredTiers","description":"A metered, usage-based, price for a product, billed from tiers.","required":["created_at","modified_at","id","source","amount_type","price_currency","tax_behavior","is_archived","product_id","cap_amount","meter_id","meter","tiers"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.id","typeLabel":"string\u003cuuid4>"},"source":{"type":"string","enum":["catalog","ad_hoc"],"title":"ProductPriceSource","description":"The source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.source","typeLabel":"enum\u003cstring>"},"amount_type":{"type":"string","const":"metered_tiers","title":"Amount Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.amount_type","typeLabel":"string"},"price_currency":{"type":"string","title":"Price Currency","description":"The currency in which the customer will be charged.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.price_currency","typeLabel":"string"},"tax_behavior":{"oneOf":[{"type":"string","title":"TaxBehaviorOption","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","enum":["location","inclusive","exclusive"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.tax_behavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The tax behavior of the price. If null, it defaults to the organization's default tax behavior.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.tax_behavior.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.tax_behavior","typeLabel":"enum\u003cstring> | null"},"is_archived":{"type":"boolean","title":"Is Archived","description":"Whether the price is archived and no longer available.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.is_archived","typeLabel":"boolean"},"product_id":{"type":"string","format":"uuid4","title":"Product Id","description":"The ID of the product owning the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.product_id","typeLabel":"string\u003cuuid4>"},"cap_amount":{"oneOf":[{"type":"integer","title":"Cap Amount","description":"The maximum amount in cents that can be charged, regardless of the number of units consumed.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.cap_amount.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Cap Amount","description":"The maximum amount in cents that can be charged, regardless of the number of units consumed.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.cap_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.cap_amount","typeLabel":"integer | null"},"meter_id":{"type":"string","format":"uuid4","title":"Meter Id","description":"The ID of the meter associated to the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.meter_id","typeLabel":"string\u003cuuid4>"},"meter":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.meter.id","typeLabel":"string\u003cuuid4>"},"name":{"type":"string","title":"Name","description":"The name of the meter.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.meter.name","typeLabel":"string"},"unit":{"type":"string","enum":["scalar","token","custom"],"title":"MeterUnit","description":"The unit of the meter.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.meter.unit","typeLabel":"enum\u003cstring>"},"custom_label":{"oneOf":[{"type":"string","title":"Custom Label","description":"The label for the custom unit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.meter.custom_label.oneOf.0","typeLabel":"string"},{"type":"null","title":"Custom Label","description":"The label for the custom unit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.meter.custom_label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.meter.custom_label","typeLabel":"string | null"},"custom_multiplier":{"oneOf":[{"type":"integer","title":"Custom Multiplier","description":"The multiplier to convert from base unit to display scale.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.meter.custom_multiplier.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Custom Multiplier","description":"The multiplier to convert from base unit to display scale.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.meter.custom_multiplier.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.meter.custom_multiplier","typeLabel":"integer | null"}},"type":"object","required":["id","name","unit","custom_label","custom_multiplier"],"title":"ProductPriceMeter","description":"The meter associated to the price.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.meter","typeLabel":"ProductPriceMeter · object"},"tiers":{"properties":{"type":{"type":"string","enum":["volume","graduated"],"title":"TierType","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.tiers.type","typeLabel":"enum\u003cstring>"},"tiers":{"items":{"properties":{"unit_amount":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Unit Amount","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.tiers.tiers.items.[INDEX].unit_amount","typeLabel":"string"},"bound":{"oneOf":[{"type":"integer","title":"Bound","minimum":0,"exclusiveMinimum":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.tiers.tiers.items.[INDEX].bound.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Bound","uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.tiers.tiers.items.[INDEX].bound.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.tiers.tiers.items.[INDEX].bound","typeLabel":"integer | null"}},"type":"object","required":["unit_amount"],"title":"Tier","description":"A per-unit rate up to and including `bound`.\n\nEach tier starts where the previous one ended. The first starts at\nzero. `bound` is None on the last tier if it's unbounded. Rates are\nin cents and may be fractional.\n\nRates carry no precision bound: this schema reads stored rows, and a\nbound tightened later would stop them loading. `TierInput` holds the\nrules new rates must meet.","uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.tiers.tiers.items.[INDEX]","typeLabel":"Tier · object"},"type":"array","minItems":1,"title":"Tiers","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.tiers.tiers","typeLabel":"Tier · object[]"}},"type":"object","required":["type","tiers"],"title":"Tiers","description":"The pricing tiers based on consumed units.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7.tiers","typeLabel":"Tiers · object"}},"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX].oneOf.7","typeLabel":"ProductPriceMeteredTiers · object"}],"uniqueKey":"\\items.items.[INDEX].prices.items.[INDEX]","typeLabel":"LegacyRecurringProductPriceFixed · object | LegacyRecurringProductPriceCustom · object | ProductPriceFixed · object | ProductPriceCustom · object | ProductPriceSeatBased · object | ProductPriceUnitBased · object | ProductPriceMeteredUnit · object | ProductPriceMeteredTiers · object"},"type":"array","title":"Prices","description":"List of prices for this product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].prices","typeLabel":"(LegacyRecurringProductPriceFixed · object | LegacyRecurringProductPriceCustom · object | ProductPriceFixed · object | ProductPriceCustom · object | ProductPriceSeatBased · object | ProductPriceUnitBased · object | ProductPriceMeteredUnit · object | ProductPriceMeteredTiers · object)[]"},"benefits":{"items":{"oneOf":[{"type":"object","title":"BenefitCustom","description":"A benefit of type `custom`.\n\nUse it to grant any kind of benefit that doesn't fit in the other types.","required":["id","created_at","modified_at","type","description","selectable","deletable","is_deleted","organization_id","metadata","visibility","properties","visibility_configurable"],"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.id","typeLabel":"string\u003cuuid4>"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.modified_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","const":"custom","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.type","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"The description of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.description","typeLabel":"string"},"selectable":{"type":"boolean","title":"Selectable","description":"Whether the benefit is selectable when creating a product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.selectable","typeLabel":"boolean"},"deletable":{"type":"boolean","title":"Deletable","description":"Whether the benefit is deletable.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.deletable","typeLabel":"boolean"},"is_deleted":{"type":"boolean","title":"Is Deleted","description":"Whether the benefit is deleted.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.is_deleted","typeLabel":"boolean"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.organization_id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.metadata","typeLabel":"object"},"visibility":{"type":"string","enum":["draft","private","public"],"title":"Visibility","description":"The visibility of the benefit in the customer portal.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.visibility","typeLabel":"enum\u003cstring>"},"properties":{"properties":{"note":{"oneOf":[{"type":"string","title":"Note","description":"Private note to be shared with customers who have this benefit granted.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.properties.note.oneOf.0","typeLabel":"string"},{"type":"null","title":"Note","description":"Private note to be shared with customers who have this benefit granted.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.properties.note.oneOf.1","typeLabel":"null"},{"type":"null","title":"Note","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.properties.note.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.properties.note","typeLabel":"string · null · null"}},"type":"object","required":["note"],"title":"BenefitCustomProperties","description":"Properties for a benefit of type `custom`.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.properties","typeLabel":"BenefitCustomProperties · object"},"visibility_configurable":{"type":"boolean","title":"Visibility Configurable","readOnly":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0.visibility_configurable","typeLabel":"boolean"}},"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.0","typeLabel":"BenefitCustom · object"},{"type":"object","title":"BenefitDiscord","description":"A benefit of type `discord`.\n\nUse it to automatically invite your backers to a Discord server.","required":["id","created_at","modified_at","type","description","selectable","deletable","is_deleted","organization_id","metadata","visibility","properties","visibility_configurable"],"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.id","typeLabel":"string\u003cuuid4>"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.modified_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","const":"discord","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.type","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"The description of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.description","typeLabel":"string"},"selectable":{"type":"boolean","title":"Selectable","description":"Whether the benefit is selectable when creating a product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.selectable","typeLabel":"boolean"},"deletable":{"type":"boolean","title":"Deletable","description":"Whether the benefit is deletable.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.deletable","typeLabel":"boolean"},"is_deleted":{"type":"boolean","title":"Is Deleted","description":"Whether the benefit is deleted.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.is_deleted","typeLabel":"boolean"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.organization_id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.metadata","typeLabel":"object"},"visibility":{"type":"string","enum":["draft","private","public"],"title":"Visibility","description":"The visibility of the benefit in the customer portal.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.visibility","typeLabel":"enum\u003cstring>"},"properties":{"properties":{"guild_id":{"type":"string","title":"Guild Id","description":"The ID of the Discord server.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.properties.guild_id","typeLabel":"string"},"role_id":{"type":"string","title":"Role Id","description":"The ID of the Discord role to grant.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.properties.role_id","typeLabel":"string"},"kick_member":{"type":"boolean","title":"Kick Member","description":"Whether to kick the member from the Discord server on revocation.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.properties.kick_member","typeLabel":"boolean"}},"type":"object","required":["guild_id","role_id","kick_member"],"title":"BenefitDiscordProperties","description":"Properties for a benefit of type `discord`.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.properties","typeLabel":"BenefitDiscordProperties · object"},"visibility_configurable":{"type":"boolean","title":"Visibility Configurable","readOnly":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1.visibility_configurable","typeLabel":"boolean"}},"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.1","typeLabel":"BenefitDiscord · object"},{"type":"object","title":"BenefitGitHubRepository","description":"A benefit of type `github_repository`.\n\nUse it to automatically invite your backers to a private GitHub repository.","required":["id","created_at","modified_at","type","description","selectable","deletable","is_deleted","organization_id","metadata","visibility","properties","visibility_configurable"],"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.id","typeLabel":"string\u003cuuid4>"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.modified_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","const":"github_repository","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.type","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"The description of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.description","typeLabel":"string"},"selectable":{"type":"boolean","title":"Selectable","description":"Whether the benefit is selectable when creating a product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.selectable","typeLabel":"boolean"},"deletable":{"type":"boolean","title":"Deletable","description":"Whether the benefit is deletable.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.deletable","typeLabel":"boolean"},"is_deleted":{"type":"boolean","title":"Is Deleted","description":"Whether the benefit is deleted.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.is_deleted","typeLabel":"boolean"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.organization_id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.metadata","typeLabel":"object"},"visibility":{"type":"string","enum":["draft","private","public"],"title":"Visibility","description":"The visibility of the benefit in the customer portal.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.visibility","typeLabel":"enum\u003cstring>"},"properties":{"properties":{"repository_owner":{"type":"string","title":"Repository Owner","description":"The owner of the repository.","examples":["polarsource"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.properties.repository_owner","typeLabel":"string"},"repository_name":{"type":"string","title":"Repository Name","description":"The name of the repository.","examples":["private_repo"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.properties.repository_name","typeLabel":"string"},"permission":{"type":"string","enum":["pull","triage","push","maintain","admin"],"title":"Permission","description":"The permission level to grant. Read more about roles and their permissions on [GitHub documentation](https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role).","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.properties.permission","typeLabel":"enum\u003cstring>"}},"type":"object","required":["repository_owner","repository_name","permission"],"title":"BenefitGitHubRepositoryProperties","description":"Properties for a benefit of type `github_repository`.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.properties","typeLabel":"BenefitGitHubRepositoryProperties · object"},"visibility_configurable":{"type":"boolean","title":"Visibility Configurable","readOnly":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2.visibility_configurable","typeLabel":"boolean"}},"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.2","typeLabel":"BenefitGitHubRepository · object"},{"type":"object","title":"BenefitDownloadables","required":["id","created_at","modified_at","type","description","selectable","deletable","is_deleted","organization_id","metadata","visibility","properties","visibility_configurable"],"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.id","typeLabel":"string\u003cuuid4>"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.modified_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","const":"downloadables","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.type","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"The description of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.description","typeLabel":"string"},"selectable":{"type":"boolean","title":"Selectable","description":"Whether the benefit is selectable when creating a product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.selectable","typeLabel":"boolean"},"deletable":{"type":"boolean","title":"Deletable","description":"Whether the benefit is deletable.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.deletable","typeLabel":"boolean"},"is_deleted":{"type":"boolean","title":"Is Deleted","description":"Whether the benefit is deleted.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.is_deleted","typeLabel":"boolean"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.organization_id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.metadata","typeLabel":"object"},"visibility":{"type":"string","enum":["draft","private","public"],"title":"Visibility","description":"The visibility of the benefit in the customer portal.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.visibility","typeLabel":"enum\u003cstring>"},"properties":{"properties":{"archived":{"additionalProperties":{"type":"boolean","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.properties.archived.additionalProperties","typeLabel":"boolean"},"propertyNames":{"format":"uuid4"},"type":"object","title":"Archived","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.properties.archived","typeLabel":"Archived · object"},"files":{"items":{"type":"string","format":"uuid4","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.properties.files.items.[INDEX]","typeLabel":"string\u003cuuid4>"},"type":"array","title":"Files","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.properties.files","typeLabel":"string\u003cuuid4>[]"}},"type":"object","required":["archived","files"],"title":"BenefitDownloadablesProperties","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.properties","typeLabel":"BenefitDownloadablesProperties · object"},"visibility_configurable":{"type":"boolean","title":"Visibility Configurable","readOnly":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3.visibility_configurable","typeLabel":"boolean"}},"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.3","typeLabel":"BenefitDownloadables · object"},{"type":"object","title":"BenefitLicenseKeys","required":["id","created_at","modified_at","type","description","selectable","deletable","is_deleted","organization_id","metadata","visibility","properties","visibility_configurable"],"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.id","typeLabel":"string\u003cuuid4>"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.modified_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","const":"license_keys","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.type","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"The description of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.description","typeLabel":"string"},"selectable":{"type":"boolean","title":"Selectable","description":"Whether the benefit is selectable when creating a product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.selectable","typeLabel":"boolean"},"deletable":{"type":"boolean","title":"Deletable","description":"Whether the benefit is deletable.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.deletable","typeLabel":"boolean"},"is_deleted":{"type":"boolean","title":"Is Deleted","description":"Whether the benefit is deleted.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.is_deleted","typeLabel":"boolean"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.organization_id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.metadata","typeLabel":"object"},"visibility":{"type":"string","enum":["draft","private","public"],"title":"Visibility","description":"The visibility of the benefit in the customer portal.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.visibility","typeLabel":"enum\u003cstring>"},"properties":{"properties":{"prefix":{"oneOf":[{"type":"string","title":"Prefix","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.prefix.oneOf.0","typeLabel":"string"},{"type":"null","title":"Prefix","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.prefix.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.prefix","typeLabel":"string | null"},"expires":{"oneOf":[{"type":"object","title":"BenefitLicenseKeyExpirationProperties","required":["ttl","timeframe"],"properties":{"ttl":{"type":"integer","exclusiveMinimum":0,"title":"Ttl","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.expires.oneOf.0.ttl","typeLabel":"integer"},"timeframe":{"type":"string","enum":["year","month","day"],"title":"Timeframe","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.expires.oneOf.0.timeframe","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.expires.oneOf.0","typeLabel":"BenefitLicenseKeyExpirationProperties · object"},{"type":"null","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.expires.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.expires","typeLabel":"BenefitLicenseKeyExpirationProperties · object | null"},"activations":{"oneOf":[{"type":"object","title":"BenefitLicenseKeyActivationProperties","required":["limit","enable_customer_admin"],"properties":{"limit":{"type":"integer","title":"Limit","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.activations.oneOf.0.limit","typeLabel":"integer"},"enable_customer_admin":{"type":"boolean","title":"Enable Customer Admin","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.activations.oneOf.0.enable_customer_admin","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.activations.oneOf.0","typeLabel":"BenefitLicenseKeyActivationProperties · object"},{"type":"null","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.activations.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.activations","typeLabel":"BenefitLicenseKeyActivationProperties · object | null"},"limit_usage":{"oneOf":[{"type":"integer","title":"Limit Usage","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.limit_usage.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Limit Usage","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.limit_usage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties.limit_usage","typeLabel":"integer | null"}},"type":"object","required":["prefix","expires","activations","limit_usage"],"title":"BenefitLicenseKeysProperties","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.properties","typeLabel":"BenefitLicenseKeysProperties · object"},"visibility_configurable":{"type":"boolean","title":"Visibility Configurable","readOnly":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4.visibility_configurable","typeLabel":"boolean"}},"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.4","typeLabel":"BenefitLicenseKeys · object"},{"type":"object","title":"BenefitMeterCredit","description":"A benefit of type `meter_unit`.\n\nUse it to grant a number of units on a specific meter.","required":["id","created_at","modified_at","type","description","selectable","deletable","is_deleted","organization_id","metadata","visibility","properties","visibility_configurable"],"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.id","typeLabel":"string\u003cuuid4>"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.modified_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","const":"meter_credit","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.type","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"The description of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.description","typeLabel":"string"},"selectable":{"type":"boolean","title":"Selectable","description":"Whether the benefit is selectable when creating a product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.selectable","typeLabel":"boolean"},"deletable":{"type":"boolean","title":"Deletable","description":"Whether the benefit is deletable.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.deletable","typeLabel":"boolean"},"is_deleted":{"type":"boolean","title":"Is Deleted","description":"Whether the benefit is deleted.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.is_deleted","typeLabel":"boolean"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.organization_id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.metadata","typeLabel":"object"},"visibility":{"type":"string","enum":["draft","private","public"],"title":"Visibility","description":"The visibility of the benefit in the customer portal.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.visibility","typeLabel":"enum\u003cstring>"},"properties":{"properties":{"units":{"type":"integer","title":"Units","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.properties.units","typeLabel":"integer"},"rollover":{"type":"boolean","title":"Rollover","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.properties.rollover","typeLabel":"boolean"},"meter_id":{"type":"string","format":"uuid4","title":"Meter Id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.properties.meter_id","typeLabel":"string\u003cuuid4>"}},"type":"object","required":["units","rollover","meter_id"],"title":"BenefitMeterCreditProperties","description":"Properties for a benefit of type `meter_unit`.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.properties","typeLabel":"BenefitMeterCreditProperties · object"},"visibility_configurable":{"type":"boolean","title":"Visibility Configurable","readOnly":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5.visibility_configurable","typeLabel":"boolean"}},"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.5","typeLabel":"BenefitMeterCredit · object"},{"type":"object","title":"BenefitFeatureFlag","description":"A benefit of type `feature_flag`.\n\nUse it to grant feature flags with key-value metadata\nthat can be queried via the API and webhooks.","required":["id","created_at","modified_at","type","description","selectable","deletable","is_deleted","organization_id","metadata","visibility","properties","visibility_configurable"],"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.id","typeLabel":"string\u003cuuid4>"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.modified_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","const":"feature_flag","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.type","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"The description of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.description","typeLabel":"string"},"selectable":{"type":"boolean","title":"Selectable","description":"Whether the benefit is selectable when creating a product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.selectable","typeLabel":"boolean"},"deletable":{"type":"boolean","title":"Deletable","description":"Whether the benefit is deletable.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.deletable","typeLabel":"boolean"},"is_deleted":{"type":"boolean","title":"Is Deleted","description":"Whether the benefit is deleted.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.is_deleted","typeLabel":"boolean"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.organization_id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.metadata","typeLabel":"object"},"visibility":{"type":"string","enum":["draft","private","public"],"title":"Visibility","description":"The visibility of the benefit in the customer portal.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.visibility","typeLabel":"enum\u003cstring>"},"properties":{"properties":{},"type":"object","title":"BenefitFeatureFlagProperties","description":"Properties for a benefit of type `feature_flag`.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.properties","typeLabel":"BenefitFeatureFlagProperties · object"},"visibility_configurable":{"type":"boolean","title":"Visibility Configurable","readOnly":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6.visibility_configurable","typeLabel":"boolean"}},"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.6","typeLabel":"BenefitFeatureFlag · object"},{"type":"object","title":"BenefitSlackSharedChannel","required":["id","created_at","modified_at","type","description","selectable","deletable","is_deleted","organization_id","metadata","visibility","properties","visibility_configurable"],"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.id","typeLabel":"string\u003cuuid4>"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.modified_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","const":"slack_shared_channel","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.type","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"The description of the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.description","typeLabel":"string"},"selectable":{"type":"boolean","title":"Selectable","description":"Whether the benefit is selectable when creating a product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.selectable","typeLabel":"boolean"},"deletable":{"type":"boolean","title":"Deletable","description":"Whether the benefit is deletable.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.deletable","typeLabel":"boolean"},"is_deleted":{"type":"boolean","title":"Is Deleted","description":"Whether the benefit is deleted.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.is_deleted","typeLabel":"boolean"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.organization_id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.metadata","typeLabel":"object"},"visibility":{"type":"string","enum":["draft","private","public"],"title":"Visibility","description":"The visibility of the benefit in the customer portal.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.visibility","typeLabel":"enum\u003cstring>"},"properties":{"properties":{"slack_integration_id":{"type":"string","format":"uuid4","title":"Slack Integration Id","description":"Polar Slack integration linked to this benefit.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.properties.slack_integration_id","typeLabel":"string\u003cuuid4>"},"channel_name_template":{"type":"string","maxLength":80,"minLength":1,"title":"Channel Name Template","description":"Template for the channel name. Supports placeholders: {customer_name}, {customer_email_local}, and {metadata.\u003ckey>} for any value stored in customer user metadata.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.properties.channel_name_template","typeLabel":"string"},"private":{"type":"boolean","title":"Private","description":"Create the channel as private (recommended).","default":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.properties.private","typeLabel":"boolean"},"welcome_message":{"oneOf":[{"type":"string","title":"Welcome Message","description":"Optional message posted to the channel right after creation.","maxLength":4000,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.properties.welcome_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Welcome Message","description":"Optional message posted to the channel right after creation.","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.properties.welcome_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.properties.welcome_message","typeLabel":"string | null"},"archive_on_revoke":{"type":"boolean","title":"Archive On Revoke","description":"Archive the channel when the benefit is revoked.","default":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.properties.archive_on_revoke","typeLabel":"boolean"},"team_invitees":{"items":{"type":"string","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.properties.team_invitees.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Team Invitees","description":"Slack user IDs from the merchant workspace to invite to every channel created for this benefit.","uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.properties.team_invitees","typeLabel":"string[]"}},"type":"object","required":["slack_integration_id","channel_name_template"],"title":"BenefitSlackSharedChannelProperties","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.properties","typeLabel":"BenefitSlackSharedChannelProperties · object"},"visibility_configurable":{"type":"boolean","title":"Visibility Configurable","readOnly":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7.visibility_configurable","typeLabel":"boolean"}},"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX].oneOf.7","typeLabel":"BenefitSlackSharedChannel · object"}],"uniqueKey":"\\items.items.[INDEX].benefits.items.[INDEX]","typeLabel":"BenefitCustom · object | BenefitDiscord · object | BenefitGitHubRepository · object | BenefitDownloadables · object | BenefitLicenseKeys · object | BenefitMeterCredit · object | BenefitFeatureFlag · object | BenefitSlackSharedChannel · object"},"type":"array","title":"Benefits","description":"List of benefits granted by the product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].benefits","typeLabel":"(BenefitCustom · object | BenefitDiscord · object | BenefitGitHubRepository · object | BenefitDownloadables · object | BenefitLicenseKeys · object | BenefitMeterCredit · object | BenefitFeatureFlag · object | BenefitSlackSharedChannel · object)[]"},"medias":{"items":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].organization_id","typeLabel":"string\u003cuuid4>"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].name","typeLabel":"string"},"path":{"type":"string","title":"Path","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].path","typeLabel":"string"},"mime_type":{"type":"string","title":"Mime Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].mime_type","typeLabel":"string"},"size":{"type":"integer","title":"Size","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].size","typeLabel":"integer"},"storage_version":{"oneOf":[{"type":"string","title":"Storage Version","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].storage_version.oneOf.0","typeLabel":"string"},{"type":"null","title":"Storage Version","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].storage_version.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].storage_version","typeLabel":"string | null"},"checksum_etag":{"oneOf":[{"type":"string","title":"Checksum Etag","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].checksum_etag.oneOf.0","typeLabel":"string"},{"type":"null","title":"Checksum Etag","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].checksum_etag.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].checksum_etag","typeLabel":"string | null"},"checksum_sha256_base64":{"oneOf":[{"type":"string","title":"Checksum Sha256 Base64","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].checksum_sha256_base64.oneOf.0","typeLabel":"string"},{"type":"null","title":"Checksum Sha256 Base64","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].checksum_sha256_base64.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].checksum_sha256_base64","typeLabel":"string | null"},"checksum_sha256_hex":{"oneOf":[{"type":"string","title":"Checksum Sha256 Hex","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].checksum_sha256_hex.oneOf.0","typeLabel":"string"},{"type":"null","title":"Checksum Sha256 Hex","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].checksum_sha256_hex.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].checksum_sha256_hex","typeLabel":"string | null"},"last_modified_at":{"oneOf":[{"type":"string","title":"Last Modified At","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].last_modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Modified At","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].last_modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].last_modified_at","typeLabel":"string\u003cdate-time> | null"},"version":{"oneOf":[{"type":"string","title":"Version","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].version.oneOf.0","typeLabel":"string"},{"type":"null","title":"Version","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].version.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].version","typeLabel":"string | null"},"service":{"type":"string","const":"product_media","title":"Service","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].service","typeLabel":"string"},"is_uploaded":{"type":"boolean","title":"Is Uploaded","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].is_uploaded","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","title":"Created At","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"size_readable":{"type":"string","title":"Size Readable","readOnly":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].size_readable","typeLabel":"string"},"public_url":{"type":"string","title":"Public Url","readOnly":true,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX].public_url","typeLabel":"string"}},"type":"object","required":["id","organization_id","name","path","mime_type","size","storage_version","checksum_etag","checksum_sha256_base64","checksum_sha256_hex","last_modified_at","version","service","is_uploaded","created_at","size_readable","public_url"],"title":"ProductMediaFileRead","description":"File to be used as a product media file.","uniqueKey":"\\items.items.[INDEX].medias.items.[INDEX]","typeLabel":"ProductMediaFileRead · object"},"type":"array","title":"Medias","description":"List of medias associated to the product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].medias","typeLabel":"ProductMediaFileRead · object[]"},"attached_custom_fields":{"items":{"properties":{"custom_field_id":{"type":"string","format":"uuid4","title":"Custom Field Id","description":"ID of the custom field.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field_id","typeLabel":"string\u003cuuid4>"},"custom_field":{"oneOf":[{"type":"object","title":"CustomFieldText","description":"Schema for a custom field of type text.","required":["created_at","modified_at","id","metadata","type","slug","name","organization_id","properties"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.metadata","typeLabel":"object"},"type":{"type":"string","const":"text","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.type","typeLabel":"string"},"slug":{"type":"string","title":"Slug","description":"Identifier of the custom field. It'll be used as key when storing the value.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.slug","typeLabel":"string"},"name":{"type":"string","title":"Name","description":"Name of the custom field.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.name","typeLabel":"string"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the custom field.","examples":["1dbfc517-0bbf-4301-9ba8-555ca42b9737"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.organization_id","typeLabel":"string\u003cuuid4>"},"properties":{"properties":{"form_label":{"type":"string","minLength":1,"title":"Form Label","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.properties.form_label","typeLabel":"string"},"form_help_text":{"type":"string","minLength":1,"title":"Form Help Text","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.properties.form_help_text","typeLabel":"string"},"form_placeholder":{"type":"string","minLength":1,"title":"Form Placeholder","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.properties.form_placeholder","typeLabel":"string"},"textarea":{"type":"boolean","title":"Textarea","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.properties.textarea","typeLabel":"boolean"},"min_length":{"type":"integer","maximum":2147483647,"minimum":0,"title":"Min Length","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.properties.min_length","typeLabel":"integer"},"max_length":{"type":"integer","maximum":2147483647,"minimum":0,"title":"Max Length","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.properties.max_length","typeLabel":"integer"}},"type":"object","title":"CustomFieldTextProperties","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0.properties","typeLabel":"CustomFieldTextProperties · object"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.0","typeLabel":"CustomFieldText · object"},{"type":"object","title":"CustomFieldNumber","description":"Schema for a custom field of type number.","required":["created_at","modified_at","id","metadata","type","slug","name","organization_id","properties"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.metadata","typeLabel":"object"},"type":{"type":"string","const":"number","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.type","typeLabel":"string"},"slug":{"type":"string","title":"Slug","description":"Identifier of the custom field. It'll be used as key when storing the value.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.slug","typeLabel":"string"},"name":{"type":"string","title":"Name","description":"Name of the custom field.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.name","typeLabel":"string"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the custom field.","examples":["1dbfc517-0bbf-4301-9ba8-555ca42b9737"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.organization_id","typeLabel":"string\u003cuuid4>"},"properties":{"properties":{"form_label":{"type":"string","minLength":1,"title":"Form Label","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.properties.form_label","typeLabel":"string"},"form_help_text":{"type":"string","minLength":1,"title":"Form Help Text","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.properties.form_help_text","typeLabel":"string"},"form_placeholder":{"type":"string","minLength":1,"title":"Form Placeholder","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.properties.form_placeholder","typeLabel":"string"},"ge":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"title":"Ge","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.properties.ge","typeLabel":"integer"},"le":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"title":"Le","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.properties.le","typeLabel":"integer"}},"type":"object","title":"CustomFieldNumberProperties","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1.properties","typeLabel":"CustomFieldNumberProperties · object"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.1","typeLabel":"CustomFieldNumber · object"},{"type":"object","title":"CustomFieldDate","description":"Schema for a custom field of type date.","required":["created_at","modified_at","id","metadata","type","slug","name","organization_id","properties"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.metadata","typeLabel":"object"},"type":{"type":"string","const":"date","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.type","typeLabel":"string"},"slug":{"type":"string","title":"Slug","description":"Identifier of the custom field. It'll be used as key when storing the value.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.slug","typeLabel":"string"},"name":{"type":"string","title":"Name","description":"Name of the custom field.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.name","typeLabel":"string"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the custom field.","examples":["1dbfc517-0bbf-4301-9ba8-555ca42b9737"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.organization_id","typeLabel":"string\u003cuuid4>"},"properties":{"properties":{"form_label":{"type":"string","minLength":1,"title":"Form Label","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.properties.form_label","typeLabel":"string"},"form_help_text":{"type":"string","minLength":1,"title":"Form Help Text","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.properties.form_help_text","typeLabel":"string"},"form_placeholder":{"type":"string","minLength":1,"title":"Form Placeholder","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.properties.form_placeholder","typeLabel":"string"},"ge":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"title":"Ge","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.properties.ge","typeLabel":"integer"},"le":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"title":"Le","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.properties.le","typeLabel":"integer"}},"type":"object","title":"CustomFieldDateProperties","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2.properties","typeLabel":"CustomFieldDateProperties · object"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.2","typeLabel":"CustomFieldDate · object"},{"type":"object","title":"CustomFieldCheckbox","description":"Schema for a custom field of type checkbox.","required":["created_at","modified_at","id","metadata","type","slug","name","organization_id","properties"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.metadata","typeLabel":"object"},"type":{"type":"string","const":"checkbox","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.type","typeLabel":"string"},"slug":{"type":"string","title":"Slug","description":"Identifier of the custom field. It'll be used as key when storing the value.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.slug","typeLabel":"string"},"name":{"type":"string","title":"Name","description":"Name of the custom field.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.name","typeLabel":"string"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the custom field.","examples":["1dbfc517-0bbf-4301-9ba8-555ca42b9737"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.organization_id","typeLabel":"string\u003cuuid4>"},"properties":{"properties":{"form_label":{"type":"string","minLength":1,"title":"Form Label","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.properties.form_label","typeLabel":"string"},"form_help_text":{"type":"string","minLength":1,"title":"Form Help Text","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.properties.form_help_text","typeLabel":"string"},"form_placeholder":{"type":"string","minLength":1,"title":"Form Placeholder","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.properties.form_placeholder","typeLabel":"string"}},"type":"object","title":"CustomFieldCheckboxProperties","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3.properties","typeLabel":"CustomFieldCheckboxProperties · object"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.3","typeLabel":"CustomFieldCheckbox · object"},{"type":"object","title":"CustomFieldSelect","description":"Schema for a custom field of type select.","required":["created_at","modified_at","id","metadata","type","slug","name","organization_id","properties"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.id","typeLabel":"string\u003cuuid4>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.metadata","typeLabel":"object"},"type":{"type":"string","const":"select","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.type","typeLabel":"string"},"slug":{"type":"string","title":"Slug","description":"Identifier of the custom field. It'll be used as key when storing the value.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.slug","typeLabel":"string"},"name":{"type":"string","title":"Name","description":"Name of the custom field.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.name","typeLabel":"string"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the custom field.","examples":["1dbfc517-0bbf-4301-9ba8-555ca42b9737"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.organization_id","typeLabel":"string\u003cuuid4>"},"properties":{"properties":{"options":{"items":{"properties":{"value":{"type":"string","minLength":1,"title":"Value","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.properties.options.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","minLength":1,"title":"Label","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.properties.options.items.[INDEX].label","typeLabel":"string"}},"type":"object","required":["value","label"],"title":"CustomFieldSelectOption","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.properties.options.items.[INDEX]","typeLabel":"CustomFieldSelectOption · object"},"type":"array","minItems":1,"title":"Options","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.properties.options","typeLabel":"CustomFieldSelectOption · object[]"},"form_label":{"type":"string","minLength":1,"title":"Form Label","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.properties.form_label","typeLabel":"string"},"form_help_text":{"type":"string","minLength":1,"title":"Form Help Text","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.properties.form_help_text","typeLabel":"string"},"form_placeholder":{"type":"string","minLength":1,"title":"Form Placeholder","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.properties.form_placeholder","typeLabel":"string"}},"type":"object","required":["options"],"title":"CustomFieldSelectProperties","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4.properties","typeLabel":"CustomFieldSelectProperties · object"}},"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field.oneOf.4","typeLabel":"CustomFieldSelect · object"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].custom_field","typeLabel":"CustomFieldText · object | CustomFieldNumber · object | CustomFieldDate · object | CustomFieldCheckbox · object | CustomFieldSelect · object"},"order":{"type":"integer","title":"Order","description":"Order of the custom field in the resource.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].order","typeLabel":"integer"},"required":{"type":"boolean","title":"Required","description":"Whether the value is required for this custom field.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX].required","typeLabel":"boolean"}},"type":"object","required":["custom_field_id","custom_field","order","required"],"title":"AttachedCustomField","description":"Schema of a custom field attached to a resource.","uniqueKey":"\\items.items.[INDEX].attached_custom_fields.items.[INDEX]","typeLabel":"AttachedCustomField · object"},"type":"array","title":"Attached Custom Fields","description":"List of custom fields attached to the product.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].attached_custom_fields","typeLabel":"AttachedCustomField · object[]"}},"type":"object","required":["id","created_at","modified_at","trial_interval","trial_interval_count","name","description","visibility","recurring_interval","recurring_interval_count","meter_interval","meter_interval_count","is_recurring","is_archived","organization_id","metadata","is_deletable","prices","benefits","medias","attached_custom_fields"],"title":"Product","description":"A product.","uniqueKey":"\\items.items.[INDEX]","typeLabel":"Product · object"},"type":"array","title":"Items","isRequired":true,"uniqueKey":"\\items","typeLabel":"Product · object[]"},"pagination":{"properties":{"total_count":{"type":"integer","title":"Total Count","isRequired":true,"uniqueKey":"pagination.total_count","typeLabel":"integer"},"max_page":{"type":"integer","title":"Max Page","isRequired":true,"uniqueKey":"pagination.max_page","typeLabel":"integer"}},"type":"object","required":["total_count","max_page"],"title":"Pagination","isRequired":true,"uniqueKey":"pagination","typeLabel":"Pagination · object"}},"type":"object","required":["items","pagination"],"title":"ListResource[Product]","uniqueKey":"","typeLabel":"ListResource[Product] · object"},"examples":{"Example":{"title":"Example","value":{"items":[{"id":"\u003cstring>","created_at":"2026-01-01T00:00:00.000000Z","modified_at":"2026-01-01T00:00:00.000000Z","trial_interval":"day","trial_interval_count":123,"name":"\u003cstring>","description":"\u003cstring>","visibility":"draft","recurring_interval":"day","recurring_interval_count":123,"meter_interval":"day","meter_interval_count":123,"is_recurring":true,"is_archived":true,"organization_id":"\u003cstring>","metadata":{},"is_deletable":true,"prices":[{"created_at":"2026-01-01T00:00:00.000000Z","modified_at":"2026-01-01T00:00:00.000000Z","id":"\u003cstring>","source":"catalog","amount_type":"fixed","price_currency":"\u003cstring>","tax_behavior":"location","is_archived":true,"product_id":"\u003cstring>","type":"recurring","recurring_interval":"day","price_amount":123,"legacy":true}],"benefits":[{"id":"\u003cstring>","created_at":"2026-01-01T00:00:00.000000Z","modified_at":"2026-01-01T00:00:00.000000Z","type":"custom","description":"\u003cstring>","selectable":true,"deletable":true,"is_deleted":true,"organization_id":"\u003cstring>","metadata":{},"visibility":"draft","properties":{"note":"\u003cstring>"},"visibility_configurable":true}],"medias":[{"id":"\u003cstring>","organization_id":"\u003cstring>","name":"\u003cstring>","path":"\u003cstring>","mime_type":"\u003cstring>","size":123,"storage_version":"\u003cstring>","checksum_etag":"\u003cstring>","checksum_sha256_base64":"\u003cstring>","checksum_sha256_hex":"\u003cstring>","last_modified_at":"2026-01-01T00:00:00.000000Z","version":"\u003cstring>","service":"product_media","is_uploaded":true,"created_at":"2026-01-01T00:00:00.000000Z","size_readable":"\u003cstring>","public_url":"\u003cstring>"}],"attached_custom_fields":[{"custom_field_id":"\u003cstring>","custom_field":{"created_at":"2026-01-01T00:00:00.000000Z","modified_at":"2026-01-01T00:00:00.000000Z","id":"\u003cstring>","metadata":{},"type":"text","slug":"\u003cstring>","name":"\u003cstring>","organization_id":"1dbfc517-0bbf-4301-9ba8-555ca42b9737","properties":{"form_label":"\u003cstring>","form_help_text":"\u003cstring>","form_placeholder":"\u003cstring>","textarea":true,"min_length":1073741823,"max_length":1073741823}},"order":123,"required":true}]}],"pagination":{"total_count":123,"max_page":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"eec163a2-dfa8-4f7c-92c2-f31df7a2a0d4":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f04cc3d0-b3cb-404e-9531-3282a85e40fa":{"oidc":{"type":"openIdConnect","openIdConnectUrl":"/.well-known/openid-configuration","scopes":["products:read","products:write"],"schemeName":"oidc"}},"daecde23-21f3-4086-97e7-a227a96b6958":{"pat":{"type":"http","description":"You can generate a **Personal Access Token** from your [settings](https://polar.sh/settings).","scheme":"bearer","scopes":["products:read","products:write"],"schemeName":"pat"}},"04a5a20b-b496-4f83-92ec-61974a3604ca":{"oat":{"type":"http","description":"You can generate an **Organization Access Token** from your organization's settings.","scheme":"bearer","scopes":["products:read","products:write"],"schemeName":"oat"}}},"servers":{"0a3cfd4b-9634-4505-9004-41aa566b6b35":{"url":"https://api.polar.sh","description":"Production environment","x-speakeasy-server-id":"production","x-polar-environment":"production"},"81edcbdc-9117-4d62-9bcc-a4eb8c29ac19":{"url":"https://sandbox-api.polar.sh","description":"Sandbox environment","x-speakeasy-server-id":"sandbox","x-polar-environment":"sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"You can generate a **Personal Access Token** from your [settings](https://polar.sh/settings).","scheme":"bearer","scopes":["products:read","products:write"],"schemeName":"pat"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"You can generate a **Personal Access Token** from your [settings](https://polar.sh/settings).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"pat","name":"Authorization"}],"title":"pat"},{"schemes":[{"scheme":{"type":"http","description":"You can generate an **Organization Access Token** from your organization's settings.","scheme":"bearer","scopes":["products:read","products:write"],"schemeName":"oat"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"You can generate an **Organization Access Token** from your organization's settings.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oat","name":"Authorization"}],"title":"oat"}]},"originalFileLocation":"openapi/2026-10.openapi.json"},"subdomain":"polar","siteName":"Polar","title":"List Products - Polar","navMaps":{"firstHrefInVersion":{"2026-04":{"href":"/api-reference/2026-04/products/list-products","matchLevel":1},"2026-10":{"href":"/api-reference/2026-10/products/list-products","matchLevel":0},"2027-01":{"href":"/api-reference/2027-01/products/list-products","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-10-19T15:30:38.935Z","originalFileLocation":"api-reference/2026-10/products/list-products.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"List products. Scopes: products:read products:write\">\u003cmeta data-mint-head name=\"application-name\" content=\"Polar\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Products - Polar\">\u003cmeta data-mint-head property=\"og:description\" content=\"List products. Scopes: products:read products:write\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Polar\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://polar.sh/docs/api-reference/2026-10/products/list-products\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://polar.sh/assets/brand/polar_og.jpg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List Products - Polar\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List products. Scopes: products:read products:write\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://polar.sh/assets/brand/polar_og.jpg\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Polar\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://polar.sh/docs/api-reference/2026-10/products/list-products\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/2026-10/products/list-products.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://polar.sh/#organization\",\"name\":\"Polar\",\"url\":\"https://polar.sh\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/polar/4USyJwN59kbPHT7o/logo/light.png?fit=max\u0026auto=format\u0026n=4USyJwN59kbPHT7o\u0026q=85\u0026s=e950d8c7839bea573a30b2b2f26b279e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://polar.sh/docs#website\",\"name\":\"Polar\",\"url\":\"https://polar.sh/docs\",\"publisher\":{\"@id\":\"https://polar.sh/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://polar.sh/docs/api-reference/2026-10/products/list-products#webpage\",\"url\":\"https://polar.sh/docs/api-reference/2026-10/products/list-products\",\"name\":\"List Products\",\"description\":\"List products. Scopes: products:read products:write\",\"dateModified\":\"2026-10-19T15:30:38.935Z\",\"isPartOf\":{\"@id\":\"https://polar.sh/docs#website\"},\"breadcrumb\":{\"@id\":\"https://polar.sh/docs/api-reference/2026-10/products/list-products#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://polar.sh/docs/api-reference/2026-10/products/list-products#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core API\",\"item\":\"https://polar.sh/docs/api-reference/2026-10/checkouts/create-checkout-session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Products\",\"item\":\"https://polar.sh/docs/api-reference/2026-10/products/get-product\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List Products\",\"item\":\"https://polar.sh/docs/api-reference/2026-10/products/list-products\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://polar.sh/docs/api-reference/2026-10/products/list-products#apireference\",\"headline\":\"List Products\",\"name\":\"List Products\",\"description\":\"List products. Scopes: products:read products:write\",\"url\":\"https://polar.sh/docs/api-reference/2026-10/products/list-products\",\"mainEntityOfPage\":{\"@id\":\"https://polar.sh/docs/api-reference/2026-10/products/list-products#webpage\"},\"image\":\"https://polar.sh/assets/brand/polar_og.jpg\",\"dateModified\":\"2026-10-19T15:30:38.935Z\",\"publisher\":{\"@id\":\"https://polar.sh/#organization\"},\"isPartOf\":{\"@id\":\"https://polar.sh/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Polar\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Polar","nav":{"global":null,"tabs":[{"tab":"Docs","icon":"compass","pages":[{"title":"Docs","href":"/introduction"}]},{"tab":"API Reference","icon":"rectangle-terminal","versions":[{"version":"2026-04","tag":"Deprecated","pages":[{"title":"2026-04","href":"/api-reference/2026-04/products/list-products"}]},{"version":"2026-10","default":true,"tag":"Current","groups":[{"group":"General","pages":[{"title":"API Overview","sidebarTitle":"Introduction","href":"/api-reference/2026-10/introduction"},{"title":"API Versioning","sidebarTitle":"Versioning","href":"/api-reference/2026-10/versioning"}]},{"group":"Core API","pages":[{"group":"Checkout","pages":[{"title":"Create Checkout Session","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/checkouts/","href":"/api-reference/2026-10/checkouts/create-checkout-session"},{"title":"Get Checkout Session","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/checkouts/{id}","href":"/api-reference/2026-10/checkouts/get-checkout-session"},{"title":"List Checkout Sessions","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/checkouts/","href":"/api-reference/2026-10/checkouts/list-checkout-sessions"},{"title":"Update Checkout Session","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/checkouts/{id}","href":"/api-reference/2026-10/checkouts/update-checkout-session"},{"title":"Get Checkout Session from Client","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/checkouts/client/{client_secret}","href":"/api-reference/2026-10/checkouts/get-checkout-session-from-client"},{"title":"Update Checkout Session from Client","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/checkouts/client/{client_secret}","href":"/api-reference/2026-10/checkouts/update-checkout-session-from-client"},{"title":"Confirm Checkout Session from Client","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/checkouts/client/{client_secret}/confirm","href":"/api-reference/2026-10/checkouts/confirm-checkout-session-from-client"}]},{"group":"Checkout Links","pages":[{"title":"Create Checkout Link","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/checkout-links/","href":"/api-reference/2026-10/checkout-links/create-checkout-link"},{"title":"Get Checkout Link","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/checkout-links/{id}","href":"/api-reference/2026-10/checkout-links/get-checkout-link"},{"title":"List Checkout Links","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/checkout-links/","href":"/api-reference/2026-10/checkout-links/list-checkout-links"},{"title":"Update Checkout Link","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/checkout-links/{id}","href":"/api-reference/2026-10/checkout-links/update-checkout-link"},{"title":"Delete Checkout Link","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/checkout-links/{id}","href":"/api-reference/2026-10/checkout-links/delete-checkout-link"}]},{"group":"Custom Checkout Fields","pages":[{"title":"Create Custom Field","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/custom-fields/","href":"/api-reference/2026-10/custom-fields/create-custom-field"},{"title":"Get Custom Field","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/custom-fields/{id}","href":"/api-reference/2026-10/custom-fields/get-custom-field"},{"title":"List Custom Fields","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/custom-fields/","href":"/api-reference/2026-10/custom-fields/list-custom-fields"},{"title":"Update Custom Field","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/custom-fields/{id}","href":"/api-reference/2026-10/custom-fields/update-custom-field"},{"title":"Delete Custom Field","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/custom-fields/{id}","href":"/api-reference/2026-10/custom-fields/delete-custom-field"}]},{"group":"Customers","pages":[{"title":"Get Customer State","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/{id}/state","href":"/api-reference/2026-10/customers/get-customer-state"},{"title":"Get Customer State by External ID","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/external/{external_id}/state","href":"/api-reference/2026-10/customers/get-customer-state-by-external-id"},{"title":"List Customers","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/","href":"/api-reference/2026-10/customers/list-customers"},{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customers/","href":"/api-reference/2026-10/customers/create-customer"},{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/{id}","href":"/api-reference/2026-10/customers/get-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/customers/{id}","href":"/api-reference/2026-10/customers/update-customer"},{"title":"Delete Customer","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/customers/{id}","href":"/api-reference/2026-10/customers/delete-customer"},{"title":"Get Customer by External ID","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/external/{external_id}","href":"/api-reference/2026-10/customers/get-customer-by-external-id"},{"title":"Update Customer by External ID","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/customers/external/{external_id}","href":"/api-reference/2026-10/customers/update-customer-by-external-id"},{"title":"Delete Customer by External ID","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/customers/external/{external_id}","href":"/api-reference/2026-10/customers/delete-customer-by-external-id"},{"title":"List Customer Payment Methods","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/{id}/payment-methods","href":"/api-reference/2026-10/customers/list-customer-payment-methods"},{"title":"List Customer Payment Methods by External ID","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/external/{external_id}/payment-methods","href":"/api-reference/2026-10/customers/list-customer-payment-methods-by-external-id"}]},{"group":"Subscriptions","pages":[{"title":"Get Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/subscriptions/{id}","href":"/api-reference/2026-10/subscriptions/get-subscription"},{"title":"List Subscriptions","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/subscriptions/","href":"/api-reference/2026-10/subscriptions/list-subscriptions"},{"title":"Create Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/subscriptions/","href":"/api-reference/2026-10/subscriptions/create-subscription"},{"title":"Update Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/subscriptions/{id}","href":"/api-reference/2026-10/subscriptions/update-subscription"},{"title":"Revoke Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/subscriptions/{id}","href":"/api-reference/2026-10/subscriptions/revoke-subscription"}]},{"group":"Orders","pages":[{"title":"Get Order","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/orders/{id}","href":"/api-reference/2026-10/orders/get-order"},{"title":"Update Order","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/orders/{id}","href":"/api-reference/2026-10/orders/update-order"},{"title":"List Orders","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/orders/","href":"/api-reference/2026-10/orders/list-orders"},{"title":"Generate Order Invoice","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/orders/{id}/invoice","href":"/api-reference/2026-10/orders/generate-order-invoice"},{"title":"Get Order Invoice","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/orders/{id}/invoice","href":"/api-reference/2026-10/orders/get-order-invoice"},{"title":"Get Order Receipt","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/orders/{id}/receipt","href":"/api-reference/2026-10/orders/get-order-receipt"}]},{"group":"Discounts","pages":[{"title":"Get Discount","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/discounts/{id}","href":"/api-reference/2026-10/discounts/get-discount"},{"title":"List Discounts","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/discounts/","href":"/api-reference/2026-10/discounts/list-discounts"},{"title":"Create Discount","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/discounts/","href":"/api-reference/2026-10/discounts/create-discount"},{"title":"Update Discount","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/discounts/{id}","href":"/api-reference/2026-10/discounts/update-discount"},{"title":"Delete Discount","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/discounts/{id}","href":"/api-reference/2026-10/discounts/delete-discount"}]},{"group":"Refunds","pages":[{"title":"Create Refund","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/refunds/","href":"/api-reference/2026-10/refunds/create-refund"},{"title":"List Refunds","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/refunds/","href":"/api-reference/2026-10/refunds/list-refunds"}]},{"group":"Products","pages":[{"title":"Get Product","description":"Get a product by ID.\n\n**Scopes**: `products:read` `products:write`","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/products/{id}","href":"/api-reference/2026-10/products/get-product"},{"title":"List Products","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/products/","href":"/api-reference/2026-10/products/list-products"},{"title":"Create Product","description":"Create a product.\n\n**Scopes**: `products:write`","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/products/","href":"/api-reference/2026-10/products/create-product"},{"title":"Update Product","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/products/{id}","href":"/api-reference/2026-10/products/update-product"},{"title":"Delete Product","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/products/{id}","href":"/api-reference/2026-10/products/delete-product"},{"title":"Update Product Benefits","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/products/{id}/benefits","href":"/api-reference/2026-10/products/update-product-benefits"}]},{"group":"Events","pages":[{"title":"Ingest Events","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/events/ingest","href":"/api-reference/2026-10/events/ingest-events"},{"title":"Get Event","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/events/{id}","href":"/api-reference/2026-10/events/get-event"},{"title":"List Events","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/events/","href":"/api-reference/2026-10/events/list-events"}]},{"group":"Meters","pages":[{"title":"Create Meter","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/meters/","href":"/api-reference/2026-10/meters/create-meter"},{"title":"Get Meter","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/meters/{id}","href":"/api-reference/2026-10/meters/get-meter"},{"title":"List Meters","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/meters/","href":"/api-reference/2026-10/meters/list-meters"},{"title":"Update Meter","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/meters/{id}","href":"/api-reference/2026-10/meters/update-meter"},{"title":"Get Meter Quantities","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/meters/{id}/quantities","href":"/api-reference/2026-10/meters/get-meter-quantities"}]},{"group":"Benefits","pages":[{"title":"Create Benefit","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/benefits/","href":"/api-reference/2026-10/benefits/create-benefit"},{"title":"Get Benefit","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/benefits/{id}","href":"/api-reference/2026-10/benefits/get-benefit"},{"title":"List Benefits","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/benefits/","href":"/api-reference/2026-10/benefits/list-benefits"},{"title":"List Benefit Grants","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/benefits/{id}/grants","href":"/api-reference/2026-10/benefits/list-benefit-grants"},{"title":"Update Benefit","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/benefits/{id}","href":"/api-reference/2026-10/benefits/update-benefit"},{"title":"Delete Benefit","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/benefits/{id}","href":"/api-reference/2026-10/benefits/delete-benefit"}]},{"group":"Customer Meters","pages":[{"title":"Get Customer Meter","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-meters/{id}","href":"/api-reference/2026-10/customer_meters/get-customer-meter"},{"title":"List Customer Meters","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-meters/","href":"/api-reference/2026-10/customer_meters/list-customer-meters"}]},{"group":"License Keys","pages":[{"title":"Get License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/license-keys/{id}","href":"/api-reference/2026-10/license_keys/get-license-key"},{"title":"List License Keys","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/license-keys/","href":"/api-reference/2026-10/license_keys/list-license-keys"},{"title":"Update License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/license-keys/{id}","href":"/api-reference/2026-10/license_keys/update-license-key"},{"title":"Get Activation","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/license-keys/{id}/activations/{activation_id}","href":"/api-reference/2026-10/license_keys/get-activation"},{"title":"Validate License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/license-keys/validate","href":"/api-reference/2026-10/license_keys/validate-license-key"},{"title":"Activate License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/license-keys/activate","href":"/api-reference/2026-10/license_keys/activate-license-key"},{"title":"Deactivate License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/license-keys/deactivate","href":"/api-reference/2026-10/license_keys/deactivate-license-key"}]},{"group":"Members","pages":[{"title":"List Members","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/{id}/members","href":"/api-reference/2026-10/customers/list-members"},{"title":"List Members by Customer External ID","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/external/{external_id}/members","href":"/api-reference/2026-10/customers/list-members-by-customer-external-id"}]},{"group":"Customer Seats","pages":[{"title":"Assign Seat","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-seats","href":"/api-reference/2026-10/customer-seats/assign-seat"},{"title":"List Seats","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-seats","href":"/api-reference/2026-10/customer-seats/list-seats"},{"title":"Revoke Seat","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/customer-seats/{seat_id}","href":"/api-reference/2026-10/customer-seats/revoke-seat"},{"title":"Resend Invitation","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-seats/{seat_id}/resend","href":"/api-reference/2026-10/customer-seats/resend-invitation"},{"title":"Get Claim Info","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-seats/claim/{invitation_token}","href":"/api-reference/2026-10/customer-seats/get-claim-info"},{"title":"Claim Seat","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-seats/claim","href":"/api-reference/2026-10/customer-seats/claim-seat"}]},{"group":"Files","pages":[{"title":"Create File","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/files/","href":"/api-reference/2026-10/files/create-file"},{"title":"List Files","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/files/","href":"/api-reference/2026-10/files/list-files"},{"title":"Update File","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/files/{id}","href":"/api-reference/2026-10/files/update-file"},{"title":"Delete File","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/files/{id}","href":"/api-reference/2026-10/files/delete-file"},{"title":"Complete File Upload","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/files/{id}/uploaded","href":"/api-reference/2026-10/files/complete-file-upload"}]},{"group":"Organizations","pages":[{"title":"Get Organization","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/organizations/{id}","href":"/api-reference/2026-10/organizations/get-organization"},{"title":"List Organizations","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/organizations/","href":"/api-reference/2026-10/organizations/list-organizations"},{"title":"Create Organization","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/organizations/","href":"/api-reference/2026-10/organizations/create-organization"},{"title":"Update Organization","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/organizations/{id}","href":"/api-reference/2026-10/organizations/update-organization"}]},{"group":"Metrics","pages":[{"title":"Get Metrics","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/metrics/","href":"/api-reference/2026-10/metrics/get-metrics"},{"title":"Get Metrics Limits","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/metrics/limits","href":"/api-reference/2026-10/metrics/get-metrics-limits"}]}]},{"group":"Customer Portal API","pages":[{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/customers/me","href":"/api-reference/2026-10/customer_portal/get-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/customer-portal/customers/me","href":"/api-reference/2026-10/customer_portal/update-customer"},{"title":"Get Organization","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/organizations/{slug}","href":"/api-reference/2026-10/customer_portal/get-organization"},{"group":"Sessions","pages":[{"title":"Create Customer Session","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-sessions/","href":"/api-reference/2026-10/customer-sessions/create-customer-session"}]},{"group":"Subscriptions","pages":[{"title":"Get Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/subscriptions/{id}","href":"/api-reference/2026-10/customer_portal/get-subscription"},{"title":"List Subscriptions","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/subscriptions/","href":"/api-reference/2026-10/customer_portal/list-subscriptions"},{"title":"Update Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/customer-portal/subscriptions/{id}","href":"/api-reference/2026-10/customer_portal/update-subscription"},{"title":"Cancel Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/customer-portal/subscriptions/{id}","href":"/api-reference/2026-10/customer_portal/cancel-subscription"}]},{"group":"Orders","pages":[{"title":"Get Order","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/orders/{id}","href":"/api-reference/2026-10/customer_portal/get-order"},{"title":"Update Order","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/customer-portal/orders/{id}","href":"/api-reference/2026-10/customer_portal/update-order"},{"title":"List Orders","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/orders/","href":"/api-reference/2026-10/customer_portal/list-orders"},{"title":"Generate Order Invoice","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-portal/orders/{id}/invoice","href":"/api-reference/2026-10/customer_portal/generate-order-invoice"},{"title":"Get Order Invoice","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/orders/{id}/invoice","href":"/api-reference/2026-10/customer_portal/get-order-invoice"},{"title":"Get Order Receipt","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/orders/{id}/receipt","href":"/api-reference/2026-10/customer_portal/get-order-receipt"}]},{"group":"License Keys","pages":[{"title":"Validate License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-portal/license-keys/validate","href":"/api-reference/2026-10/customer_portal/validate-license-key"},{"title":"Activate License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-portal/license-keys/activate","href":"/api-reference/2026-10/customer_portal/activate-license-key"},{"title":"Deactivate License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-portal/license-keys/deactivate","href":"/api-reference/2026-10/customer_portal/deactivate-license-key"},{"title":"Get License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/license-keys/{id}","href":"/api-reference/2026-10/customer_portal/get-license-key"},{"title":"List License Keys","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/license-keys/","href":"/api-reference/2026-10/customer_portal/list-license-keys"}]},{"group":"File Downloads","pages":[{"title":"List Downloadables","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/downloadables/","href":"/api-reference/2026-10/customer_portal/list-downloadables"}]},{"group":"Seats","pages":[{"title":"List Seats","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/seats","href":"/api-reference/2026-10/customer_portal/list-seats"},{"title":"Assign Seat","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-portal/seats","href":"/api-reference/2026-10/customer_portal/assign-seat"},{"title":"Revoke Seat","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/customer-portal/seats/{seat_id}","href":"/api-reference/2026-10/customer_portal/revoke-seat"},{"title":"Resend Invitation","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-portal/seats/{seat_id}/resend","href":"/api-reference/2026-10/customer_portal/resend-invitation"},{"title":"List Claimed Subscriptions","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/seats/subscriptions","href":"/api-reference/2026-10/customer_portal/list-claimed-subscriptions"}]},{"group":"Payment Methods","pages":[{"title":"List Customer Payment Methods","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/customers/me/payment-methods","href":"/api-reference/2026-10/customer_portal/list-customer-payment-methods"},{"title":"Delete Customer Payment Method","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/customer-portal/customers/me/payment-methods/{id}","href":"/api-reference/2026-10/customer_portal/delete-customer-payment-method"}]}]},{"group":"Webhook Events","pages":[{"group":"Customer Events","pages":[{"title":"customer.state_changed","version":null,"deprecated":null,"sidebarTitle":"customer.state_changed","openapi":"/openapi/2026-10.openapi.json webhook customer.state_changed","href":"/api-reference/2026-10/customer_state_changed"},{"title":"customer.created","version":null,"deprecated":null,"sidebarTitle":"customer.created","openapi":"/openapi/2026-10.openapi.json webhook customer.created","href":"/api-reference/2026-10/customer_created"},{"title":"customer.updated","version":null,"deprecated":null,"sidebarTitle":"customer.updated","openapi":"/openapi/2026-10.openapi.json webhook customer.updated","href":"/api-reference/2026-10/customer_updated"},{"title":"customer.deleted","version":null,"deprecated":null,"sidebarTitle":"customer.deleted","openapi":"/openapi/2026-10.openapi.json webhook customer.deleted","href":"/api-reference/2026-10/customer_deleted"}]},{"group":"Billing Events","pages":[{"group":"Checkout","pages":[{"title":"checkout.created","version":null,"deprecated":null,"sidebarTitle":"checkout.created","openapi":"/openapi/2026-10.openapi.json webhook checkout.created","href":"/api-reference/2026-10/checkout_created"},{"title":"checkout.updated","version":null,"deprecated":null,"sidebarTitle":"checkout.updated","openapi":"/openapi/2026-10.openapi.json webhook checkout.updated","href":"/api-reference/2026-10/checkout_updated"},{"title":"checkout.expired","version":null,"deprecated":null,"sidebarTitle":"checkout.expired","openapi":"/openapi/2026-10.openapi.json webhook checkout.expired","href":"/api-reference/2026-10/checkout_expired"}]},{"group":"Subscriptions","pages":[{"title":"subscription.created","version":null,"deprecated":null,"sidebarTitle":"subscription.created","openapi":"/openapi/2026-10.openapi.json webhook subscription.created","href":"/api-reference/2026-10/subscription_created"},{"title":"subscription.active","version":null,"deprecated":null,"sidebarTitle":"subscription.active","openapi":"/openapi/2026-10.openapi.json webhook subscription.active","href":"/api-reference/2026-10/subscription_active"},{"title":"subscription.updated","version":null,"deprecated":null,"sidebarTitle":"subscription.updated","openapi":"/openapi/2026-10.openapi.json webhook subscription.updated","href":"/api-reference/2026-10/subscription_updated"},{"title":"subscription.canceled","version":null,"deprecated":null,"sidebarTitle":"subscription.canceled","openapi":"/openapi/2026-10.openapi.json webhook subscription.canceled","href":"/api-reference/2026-10/subscription_canceled"},{"title":"subscription.uncanceled","version":null,"deprecated":null,"sidebarTitle":"subscription.uncanceled","openapi":"/openapi/2026-10.openapi.json webhook subscription.uncanceled","href":"/api-reference/2026-10/subscription_uncanceled"},{"title":"subscription.cycled","version":null,"deprecated":null,"sidebarTitle":"subscription.cycled","openapi":"/openapi/2026-10.openapi.json webhook subscription.cycled","href":"/api-reference/2026-10/subscription_cycled"},{"title":"subscription.revoked","version":null,"deprecated":null,"sidebarTitle":"subscription.revoked","openapi":"/openapi/2026-10.openapi.json webhook subscription.revoked","href":"/api-reference/2026-10/subscription_revoked"},{"title":"subscription.past_due","version":null,"deprecated":null,"sidebarTitle":"subscription.past_due","openapi":"/openapi/2026-10.openapi.json webhook subscription.past_due","href":"/api-reference/2026-10/subscription_past_due"},{"title":"subscription.paused","version":null,"deprecated":null,"sidebarTitle":"subscription.paused","openapi":"/openapi/2026-10.openapi.json webhook subscription.paused","href":"/api-reference/2026-10/subscription_paused"},{"title":"subscription.resumed","version":null,"deprecated":null,"sidebarTitle":"subscription.resumed","openapi":"/openapi/2026-10.openapi.json webhook subscription.resumed","href":"/api-reference/2026-10/subscription_resumed"},{"title":"subscription.migrated","version":null,"deprecated":null,"sidebarTitle":"subscription.migrated","openapi":"/openapi/2026-10.openapi.json webhook subscription.migrated","href":"/api-reference/2026-10/subscription_migrated"}]},{"group":"Orders","pages":[{"title":"order.created","version":null,"deprecated":null,"sidebarTitle":"order.created","openapi":"/openapi/2026-10.openapi.json webhook order.created","href":"/api-reference/2026-10/order_created"},{"title":"order.paid","version":null,"deprecated":null,"sidebarTitle":"order.paid","openapi":"/openapi/2026-10.openapi.json webhook order.paid","href":"/api-reference/2026-10/order_paid"},{"title":"order.updated","version":null,"deprecated":null,"sidebarTitle":"order.updated","openapi":"/openapi/2026-10.openapi.json webhook order.updated","href":"/api-reference/2026-10/order_updated"},{"title":"order.refunded","version":null,"deprecated":null,"sidebarTitle":"order.refunded","openapi":"/openapi/2026-10.openapi.json webhook order.refunded","href":"/api-reference/2026-10/order_refunded"}]},{"group":"Customer Seats","pages":[{"title":"customer_seat.assigned","version":null,"deprecated":null,"sidebarTitle":"customer_seat.assigned","openapi":"/openapi/2026-10.openapi.json webhook customer_seat.assigned","href":"/api-reference/2026-10/customer_seat_assigned"},{"title":"customer_seat.claimed","version":null,"deprecated":null,"sidebarTitle":"customer_seat.claimed","openapi":"/openapi/2026-10.openapi.json webhook customer_seat.claimed","href":"/api-reference/2026-10/customer_seat_claimed"},{"title":"customer_seat.revoked","version":null,"deprecated":null,"sidebarTitle":"customer_seat.revoked","openapi":"/openapi/2026-10.openapi.json webhook customer_seat.revoked","href":"/api-reference/2026-10/customer_seat_revoked"}]},{"group":"Refunds","pages":[{"title":"refund.created","version":null,"deprecated":null,"sidebarTitle":"refund.created","openapi":"/openapi/2026-10.openapi.json webhook refund.created","href":"/api-reference/2026-10/refund_created"},{"title":"refund.updated","version":null,"deprecated":null,"sidebarTitle":"refund.updated","openapi":"/openapi/2026-10.openapi.json webhook refund.updated","href":"/api-reference/2026-10/refund_updated"}]},{"group":"Benefit Grants","pages":[{"title":"benefit_grant.created","version":null,"deprecated":null,"sidebarTitle":"benefit_grant.created","openapi":"/openapi/2026-10.openapi.json webhook benefit_grant.created","href":"/api-reference/2026-10/benefit_grant_created"},{"title":"benefit_grant.cycled","version":null,"deprecated":null,"sidebarTitle":"benefit_grant.cycled","openapi":"/openapi/2026-10.openapi.json webhook benefit_grant.cycled","href":"/api-reference/2026-10/benefit_grant_cycled"},{"title":"benefit_grant.updated","version":null,"deprecated":null,"sidebarTitle":"benefit_grant.updated","openapi":"/openapi/2026-10.openapi.json webhook benefit_grant.updated","href":"/api-reference/2026-10/benefit_grant_updated"},{"title":"benefit_grant.revoked","version":null,"deprecated":null,"sidebarTitle":"benefit_grant.revoked","openapi":"/openapi/2026-10.openapi.json webhook benefit_grant.revoked","href":"/api-reference/2026-10/benefit_grant_revoked"}]}]},{"group":"Organization Events","pages":[{"group":"Benefits","pages":[{"title":"benefit.created","version":null,"deprecated":null,"sidebarTitle":"benefit.created","openapi":"/openapi/2026-10.openapi.json webhook benefit.created","href":"/api-reference/2026-10/benefit_created"},{"title":"benefit.updated","version":null,"deprecated":null,"sidebarTitle":"benefit.updated","openapi":"/openapi/2026-10.openapi.json webhook benefit.updated","href":"/api-reference/2026-10/benefit_updated"}]},{"group":"Products","pages":[{"title":"product.created","version":null,"deprecated":null,"sidebarTitle":"product.created","openapi":"/openapi/2026-10.openapi.json webhook product.created","href":"/api-reference/2026-10/product_created"},{"title":"product.updated","version":null,"deprecated":null,"sidebarTitle":"product.updated","openapi":"/openapi/2026-10.openapi.json webhook product.updated","href":"/api-reference/2026-10/product_updated"}]},{"group":"Discounts","pages":[{"title":"discount.created","version":null,"deprecated":null,"sidebarTitle":"discount.created","openapi":"/openapi/2026-10.openapi.json webhook discount.created","href":"/api-reference/2026-10/discount_created"},{"title":"discount.updated","version":null,"deprecated":null,"sidebarTitle":"discount.updated","openapi":"/openapi/2026-10.openapi.json webhook discount.updated","href":"/api-reference/2026-10/discount_updated"},{"title":"discount.deleted","version":null,"deprecated":null,"sidebarTitle":"discount.deleted","openapi":"/openapi/2026-10.openapi.json webhook discount.deleted","href":"/api-reference/2026-10/discount_deleted"}]},{"group":"Organization","pages":[{"title":"organization.updated","version":null,"deprecated":null,"sidebarTitle":"organization.updated","openapi":"/openapi/2026-10.openapi.json webhook organization.updated","href":"/api-reference/2026-10/organization_updated"}]}]}]},{"group":"Integrations","pages":[{"group":"OpenID Connect","pages":[{"title":"Authorize","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/oauth2/authorize","href":"/api-reference/2026-10/oauth2/authorize"},{"title":"Request Token","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/oauth2/token","href":"/api-reference/2026-10/oauth2/request-token"},{"title":"Introspect Token","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/oauth2/introspect","href":"/api-reference/2026-10/oauth2/introspect-token"},{"title":"Revoke Token","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/oauth2/revoke","href":"/api-reference/2026-10/oauth2/revoke-token"},{"title":"Get User Info","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/oauth2/userinfo","href":"/api-reference/2026-10/oauth2/get-user-info"}]},{"group":"Webhooks","pages":[{"title":"Create Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/webhooks/endpoints","href":"/api-reference/2026-10/webhooks/create-webhook-endpoint"},{"title":"Get Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/webhooks/endpoints/{id}","href":"/api-reference/2026-10/webhooks/get-webhook-endpoint"},{"title":"List Webhook Endpoints","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/webhooks/endpoints","href":"/api-reference/2026-10/webhooks/list-webhook-endpoints"},{"title":"Update Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/webhooks/endpoints/{id}","href":"/api-reference/2026-10/webhooks/update-webhook-endpoint"},{"title":"Delete Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/webhooks/endpoints/{id}","href":"/api-reference/2026-10/webhooks/delete-webhook-endpoint"}]}]}]},{"version":"2027-01","tag":"Next","pages":[{"title":"2027-01","href":"/api-reference/2027-01/products/list-products"}]}]},{"tab":"Changelog","icon":"signal-stream","pages":[{"title":"Changelog","href":"/changelog/recent"}]},{"tab":"Support","icon":"square-question","pages":[{"title":"Support","href":"/support"}]}]},"title":"List Products - Polar","buildId":"dpl_BtCp1ySSRiZuC61kdwjLNfcZF9iT","deploymentId":"dpl_BtCp1ySSRiZuC61kdwjLNfcZF9iT","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-BwGMKaJA.js","utils-DlantaNs.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-bU1lWMyL.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-atrzX1N-.js","snippetPresets-Dm5t-KF3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-DHr1JptQ.js","ApiExamples-Cz42QzGy.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CLWnFKQE.js","shallow-DjOyfhxF.js","getApiPlaygroundDisplay-J2CVUWQR.js","CodeSnippet-emM-BzLU.js","CodeSnippets-DbUDosch.js","getPastedJson-D8Zg6YHf.js","icon-BDdk7KSm.js","MethodPill-C61Dtple.js","DuplicateIcon-42opbpVe.js","createIcon-BciRFb7M.js","DynamicMarkdown-CSxQrJZZ.js","SectionHeading-EqAWqlH3.js","axios-vUo_bRtp.js","Markdown-C6VtGA2B.js","clsx-CQdVN3oC.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DusJ_COf.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-D7F55uem.js"]}