Creates a new price. Supply product to attach the price to an existing product, or product_data to create a new product inline in the same request. A price is one-time unless you include recurring, in which case it bills on the given interval. Amounts are in the smallest currency unit (cents) and charged in USD. If HSA/FSA eligibility is not set on the price, the parent product’s eligibility applies.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Flex Documentation","colors":{"primary":"#0070FA","light":"#BAB3FF","dark":"#0B0077"},"logo":{"light":"https://mintcdn.com/flex-87/1kILreF5HcjIKLdi/logo/light.svg?fit=max\u0026auto=format\u0026n=1kILreF5HcjIKLdi\u0026q=85\u0026s=f703a75bc80df014f4849a7225b4879f","dark":"https://mintcdn.com/flex-87/1kILreF5HcjIKLdi/logo/dark.svg?fit=max\u0026auto=format\u0026n=1kILreF5HcjIKLdi\u0026q=85\u0026s=1aabf14d790c002d1740276fdbced9ab"},"favicon":"https://mintcdn.com/flex-87/liG_HQMgKKwndFp8/favicon.svg?fit=max\u0026auto=format\u0026n=liG_HQMgKKwndFp8\u0026q=85\u0026s=82a2993b4fffbf19268067f48e898bed","navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.withflex.com/"}},"footer":{"socials":{"github":"https://github.com/JoinFlexHealth","linkedin":"https://www.linkedin.com/company/withflex","x":"https://x.com/paywithflex","instagram":"https://www.instagram.com/paywithflex"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":true},"navigation":{"global":{"anchors":[{"anchor":"Status","icon":"wifi","href":"https://statuspage.incident.io/with-flex"},{"anchor":"Support","icon":"mail","href":"mailto:support@withflex.com"},{"anchor":"Website","icon":"laptop","href":"https://www.withflex.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flex-87","hasAudioNarration":false,"actualSubdomain":"flex-87","customDomains":["docs.withflex.com"],"gitSource":{"type":"github","owner":"joinflexhealth","repo":"flex","deployBranch":"main","contentDirectory":"flex-docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b00b27dff5a36cdac82cbbe","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":188},{"language":"default","tag":"Guides","count":52},{"language":"default","tag":"Integration","count":30},{"language":"default","tag":"Marketing","count":21},{"language":"default","tag":"Checkout Sessions","count":13},{"language":"default","tag":"Subscriptions","count":12},{"language":"default","tag":"Products","count":9},{"language":"default","tag":"Shopify","count":8},{"language":"default","tag":"Disputes","count":8},{"language":"default","tag":"Overview","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"site-roles","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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#topbar-cta-button span.bg-primary-dark{background-color:#0B0077!important}html.dark #topbar-cta-button span.bg-primary-dark{background-color:#BAB3FF1A!important;border-color:#BAB3FF;border-width:1px}main img,article img,.content img,[data-content] img{border:1px solid #E8EAED!important}main img.rounded,article img.rounded,.content img.rounded,[data-content] img.rounded{border:.5px solid #E8EAED!important}.nav-logo,img.nav-logo{border:none!important}.brand-logo-grid img{border:none!important}.doc-screenshot img{border:none!important}img.no-border{border:none!important}.nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm{background:rgba(17, 24, 39, 0.05)!important;background-color:rgba(17, 24, 39, 0.05)!important;color:#1f2937!important;--tw-ring-opacity: 1 !important;--tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color) !important;--tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(1px + var(--tw-ring-offset-width)) var(--tw-ring-color) !important;box-shadow:var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow)!important;filter:none!important}.dark .nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm{background:rgba(229, 231, 235, 0.05)!important;background-color:rgba(229, 231, 235, 0.05)!important;color:#d1d5db!important;--tw-ring-opacity: 1 !important;--tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color) !important;--tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(1px + var(--tw-ring-offset-width)) var(--tw-ring-color) !important;box-shadow:var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow)!important;filter:none!important}.group:hover .group-hover\\:ring-0{--tw-ring-opacity: 1 !important;--tw-ring-color: rgba(17, 24, 39, 0.05) !important}.dark .group:hover .group-hover\\:ring-0{--tw-ring-opacity: 1 !important;--tw-ring-color: rgba(55, 65, 81, 0.4) !important}.nav-anchor:hover .secondary-opacity.group-hover\\:fill-primary-dark.group-hover\\:bg-white{background-color:currentColor!important;fill:none!important}.nav-anchor:hover .secondary-opacity{background-color:#1f2937!important}.dark .nav-anchor:hover .secondary-opacity{background-color:#d1d5db!important}.nav-anchor .mr-4.rounded-md.p-1.shadow-sm[style*=\"background\"]{background:inherit!important;background-color:inherit!important}.nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm[style*=\"background\"]{background:rgba(17, 24, 39, 0.05)!important;background-color:rgba(17, 24, 39, 0.05)!important}.dark .nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm[style*=\"background\"]{background:rgba(229, 231, 235, 0.05)!important;background-color:rgba(229, 231, 235, 0.05)!important}.nav-anchor:hover .h-4.w-4.secondary-opacity{background-color:currentColor!important}.inline-flex.items-center.gap-1\\.5.text-sm.text-gray-500 a{color:#0070FA!important}.inline-flex.items-center.gap-1\\.5.text-sm.text-gray-500 a:hover{color:#0B0077!important}html.dark .inline-flex.items-center.gap-1\\.5.text-sm a{color:#BAB3FF!important}html.dark .inline-flex.items-center.gap-1\\.5.text-sm a:hover{color:white!important}.lucide.lucide-chevron-right{stroke:#0070FA!important}html.dark .lucide.lucide-chevron-right{stroke:#BAB3FF!important}"}]}
{"page":{"pagePath":"api-reference/prices/create-price","slug":"/api-reference/prices/create-price","pageMetadata":{"title":"Create Price","description":"Creates a new price. Supply `product` to attach the price to an existing product, or `product_data` to create a new product inline in the same request. A price is one-time unless you include `recurring`, in which case it bills on the given interval. Amounts are in the smallest currency unit (cents) and charged in USD. If HSA/FSA eligibility is not set on the price, the parent product's eligibility applies.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/prices","href":"/api-reference/prices/create-price","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Creates a new price. Supply \", _jsx(_components.code, {\n children: \"product\"\n }), \" to attach the price to an existing product, or \", _jsx(_components.code, {\n children: \"product_data\"\n }), \" to create a new product inline in the same request. A price is one-time unless you include \", _jsx(_components.code, {\n children: \"recurring\"\n }), \", in which case it bills on the given interval. Amounts are in the smallest currency unit (cents) and charged in USD. If HSA/FSA eligibility is not set on the price, the parent product’s eligibility applies.\"]\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":"Create Price","description":"Creates a new price. Supply `product` to attach the price to an existing product, or `product_data` to create a new product inline in the same request. A price is one-time unless you include `recurring`, in which case it bills on the given interval. Amounts are in the smallest currency unit (cents) and charged in USD. If HSA/FSA eligibility is not set on the price, the parent product's eligibility applies.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/prices","href":"/api-reference/prices/create-price","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/flex-87/f0156321fafa1974/postcss.config.js"],"openApiReferenceData":{"operation":{"tags":["Prices"],"summary":"Create Price","description":"Creates a new price. Supply `product` to attach the price to an existing product, or `product_data` to create a new product inline in the same request. A price is one-time unless you include `recurring`, in which case it bills on the given interval. Amounts are in the smallest currency unit (cents) and charged in USD. If HSA/FSA eligibility is not set on the price, the parent product's eligibility applies.","operationId":"v1.prices.create","requestBody":"6f594fb6-59cb-4902-b490-4ff40c6c5081","responses":{"200":"a3651f1c-209b-481c-b507-cd12f5089240","401":"11cbeb6a-8ccf-4625-a309-95b2c4cf9e0f","403":"8a5a7047-ddd0-4fb8-b63c-8811751e13b8","404":"215594fd-f13b-401d-9387-cba9ae39fdcd","409":"d9f478ca-34be-471e-a431-64d597511c02","422":"35c47077-2dee-4b50-a49f-26f1c8c0893d","429":"5d825537-a5b2-4671-aa69-49fcbfbd4ed7"},"security":["6bca4f81-c4b3-4104-85e5-772157728ce1"],"method":"post","type":"path","servers":["1eb7f03d-8389-434a-b6e0-633ee4e07aa2"],"path":"/v1/prices","baseUrlOptions":["https://api.withflex.com"],"title":"Create Price","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"An envelope wrapping a single price object.","content":{"application/json":{"schema":{"description":"An envelope wrapping a single price object.","type":"object","required":["price"],"properties":{"price":{"description":"The price object.","type":"object","properties":{"unit_amount":{"description":"A positive integer in cents (or 0 for a free price) representing how much to charge.","type":"integer","format":"int64","minimum":0,"example":2500,"maximum":4294967295,"isRequired":true,"uniqueKey":"price.unit_amount","typeLabel":"integer\u003cint64>"},"lookup_key":{"oneOf":[{"description":"A stable, partner-owned key for this price, unique within your account and mode across all prices — archived ones included. Up to 200 characters.","type":"string","maxLength":200,"example":"standard_monthly","uniqueKey":"price.lookup_key.oneOf.0","typeLabel":"string"},{"description":"A stable, partner-owned key for this price, unique within your account and mode across all prices — archived ones included. Up to 200 characters.","type":"null","maxLength":200,"example":"standard_monthly","uniqueKey":"price.lookup_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.lookup_key","typeLabel":"string | null"},"transfer_lookup_key":{"oneOf":[{"description":"Move `lookup_key` off whichever price currently holds it — active or archived — and onto this one, in a single request. The other price stays usable; only its `lookup_key` is cleared. Without this, claiming a key another price holds is rejected.","type":"boolean","uniqueKey":"price.transfer_lookup_key.oneOf.0","typeLabel":"boolean"},{"description":"Move `lookup_key` off whichever price currently holds it — active or archived — and onto this one, in a single request. The other price stays usable; only its `lookup_key` is cleared. Without this, claiming a key another price holds is rejected.","type":"null","uniqueKey":"price.transfer_lookup_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.transfer_lookup_key","typeLabel":"boolean | null"},"description":{"oneOf":[{"description":"A brief description of the price.","type":"string","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"price.description.oneOf.0","typeLabel":"string"},{"description":"A brief description of the price.","type":"null","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"price.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.description","typeLabel":"string | null"},"recurring":{"oneOf":[{"type":"object","description":"The recurring components of a price such as interval and trial period days.","required":["interval"],"example":{"interval":"day","interval_count":0,"trial_period_days":0},"properties":{"interval":{"description":"The billing cadence for the price.","type":"string","enum":["day","week","month","year"],"example":"day","isRequired":true,"uniqueKey":"price.recurring.oneOf.0.interval","typeLabel":"enum\u003cstring>"},"interval_count":{"oneOf":[{"description":"The number of intervals","type":"integer","format":"int64","minimum":0,"maximum":4294967295,"uniqueKey":"price.recurring.oneOf.0.interval_count.oneOf.0","typeLabel":"integer\u003cint64>"},{"description":"The number of intervals","type":"null","format":"int64","minimum":0,"maximum":4294967295,"uniqueKey":"price.recurring.oneOf.0.interval_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.recurring.oneOf.0.interval_count","typeLabel":"integer\u003cint64> | null"},"trial_period_days":{"oneOf":[{"description":"The number of trial period days before the customer is charged for the first time. Whole days only. For a precise trial-end timestamp (e.g. non-integer days), use `subscription_data.trial_end` on the Create Checkout Session request instead.","type":"integer","format":"int64","minimum":0,"maximum":4294967295,"uniqueKey":"price.recurring.oneOf.0.trial_period_days.oneOf.0","typeLabel":"integer\u003cint64>"},{"description":"The number of trial period days before the customer is charged for the first time. Whole days only. For a precise trial-end timestamp (e.g. non-integer days), use `subscription_data.trial_end` on the Create Checkout Session request instead.","type":"null","format":"int64","minimum":0,"maximum":4294967295,"uniqueKey":"price.recurring.oneOf.0.trial_period_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.recurring.oneOf.0.trial_period_days","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"price.recurring.oneOf.0","typeLabel":"object"},{"type":"null","description":"The recurring components of a price such as interval and trial period days.","uniqueKey":"price.recurring.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.recurring","typeLabel":"object | null"},"metadata":{"oneOf":[{"description":"Metadata to attach to the price.","type":"object","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"price.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata to attach to the price.","type":"null","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"price.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.metadata","typeLabel":"object | null"},"product":{"description":"The ID of the product that this price will belong to.","type":"string","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"price.product","typeLabel":"string"},"product_data":{"description":"Data used to generate a new Product object inline.","type":"object","required":["name"],"properties":{"name":{"description":"The product's name, meant to be displayed to the customer.","type":"string","example":"Example","isRequired":true,"uniqueKey":"price.product_data.name","typeLabel":"string"},"description":{"oneOf":[{"description":"The product's description, a short blurb meant to be displayed to the customer.","type":"string","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"price.product_data.description.oneOf.0","typeLabel":"string"},{"description":"The product's description, a short blurb meant to be displayed to the customer.","type":"null","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"price.product_data.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product_data.description","typeLabel":"string | null"},"upc_code":{"oneOf":[{"description":"The product's UPC code. If provided, this will be used to check whether the product is on the eligible product list.","type":"string","example":"example_value","uniqueKey":"price.product_data.upc_code.oneOf.0","typeLabel":"string"},{"description":"The product's UPC code. If provided, this will be used to check whether the product is on the eligible product list.","type":"null","example":"example_value","uniqueKey":"price.product_data.upc_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product_data.upc_code","typeLabel":"string | null"},"gtin":{"oneOf":[{"description":"The product's GTIN. If provided, this will be used to check whether the product is on the eligible product list.","type":"string","example":"example_value","uniqueKey":"price.product_data.gtin.oneOf.0","typeLabel":"string"},{"description":"The product's GTIN. If provided, this will be used to check whether the product is on the eligible product list.","type":"null","example":"example_value","uniqueKey":"price.product_data.gtin.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product_data.gtin","typeLabel":"string | null"},"reference_gtin":{"oneOf":[{"description":"If the product is HSA/FSA eligible through private label, this should be provided.","type":"string","example":"example_value","uniqueKey":"price.product_data.reference_gtin.oneOf.0","typeLabel":"string"},{"description":"If the product is HSA/FSA eligible through private label, this should be provided.","type":"null","example":"example_value","uniqueKey":"price.product_data.reference_gtin.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product_data.reference_gtin","typeLabel":"string | null"},"url":{"oneOf":[{"description":"A URL of a publicly-accessible image of the product.","type":"string","example":"https://example.com","uniqueKey":"price.product_data.url.oneOf.0","typeLabel":"string"},{"description":"A URL of a publicly-accessible image of the product.","type":"null","example":"https://example.com","uniqueKey":"price.product_data.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product_data.url","typeLabel":"string | null"},"client_reference_id":{"oneOf":[{"description":"An optional identifier for the product set by the client. Immutable after creation.","type":"string","example":"example_value","uniqueKey":"price.product_data.client_reference_id.oneOf.0","typeLabel":"string"},{"description":"An optional identifier for the product set by the client. Immutable after creation.","type":"null","example":"example_value","uniqueKey":"price.product_data.client_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product_data.client_reference_id","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Set of key-value pairs that you can attach to a product. This can be useful for storing additional information about the product in a structured format.","type":"object","additionalProperties":{"type":"string","uniqueKey":"price.product_data.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"price.product_data.metadata.oneOf.0","typeLabel":"object"},{"description":"Set of key-value pairs that you can attach to a product. This can be useful for storing additional information about the product in a structured format.","type":"null","additionalProperties":{"type":"string","uniqueKey":"price.product_data.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"price.product_data.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product_data.metadata","typeLabel":"object | null"},"image_urls":{"oneOf":[{"description":"URLs of publicly-accessible product images for eligibility determination.","type":"array","items":{"type":"string","uniqueKey":"price.product_data.image_urls.oneOf.0.items.[INDEX]","typeLabel":"string"},"example":["https://example.com/image.png"],"uniqueKey":"price.product_data.image_urls.oneOf.0","typeLabel":"string[]"},{"description":"URLs of publicly-accessible product images for eligibility determination.","type":"null","items":{"type":"string"},"example":["https://example.com/image.png"],"uniqueKey":"price.product_data.image_urls.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product_data.image_urls","typeLabel":"string[] | null"},"categories":{"oneOf":[{"description":"Product categories (e.g., \"Vitamins\", \"First Aid\").","type":"array","items":{"type":"string","uniqueKey":"price.product_data.categories.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"price.product_data.categories.oneOf.0","typeLabel":"string[]"},{"description":"Product categories (e.g., \"Vitamins\", \"First Aid\").","type":"null","items":{"type":"string"},"uniqueKey":"price.product_data.categories.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product_data.categories","typeLabel":"string[] | null"},"components":{"oneOf":[{"description":"Product components or ingredients (e.g., \"Vitamin C\", \"Zinc\").","type":"array","items":{"type":"string","uniqueKey":"price.product_data.components.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"price.product_data.components.oneOf.0","typeLabel":"string[]"},{"description":"Product components or ingredients (e.g., \"Vitamin C\", \"Zinc\").","type":"null","items":{"type":"string"},"uniqueKey":"price.product_data.components.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product_data.components","typeLabel":"string[] | null"}},"example":{"name":"Example","description":"Premium SPF 50 mineral sunscreen","upc_code":"example_value","gtin":"example_value","reference_gtin":"example_value","url":"https://example.com","client_reference_id":"example_value","metadata":{"order_id":"8842","channel":"shopify"},"image_urls":["https://example.com/image.png"],"categories":["string"],"components":["string"]},"uniqueKey":"price.product_data","typeLabel":"object"}},"required":["unit_amount"],"example":{"lookup_key":"standard_monthly","transfer_lookup_key":true,"description":"Premium SPF 50 mineral sunscreen","unit_amount":2500,"recurring":{"interval":"day","interval_count":0,"trial_period_days":0},"metadata":{"order_id":"8842","channel":"shopify"},"product":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","product_data":{"name":"Example","description":"Premium SPF 50 mineral sunscreen","upc_code":"example_value","gtin":"example_value","reference_gtin":"example_value","url":"https://example.com","client_reference_id":"example_value","metadata":{"order_id":"8842","channel":"shopify"},"image_urls":["https://example.com/image.png"],"categories":["string"],"components":["string"]}},"isRequired":true,"uniqueKey":"price","typeLabel":"object"}},"example":{"price":{"lookup_key":"standard_monthly","transfer_lookup_key":true,"description":"Premium SPF 50 mineral sunscreen","unit_amount":2500,"recurring":{"interval":"day","interval_count":0,"trial_period_days":0},"metadata":{"order_id":"8842","channel":"shopify"},"product":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","product_data":{"name":"Example","description":"Premium SPF 50 mineral sunscreen","upc_code":"example_value","gtin":"example_value","reference_gtin":"example_value","url":"https://example.com","client_reference_id":"example_value","metadata":{"order_id":"8842","channel":"shopify"},"image_urls":["https://example.com/image.png"],"categories":["string"],"components":["string"]}}},"uniqueKey":"","typeLabel":"object"},"example":{"price":{"lookup_key":"standard_monthly","transfer_lookup_key":true,"description":"Premium SPF 50 mineral sunscreen","unit_amount":2500,"recurring":{"interval":"day","interval_count":0,"trial_period_days":0},"metadata":{"order_id":"8842","channel":"shopify"},"product":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","product_data":{"name":"Example","description":"Premium SPF 50 mineral sunscreen","upc_code":"example_value","gtin":"example_value","reference_gtin":"example_value","url":"https://example.com","client_reference_id":"example_value","metadata":{"order_id":"8842","channel":"shopify"},"image_urls":["https://example.com/image.png"],"categories":["string"],"components":["string"]}}},"examples":{"Example":{"title":"Example","value":{"price":{"lookup_key":"standard_monthly","transfer_lookup_key":true,"description":"Premium SPF 50 mineral sunscreen","unit_amount":2500,"recurring":{"interval":"day","interval_count":0,"trial_period_days":0},"metadata":{"order_id":"8842","channel":"shopify"},"product":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","product_data":{"name":"Example","description":"Premium SPF 50 mineral sunscreen","upc_code":"example_value","gtin":"example_value","reference_gtin":"example_value","url":"https://example.com","client_reference_id":"example_value","metadata":{"order_id":"8842","channel":"shopify"},"image_urls":["https://example.com/image.png"],"categories":["string"],"components":["string"]}}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"a3651f1c-209b-481c-b507-cd12f5089240":{"description":"An envelope wrapping a single price object.","content":{"application/json":{"schema":{"description":"An envelope wrapping a single price object.","type":"object","required":["price"],"properties":{"price":{"description":"The price object.","type":"object","required":["active","created_at","price_id","product","test_mode","type","unit_amount"],"properties":{"price_id":{"description":"The unique identifier for the price.","type":"string","example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"price.price_id","typeLabel":"string"},"unit_amount":{"description":"The amount to charge per unit, in the smallest currency unit (e.g., `2500` = $25.00 USD).","type":"integer","format":"int32","minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"price.unit_amount","typeLabel":"integer\u003cint32>"},"active":{"description":"Whether the price is currently active.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"price.active","typeLabel":"boolean"},"product":{"oneOf":[{"type":"string","description":"The product this price belongs to. Returned as a product ID by default, or as the full Product object when expanded.","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"price.product.oneOf.0","typeLabel":"string"},{"type":"object","description":"The product this price belongs to. Returned as a product ID by default, or as the full Product object when expanded.","required":["active","created_at","hsa_fsa_eligibility","name","product_id","test_mode"],"example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","properties":{"product_id":{"description":"The unique identifier for the product.","type":"string","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","isRequired":true,"uniqueKey":"price.product.oneOf.1.product_id","typeLabel":"string"},"name":{"description":"The name of the product.","type":"string","example":"Example","isRequired":true,"uniqueKey":"price.product.oneOf.1.name","typeLabel":"string"},"created_at":{"description":"The date the product was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"price.product.oneOf.1.created_at","typeLabel":"string"},"active":{"description":"Determines if the product is active or not.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"price.product.oneOf.1.active","typeLabel":"boolean"},"hsa_fsa_eligibility":{"description":"The elegibility of the product for HSA/FSA.","type":"string","enum":["not_eligible","auto_substantiation","private_label","letter_of_medical_necessity","prescription","vision","service","pending"],"example":"not_eligible","isRequired":true,"uniqueKey":"price.product.oneOf.1.hsa_fsa_eligibility","typeLabel":"enum\u003cstring>"},"test_mode":{"description":"Whether the product is in test mode or not.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"price.product.oneOf.1.test_mode","typeLabel":"boolean"},"owner_partner_id":{"oneOf":[{"description":"The ID of the account that owns this product. For products shared across an organization this may be a sibling account; otherwise it is your own account ID.","type":"string","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"price.product.oneOf.1.owner_partner_id.oneOf.0","typeLabel":"string"},{"description":"The ID of the account that owns this product. For products shared across an organization this may be a sibling account; otherwise it is your own account ID.","type":"null","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"price.product.oneOf.1.owner_partner_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product.oneOf.1.owner_partner_id","typeLabel":"string | null"},"description":{"oneOf":[{"description":"The description of the product.","type":"string","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"price.product.oneOf.1.description.oneOf.0","typeLabel":"string"},{"description":"The description of the product.","type":"null","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"price.product.oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product.oneOf.1.description","typeLabel":"string | null"},"document_description":{"oneOf":[{"description":"Medical-grade description optimized for use in Letters of Medical Necessity and receipts.","deprecated":true,"type":"string","uniqueKey":"price.product.oneOf.1.document_description.oneOf.0","typeLabel":"string"},{"description":"Medical-grade description optimized for use in Letters of Medical Necessity and receipts.","deprecated":true,"type":"null","uniqueKey":"price.product.oneOf.1.document_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product.oneOf.1.document_description","typeLabel":"string | null"},"receipt_description":{"oneOf":[{"description":"Shortened description tailored to receipt line items","type":"string","uniqueKey":"price.product.oneOf.1.receipt_description.oneOf.0","typeLabel":"string"},{"description":"Shortened description tailored to receipt line items","type":"null","uniqueKey":"price.product.oneOf.1.receipt_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product.oneOf.1.receipt_description","typeLabel":"string | null"},"visit_type":{"oneOf":[{"type":"string","description":"The visit type of the product if a letter of medical necessity is required.","enum":["cbtSleep","notApplicable","metabolomics","tinnitus","gym","exerciseDiet","orthopedic","alcohol","airPurification","vaginalHealth","menstrual","canopy","alopecia","genate","weightBlanket","bedJet","siderAl","sunwinkPowder","wavWatch","bodyComplete","ageRate","nitrousOxide","happyV","groupChat","icalmAnxiety","redBloom","foodom","branchErgonomicFurniture","curalife","eloraInfantWellness","nutriHealth","olipop","goldIntimate","touchStoneEssentials","utiva","sleepGeekz","figBrew","auBabyBlanket","babySleepSack","oshWellness","currentBodyRedLight","mito","circularRing","lymaRedLight","goodAirRx","tastermonial","karunaHome","ergoStandingChair","jbaGlucoseControl","bloomNutrition","buoyDrops","luxeWonderWig","saunaMarketplace","amrioreEyewear","pivotOrthoShoe","lumenCynergy","roga","pulsetto","mitoRedLight","gutPersonal","goFlaus","myHixel","calmigo","dotFit","stripesBeauty","mixHers","pmd","positivityWithPurpose","techRing","popVeneers","vertaClean","lumen","medicalMeal","emnHealth","detergentAllergy","lowImpactExercise","mediumImpactExercise","highImpactExercise","gardening","babyCarrier","smartGlasses","automatedCleaner","uvClothing","adaptiveShoes","breathWork","nonenalOdor","meneralsNootropicPouch","babyMonitorSplit","babySleepApp","coolingSleepwear","bodyPillow","uvGlasses","nursingChairs","coolingBed","posture","supplements","sleep","redLightTherapy","fitness","smartRing","womensVaginalHealth","fertilitySupport","femaleReproduction","femaleReproductionFood","pregnancyLiterature","iceBath","orthopedicShoes","sexualHealth","glucose","metabolicTest","skinCare","oralHealth","oralAnxiety","blueLightGlasses","anxiety","brainHealth","babyMonitor","compressionSocks","compressionShorts","waterPurification","medSpa","essentialOils","sleepBuds","latchLight","nutritionist","rairflow","enduranceTraining","hydration","hairGrowth","eD","postureFitness","childDevelopment","adaptiveClothing","sleepConsulting","hairRemoval","menopause","maleFertility","anxietyHealth","bidets","speechHealth","artOfLiving","breastMilk","petSupport","diapers","gutSupplements","smartWatch","medicalBotox","biomechanicalAssessment","erectileReset","femaleOrgasm","pornAddiction","memorySupport","oralHealthMasticGum","orthopedicSandals","childDevelopmentAnxietySleep","childDevelopmentAdjustment","childDevelopmentBehavior","childDevelopmentIdentity","emnHealthMobility","adaptiveShoesDependent","speechHealthDependent","breathWorkDependent"],"example":"cbtSleep","uniqueKey":"price.product.oneOf.1.visit_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The visit type of the product if a letter of medical necessity is required.","uniqueKey":"price.product.oneOf.1.visit_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product.oneOf.1.visit_type","typeLabel":"enum\u003cstring> | null"},"upc_code":{"oneOf":[{"description":"The upc code of the product.","type":"string","uniqueKey":"price.product.oneOf.1.upc_code.oneOf.0","typeLabel":"string"},{"description":"The upc code of the product.","type":"null","uniqueKey":"price.product.oneOf.1.upc_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product.oneOf.1.upc_code","typeLabel":"string | null"},"gtin":{"oneOf":[{"description":"The gtin code of the product.","type":"string","uniqueKey":"price.product.oneOf.1.gtin.oneOf.0","typeLabel":"string"},{"description":"The gtin code of the product.","type":"null","uniqueKey":"price.product.oneOf.1.gtin.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product.oneOf.1.gtin","typeLabel":"string | null"},"reference_gtin":{"oneOf":[{"description":"The GTIN of a private-label reference product, used to establish HSA/FSA eligibility.","type":"string","uniqueKey":"price.product.oneOf.1.reference_gtin.oneOf.0","typeLabel":"string"},{"description":"The GTIN of a private-label reference product, used to establish HSA/FSA eligibility.","type":"null","uniqueKey":"price.product.oneOf.1.reference_gtin.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product.oneOf.1.reference_gtin","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Metadata associated with the product.","type":"object","additionalProperties":{"type":"string","uniqueKey":"price.product.oneOf.1.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"price.product.oneOf.1.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata associated with the product.","type":"null","additionalProperties":{"type":"string","uniqueKey":"price.product.oneOf.1.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"price.product.oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product.oneOf.1.metadata","typeLabel":"object | null"},"url":{"oneOf":[{"description":"The URL of the product.","type":"string","example":"https://example.com","uniqueKey":"price.product.oneOf.1.url.oneOf.0","typeLabel":"string"},{"description":"The URL of the product.","type":"null","example":"https://example.com","uniqueKey":"price.product.oneOf.1.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product.oneOf.1.url","typeLabel":"string | null"},"client_reference_id":{"oneOf":[{"description":"An optional identifier for the product set by the client at creation time. Immutable after creation.","type":"string","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"price.product.oneOf.1.client_reference_id.oneOf.0","typeLabel":"string"},{"description":"An optional identifier for the product set by the client at creation time. Immutable after creation.","type":"null","example":"obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"price.product.oneOf.1.client_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.product.oneOf.1.client_reference_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"price.product.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"price.product","typeLabel":"string | object"},"created_at":{"description":"The date the price was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"price.created_at","typeLabel":"string"},"type":{"description":"The type of the price: a single one-time charge, or a recurring charge billed on a schedule.","type":"string","enum":["one_time","recurring"],"example":"one_time","isRequired":true,"uniqueKey":"price.type","typeLabel":"enum\u003cstring>"},"test_mode":{"description":"Whether the price is in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"price.test_mode","typeLabel":"boolean"},"owner_partner_id":{"oneOf":[{"description":"The ID of the account that owns this price. For prices shared across an organization this may be a sibling account; otherwise it is your own account ID.","type":"string","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"price.owner_partner_id.oneOf.0","typeLabel":"string"},{"description":"The ID of the account that owns this price. For prices shared across an organization this may be a sibling account; otherwise it is your own account ID.","type":"null","example":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"price.owner_partner_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.owner_partner_id","typeLabel":"string | null"},"description":{"oneOf":[{"description":"The description of the price.","type":"string","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"price.description.oneOf.0","typeLabel":"string"},{"description":"The description of the price.","type":"null","example":"Premium SPF 50 mineral sunscreen","uniqueKey":"price.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.description","typeLabel":"string | null"},"trial_period_days":{"oneOf":[{"description":"The number of trial period days before the customer is first charged for a recurring price.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"price.trial_period_days.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"The number of trial period days before the customer is first charged for a recurring price.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"price.trial_period_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.trial_period_days","typeLabel":"integer\u003cint32> | null"},"recurring":{"oneOf":[{"type":"object","description":"The recurring components of a price such as interval and trial period days.","required":["interval"],"example":{"interval":"day","interval_count":0,"trial_period_days":0},"properties":{"interval":{"description":"The billing cadence for the price.","type":"string","enum":["day","week","month","year"],"example":"day","isRequired":true,"uniqueKey":"price.recurring.oneOf.0.interval","typeLabel":"enum\u003cstring>"},"interval_count":{"oneOf":[{"description":"The number of intervals","type":"integer","format":"int64","minimum":0,"maximum":4294967295,"uniqueKey":"price.recurring.oneOf.0.interval_count.oneOf.0","typeLabel":"integer\u003cint64>"},{"description":"The number of intervals","type":"null","format":"int64","minimum":0,"maximum":4294967295,"uniqueKey":"price.recurring.oneOf.0.interval_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.recurring.oneOf.0.interval_count","typeLabel":"integer\u003cint64> | null"},"trial_period_days":{"oneOf":[{"description":"The number of trial period days before the customer is charged for the first time. Whole days only. For a precise trial-end timestamp (e.g. non-integer days), use `subscription_data.trial_end` on the Create Checkout Session request instead.","type":"integer","format":"int64","minimum":0,"maximum":4294967295,"uniqueKey":"price.recurring.oneOf.0.trial_period_days.oneOf.0","typeLabel":"integer\u003cint64>"},{"description":"The number of trial period days before the customer is charged for the first time. Whole days only. For a precise trial-end timestamp (e.g. non-integer days), use `subscription_data.trial_end` on the Create Checkout Session request instead.","type":"null","format":"int64","minimum":0,"maximum":4294967295,"uniqueKey":"price.recurring.oneOf.0.trial_period_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.recurring.oneOf.0.trial_period_days","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"price.recurring.oneOf.0","typeLabel":"object"},{"type":"null","description":"The recurring components of a price such as interval and trial period days.","uniqueKey":"price.recurring.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.recurring","typeLabel":"object | null"},"metadata":{"oneOf":[{"description":"Metadata information for the price object","type":"object","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"price.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata information for the price object","type":"null","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"price.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.metadata","typeLabel":"object | null"},"lookup_key":{"oneOf":[{"description":"A stable, partner-owned key for this price. Unique per account and mode across all prices, archived ones included. `null` until you set one.","type":"string","maxLength":200,"example":"standard_monthly","uniqueKey":"price.lookup_key.oneOf.0","typeLabel":"string"},{"description":"A stable, partner-owned key for this price. Unique per account and mode across all prices, archived ones included. `null` until you set one.","type":"null","maxLength":200,"example":"standard_monthly","uniqueKey":"price.lookup_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.lookup_key","typeLabel":"string | null"},"hsa_fsa_eligibility":{"oneOf":[{"type":"string","description":"The HSA/FSA eligibility for the price.","enum":["not_eligible","auto_substantiation","private_label","letter_of_medical_necessity","prescription","vision","service","pending"],"example":"not_eligible","uniqueKey":"price.hsa_fsa_eligibility.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The HSA/FSA eligibility for the price.","uniqueKey":"price.hsa_fsa_eligibility.oneOf.1","typeLabel":"null"}],"uniqueKey":"price.hsa_fsa_eligibility","typeLabel":"enum\u003cstring> | null"}},"example":{"price_id":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","owner_partner_id":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","description":"Premium SPF 50 mineral sunscreen","trial_period_days":0,"unit_amount":0,"recurring":{"interval":"day","interval_count":0,"trial_period_days":0},"active":false,"product":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","created_at":"2026-06-15T14:30:00Z","type":"one_time","metadata":{"order_id":"8842","channel":"shopify"},"lookup_key":"standard_monthly","hsa_fsa_eligibility":"not_eligible","test_mode":false},"isRequired":true,"uniqueKey":"price","typeLabel":"object"}},"example":{"price":{"price_id":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","owner_partner_id":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","description":"Premium SPF 50 mineral sunscreen","trial_period_days":0,"unit_amount":0,"recurring":{"interval":"day","interval_count":0,"trial_period_days":0},"active":false,"product":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","created_at":"2026-06-15T14:30:00Z","type":"one_time","metadata":{"order_id":"8842","channel":"shopify"},"lookup_key":"standard_monthly","hsa_fsa_eligibility":"not_eligible","test_mode":false}},"uniqueKey":"","typeLabel":"object"},"example":{"price":{"price_id":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","owner_partner_id":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","description":"Premium SPF 50 mineral sunscreen","trial_period_days":0,"unit_amount":0,"recurring":{"interval":"day","interval_count":0,"trial_period_days":0},"active":false,"product":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","created_at":"2026-06-15T14:30:00Z","type":"one_time","metadata":{"order_id":"8842","channel":"shopify"},"lookup_key":"standard_monthly","hsa_fsa_eligibility":"not_eligible","test_mode":false}},"examples":{"Example":{"title":"Example","value":{"price":{"price_id":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","owner_partner_id":"facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA","description":"Premium SPF 50 mineral sunscreen","trial_period_days":0,"unit_amount":0,"recurring":{"interval":"day","interval_count":0,"trial_period_days":0},"active":false,"product":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","created_at":"2026-06-15T14:30:00Z","type":"one_time","metadata":{"order_id":"8842","channel":"shopify"},"lookup_key":"standard_monthly","hsa_fsa_eligibility":"not_eligible","test_mode":false}}}},"exampleType":"examples"}},"exampleType":"examples"},"11cbeb6a-8ccf-4625-a309-95b2c4cf9e0f":{"description":"Unauthorized","content":{"application/json":{"schema":{"title":"HttpError","description":"The error response returned when a request cannot be completed.","type":"object","required":["code","detail"],"properties":{"code":{"description":"A short machine-readable error code identifying the type of error.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable explanation of what went wrong.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"example":{"code":"string","detail":"string"},"uniqueKey":"","typeLabel":"HttpError · object"},"example":{"code":"string","detail":"string"},"examples":{"Example":{"title":"Example","value":{"code":"string","detail":"string"}}},"exampleType":"examples"}},"exampleType":"examples"},"8a5a7047-ddd0-4fb8-b63c-8811751e13b8":{"description":"Forbidden","content":{"application/json":{"schema":{"title":"HttpError","description":"The error response returned when a request cannot be completed.","type":"object","required":["code","detail"],"properties":{"code":{"description":"A short machine-readable error code identifying the type of error.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable explanation of what went wrong.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"example":{"code":"string","detail":"string"},"uniqueKey":"","typeLabel":"HttpError · object"},"example":{"code":"string","detail":"string"},"examples":{"Example":{"title":"Example","value":{"code":"string","detail":"string"}}},"exampleType":"examples"}},"exampleType":"examples"},"215594fd-f13b-401d-9387-cba9ae39fdcd":{"description":"Not Found","content":{"application/json":{"schema":{"title":"HttpError","description":"The error response returned when a request cannot be completed.","type":"object","required":["code","detail"],"properties":{"code":{"description":"A short machine-readable error code identifying the type of error.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable explanation of what went wrong.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"example":{"code":"string","detail":"string"},"uniqueKey":"","typeLabel":"HttpError · object"},"example":{"code":"string","detail":"string"},"examples":{"Example":{"title":"Example","value":{"code":"string","detail":"string"}}},"exampleType":"examples"}},"exampleType":"examples"},"d9f478ca-34be-471e-a431-64d597511c02":{"description":"Conflict","content":{"application/json":{"schema":{"title":"HttpError","description":"The error response returned when a request cannot be completed.","type":"object","required":["code","detail"],"properties":{"code":{"description":"A short machine-readable error code identifying the type of error.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable explanation of what went wrong.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"example":{"code":"string","detail":"string"},"uniqueKey":"","typeLabel":"HttpError · object"},"example":{"code":"string","detail":"string"},"examples":{"Example":{"title":"Example","value":{"code":"string","detail":"string"}}},"exampleType":"examples"}},"exampleType":"examples"},"35c47077-2dee-4b50-a49f-26f1c8c0893d":{"description":"Validation Error","content":{"application/json":{"schema":{"description":"The error response returned when request validation fails (HTTP 422).","type":"object","required":["detail"],"properties":{"detail":{"description":"The list of validation errors, one entry per invalid field.","type":"array","items":{"description":"Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these per 422 UNPROCESSABLE ENTITY error.","type":"object","required":["loc","msg","type"],"properties":{"loc":{"description":"The location as a [`Vec`] of [`String`]s -- often in the form `[\"body\", \"field_name\"]`, `[\"query\", \"field_name\"]`, etc. They may, however, be arbitarily deep.","type":"array","items":{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"string[]"},"msg":{"description":"The message accompanying the validation error item.","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"description":"The type of error, often \"type_error\" or \"value_error\", but sometimes with more context like as \"value_error.number.not_ge\"","type":"string","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"example":{"loc":["string"],"msg":"string","type":"string"},"uniqueKey":"detail.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"detail","typeLabel":"object[]"}},"example":{"detail":[{"loc":["string"],"msg":"string","type":"string"}]},"uniqueKey":"","typeLabel":"object"},"example":{"detail":[{"loc":["string"],"msg":"string","type":"string"}]},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["string"],"msg":"string","type":"string"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"5d825537-a5b2-4671-aa69-49fcbfbd4ed7":{"description":"Too Many Requests","content":{"application/json":{"schema":{"title":"HttpError","description":"The error response returned when a request cannot be completed.","type":"object","required":["code","detail"],"properties":{"code":{"description":"A short machine-readable error code identifying the type of error.","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"description":"A human-readable explanation of what went wrong.","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"example":{"code":"string","detail":"string"},"uniqueKey":"","typeLabel":"HttpError · object"},"example":{"code":"string","detail":"string"},"examples":{"Example":{"title":"Example","value":{"code":"string","detail":"string"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"6bca4f81-c4b3-4104-85e5-772157728ce1":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Use a Bearer token to access this API.","scopes":["prices:write"],"schemeName":"BearerAuth"}}},"servers":{"1eb7f03d-8389-434a-b6e0-633ee4e07aa2":{"url":"https://api.withflex.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Use a Bearer token to access this API.","scopes":["prices:write"],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use a Bearer token to access this API.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"flex-87","siteName":"Flex Documentation","title":"Create Price - Flex Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T20:50:15.882Z","originalFileLocation":"api-reference/prices/create-price.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=\"Creates a new price. Supply product to attach the price to an existing product, or product_data to create a new product inline in the same request. A price is one-time unless you include recurring, in which case it bills on the given interval. Amounts are in the smallest currency unit (cents) and charged in USD. If HSA/FSA eligibility is not set on the price, the parent product\u0026#x27;s eligibility applies.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Flex Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flex-87/uZDAr5goax7LGN2W/_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=\"/mintlify-assets/_mintlify/favicons/flex-87/uZDAr5goax7LGN2W/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flex-87/uZDAr5goax7LGN2W/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/flex-87/uZDAr5goax7LGN2W/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/flex-87/uZDAr5goax7LGN2W/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flex-87/uZDAr5goax7LGN2W/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flex-87/uZDAr5goax7LGN2W/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/flex-87/uZDAr5goax7LGN2W/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/flex-87/uZDAr5goax7LGN2W/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Price - Flex Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new price. Supply product to attach the price to an existing product, or product_data to create a new product inline in the same request. A price is one-time unless you include recurring, in which case it bills on the given interval. Amounts are in the smallest currency unit (cents) and charged in USD. If HSA/FSA eligibility is not set on the price, the parent product\u0026#x27;s eligibility applies.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Flex Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.withflex.com/api-reference/prices/create-price\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flex-87.mintlify.site/_mintlify/api/og/v2?division=Prices\u0026amp;title=Create+Price\u0026amp;description=Creates+a+new+price.+Supply+%60product%60+to+attach+the+price+to+an+existing+product%2C+or+%60product_data%60+to+create+a+new+product+inline+in+the+same+request.+A+price+\u0026amp;theme=9ca02344851323b0ec50073b\u0026amp;signature=c16f63f4f527a5277252b81350db37b78ffea112bb8fb3d1553ccf9ee394fe52\">\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=\"Create Price - Flex Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new price. Supply product to attach the price to an existing product, or product_data to create a new product inline in the same request. A price is one-time unless you include recurring, in which case it bills on the given interval. Amounts are in the smallest currency unit (cents) and charged in USD. If HSA/FSA eligibility is not set on the price, the parent product\u0026#x27;s eligibility applies.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flex-87.mintlify.site/_mintlify/api/og/v2?division=Prices\u0026amp;title=Create+Price\u0026amp;description=Creates+a+new+price.+Supply+%60product%60+to+attach+the+price+to+an+existing+product%2C+or+%60product_data%60+to+create+a+new+product+inline+in+the+same+request.+A+price+\u0026amp;theme=9ca02344851323b0ec50073b\u0026amp;signature=c16f63f4f527a5277252b81350db37b78ffea112bb8fb3d1553ccf9ee394fe52\">\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=\"/mintlify-assets/_mintlify/favicons/flex-87/uZDAr5goax7LGN2W/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Flex Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0070FA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.withflex.com/api-reference/prices/create-price\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/prices/create-price.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.withflex.com/#organization\",\"name\":\"Flex Documentation\",\"url\":\"https://docs.withflex.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/flex-87/1kILreF5HcjIKLdi/logo/light.svg?fit=max\u0026auto=format\u0026n=1kILreF5HcjIKLdi\u0026q=85\u0026s=f703a75bc80df014f4849a7225b4879f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.withflex.com#website\",\"name\":\"Flex Documentation\",\"url\":\"https://docs.withflex.com\",\"publisher\":{\"@id\":\"https://docs.withflex.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.withflex.com/api-reference/prices/create-price#webpage\",\"url\":\"https://docs.withflex.com/api-reference/prices/create-price\",\"name\":\"Create Price\",\"description\":\"Creates a new price. Supply product to attach the price to an existing product, or product_data to create a new product inline in the same request. A price is one-time unless you include recurring, in which case it bills on the given interval. Amounts are in the smallest currency unit (cents) and charged in USD. If HSA/FSA eligibility is not set on the price, the parent product's eligibility applies.\",\"dateModified\":\"2026-11-20T20:50:15.882Z\",\"isPartOf\":{\"@id\":\"https://docs.withflex.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.withflex.com/api-reference/prices/create-price#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.withflex.com/api-reference/prices/create-price#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.withflex.com/api-reference/shipping-rates/list-shipping-rates\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Prices\",\"item\":\"https://docs.withflex.com/api-reference/prices/list-prices\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Price\",\"item\":\"https://docs.withflex.com/api-reference/prices/create-price\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.withflex.com/api-reference/prices/create-price#apireference\",\"headline\":\"Create Price\",\"name\":\"Create Price\",\"description\":\"Creates a new price. Supply product to attach the price to an existing product, or product_data to create a new product inline in the same request. A price is one-time unless you include recurring, in which case it bills on the given interval. Amounts are in the smallest currency unit (cents) and charged in USD. If HSA/FSA eligibility is not set on the price, the parent product's eligibility applies.\",\"url\":\"https://docs.withflex.com/api-reference/prices/create-price\",\"mainEntityOfPage\":{\"@id\":\"https://docs.withflex.com/api-reference/prices/create-price#webpage\"},\"dateModified\":\"2026-11-20T20:50:15.882Z\",\"publisher\":{\"@id\":\"https://docs.withflex.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.withflex.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Flex Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Flex Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/prices/create-price.md","siteName":"Flex Documentation","nav":{"global":{"anchors":[{"anchor":"Status","icon":"wifi","href":"https://statuspage.incident.io/with-flex"},{"anchor":"Support","icon":"mail","href":"mailto:support@withflex.com"},{"anchor":"Website","icon":"laptop","href":"https://www.withflex.com"}]},"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/developer-guides/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Overview","pages":[{"title":"Introduction to the Flex API","sidebarTitle":"Introduction","href":"/api-reference/introduction"},{"title":"Expanding Resources","sidebarTitle":"Expanding Resources","href":"/api-reference/expanding-resources"}]},{"group":"API Reference","pages":[{"group":"Shipping Rates","pages":[{"title":"List Shipping Rates","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/shipping_rates","href":"/api-reference/shipping-rates/list-shipping-rates"},{"title":"Create Shipping Rate","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/shipping_rates","href":"/api-reference/shipping-rates/create-shipping-rate"},{"title":"Get Shipping Rate","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/shipping_rates/{id}","href":"/api-reference/shipping-rates/get-shipping-rate"},{"title":"Update Shipping Rate","deprecated":null,"version":null,"openapi":"/openapi.json put /v1/shipping_rates/{id}","href":"/api-reference/shipping-rates/update-shipping-rate"}]},{"group":"Disputes","pages":[{"title":"List Disputes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/disputes","href":"/api-reference/disputes/list-disputes"},{"title":"Count Disputes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/disputes/count","href":"/api-reference/disputes/count-disputes"},{"title":"Get Dispute","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/disputes/{dispute_id}","href":"/api-reference/disputes/get-dispute"},{"title":"Update Dispute","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/disputes/{dispute_id}","href":"/api-reference/disputes/update-dispute"},{"title":"Close Dispute","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/disputes/{dispute_id}/close","href":"/api-reference/disputes/close-dispute"}]},{"group":"Events","pages":[{"title":"Retry Event","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/events/{id}/retry","href":"/api-reference/events/retry-event"}]},{"group":"Checkout Sessions","pages":[{"title":"List Checkout Sessions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/checkout/sessions","href":"/api-reference/checkout-sessions/list-checkout-sessions"},{"title":"Create Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions","href":"/api-reference/checkout-sessions/create-checkout-session"},{"title":"Get Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/checkout/sessions/{id}","href":"/api-reference/checkout-sessions/get-checkout-session"},{"title":"Get Line Items","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/checkout/sessions/{id}/line_items","href":"/api-reference/checkout-sessions/get-line-items"},{"title":"Confirm Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/confirm","href":"/api-reference/checkout-sessions/confirm-checkout-session"},{"title":"Capture Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/capture","href":"/api-reference/checkout-sessions/capture-checkout-session"},{"title":"Preview Capture Allocation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/capture_allocation","href":"/api-reference/checkout-sessions/preview-capture-allocation"},{"title":"Reauth Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/reauth","href":"/api-reference/checkout-sessions/reauth-checkout-session"},{"title":"Refund Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/refund","href":"/api-reference/checkout-sessions/refund-checkout-session"},{"title":"Preview Refund Allocation","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/refund_allocation","href":"/api-reference/checkout-sessions/preview-refund-allocation"},{"title":"Cancel Auth Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/cancel","href":"/api-reference/checkout-sessions/cancel-auth-checkout-session"},{"title":"Resend Checkout Session Receipts","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/receipts/resend","href":"/api-reference/checkout-sessions/resend-checkout-session-receipts"},{"title":"Resend Checkout Session Lomn","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/checkout/sessions/{id}/lomn/resend","href":"/api-reference/checkout-sessions/resend-checkout-session-lomn"}]},{"group":"Coupons","pages":[{"title":"List Coupons","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/coupons","href":"/api-reference/coupons/list-coupons"},{"title":"Create Coupon","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/coupons","href":"/api-reference/coupons/create-coupon"},{"title":"Get Coupon","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/coupons/{id}","href":"/api-reference/coupons/get-coupon"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/customers","href":"/api-reference/customers/list-customers"},{"title":"Create or update a customer","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/customers","href":"/api-reference/customers/create-or-update-a-customer"},{"title":"Retrieve a customer","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/customers/{id}","href":"/api-reference/customers/retrieve-a-customer"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/customers/{id}","href":"/api-reference/customers/delete-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/customers/{id}","href":"/api-reference/customers/update-a-customer"},{"title":"List a customer's payment methods","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/customers/{id}/payment_methods","href":"/api-reference/customers/list-a-customers-payment-methods"},{"title":"Retrieve a customer's payment method","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/customers/{id}/payment_methods/{pm_id}","href":"/api-reference/customers/retrieve-a-customers-payment-method"}]},{"group":"Exports","pages":[{"title":"List Exports","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/exports","href":"/api-reference/exports/list-exports"},{"title":"Create Export","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/exports","href":"/api-reference/exports/create-export"},{"title":"Get Export","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/exports/{id}","href":"/api-reference/exports/get-export"},{"title":"Cancel Export","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/exports/{id}/cancel","href":"/api-reference/exports/cancel-export"},{"title":"Create Export Url","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/exports/{id}/presigned_url","href":"/api-reference/exports/create-export-url"}]},{"group":"Invoices","pages":[{"title":"List Invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get Invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{id}","href":"/api-reference/invoices/get-invoice"},{"title":"Mark Invoice Uncollectible","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/invoices/{id}/mark_uncollectible","href":"/api-reference/invoices/mark-invoice-uncollectible"}]},{"group":"Products","pages":[{"title":"List Product Components","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/product_components","href":"/api-reference/products/list-product-components"},{"title":"Create Product Component","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/product_components","href":"/api-reference/products/create-product-component"},{"title":"Get Product Component","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/product_components/{id}","href":"/api-reference/products/get-product-component"},{"title":"Update Product Component","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/product_components/{id}","href":"/api-reference/products/update-product-component"},{"title":"List Products","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/products","href":"/api-reference/products/list-products"},{"title":"Create Product","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/products","href":"/api-reference/products/create-product"},{"title":"Processing Status","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/products/processing_status","href":"/api-reference/products/processing-status"},{"title":"Get Product","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/products/{id}","href":"/api-reference/products/get-product"},{"title":"Update Product","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/products/{id}","href":"/api-reference/products/update-product"}]},{"group":"Payment Intents","pages":[{"title":"List Payment Intents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment_intents","href":"/api-reference/payment-intents/list-payment-intents"},{"title":"Get Payment Intent","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment_intents/{id}","href":"/api-reference/payment-intents/get-payment-intent"},{"title":"Send Receipt","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment_intents/{id}/receipt","href":"/api-reference/payment-intents/send-receipt"},{"title":"Cancel Payment Intent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment_intents/{id}/cancel","href":"/api-reference/payment-intents/cancel-payment-intent"}]},{"group":"Payment Links","pages":[{"title":"List Payment Links","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment_links","href":"/api-reference/payment-links/list-payment-links"},{"title":"Create Payment Link","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/payment_links","href":"/api-reference/payment-links/create-payment-link"},{"title":"Get Payment Link","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment_links/{id}","href":"/api-reference/payment-links/get-payment-link"},{"title":"Update Payment Link","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/payment_links/{id}","href":"/api-reference/payment-links/update-payment-link"}]},{"group":"Payouts","pages":[{"title":"List Payouts","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payouts","href":"/api-reference/payouts/list-payouts"}]},{"group":"Prices","pages":[{"title":"List Prices","description":"Returns a list of your prices, sorted by price ID in descending order (most recently created first). By default only active prices are returned; pass `active=false` to list archived ones, or filter to a single product with `product`. A price is also omitted when its parent product is archived, even if the price itself is active. Resolve prices by lookup key with `lookup_keys[]=standard_monthly\u0026lookup_keys[]=pro_monthly` — up to 10 per request, matching any of them. You can separately filter by metadata using `metadata[key]=value` query parameters, for example `metadata[lookup_key]=premium-plan`. The two are independent: `lookup_keys` matches the price's own `lookup_key` field, while `metadata[lookup_key]` matches a key-value pair you set yourself, and a price can carry a different value in each.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/prices","href":"/api-reference/prices/list-prices"},{"title":"Create Price","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/prices","href":"/api-reference/prices/create-price"},{"title":"Get Price","description":"Retrieves the price with the given ID. Pass `expand_product=true` to inline the full Product object instead of just its ID. Resolves your own prices, and (if you belong to an organization) prices owned by a sibling account.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/prices/{id}","href":"/api-reference/prices/get-price"},{"title":"Update Price","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/prices/{id}","href":"/api-reference/prices/update-price"}]},{"group":"Promo Codes","pages":[{"title":"List Promo Codes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/promo_codes","href":"/api-reference/promo-codes/list-promo-codes"},{"title":"Create Promo Code","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/promo_codes","href":"/api-reference/promo-codes/create-promo-code"},{"title":"Get Promo Code","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/promo_codes/{id}","href":"/api-reference/promo-codes/get-promo-code"},{"title":"Update Promo Code","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/promo_codes/{id}","href":"/api-reference/promo-codes/update-promo-code"}]},{"group":"Refunds","pages":[{"title":"List Refunds","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/refunds","href":"/api-reference/refunds/list-refunds"},{"title":"Create Refund","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/refunds","href":"/api-reference/refunds/create-refund"},{"title":"Get Refund","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/refunds/{refund_id}","href":"/api-reference/refunds/get-refund"},{"title":"Update Refund","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/refunds/{refund_id}","href":"/api-reference/refunds/update-refund"}]},{"group":"Reviews","pages":[{"title":"List Reviews","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/reviews","href":"/api-reference/reviews/list-reviews"},{"title":"Get Review","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/reviews/{review_id}","href":"/api-reference/reviews/get-review"}]},{"group":"Subscriptions","pages":[{"title":"List Subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/subscriptions","href":"/api-reference/subscriptions/list-subscriptions"},{"title":"Get Subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/subscriptions/{id}","href":"/api-reference/subscriptions/get-subscription"},{"title":"Cancel Subscription","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/subscriptions/{id}","href":"/api-reference/subscriptions/cancel-subscription"},{"title":"Update Subscription","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/subscriptions/{id}","href":"/api-reference/subscriptions/update-subscription"},{"title":"Resend Subscription Receipts","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/subscriptions/{id}/receipts/resend","href":"/api-reference/subscriptions/resend-subscription-receipts"},{"title":"Get Refund Preview","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/subscriptions/{id}/refund_preview","href":"/api-reference/subscriptions/get-refund-preview"},{"title":"Pause Subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/subscriptions/{id}/pause","href":"/api-reference/subscriptions/pause-subscription"},{"title":"Update Pause","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/subscriptions/{id}/pause","href":"/api-reference/subscriptions/update-pause"},{"title":"Resume Subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/subscriptions/{id}/resume","href":"/api-reference/subscriptions/resume-subscription"},{"title":"Stop a failed resume and keep the subscription paused","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/subscriptions/{id}/resume/cancel","href":"/api-reference/subscriptions/stop-a-failed-resume-and-keep-the-subscription-paused"}]},{"group":"Balance Transactions","pages":[{"title":"List Balance Transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/balance_transactions","href":"/api-reference/balance-transactions/list-balance-transactions"}]},{"group":"Setup Intents","pages":[{"title":"List Setup Intents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/setup_intents","href":"/api-reference/setup-intents/list-setup-intents"},{"title":"Create Setup Intent","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/setup_intents","href":"/api-reference/setup-intents/create-setup-intent"},{"title":"Get Setup Intent","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/setup_intents/{id}","href":"/api-reference/setup-intents/get-setup-intent"}]},{"group":"Captures","pages":[{"title":"List captures","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/captures","href":"/api-reference/captures/list-captures"},{"title":"Retrieve a capture","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/captures/{capture_id}","href":"/api-reference/captures/retrieve-a-capture"},{"title":"Update a capture","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/captures/{capture_id}","href":"/api-reference/captures/update-a-capture"}]},{"group":"Files","pages":[{"title":"List Files","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/files","href":"/api-reference/files/list-files"},{"title":"Create File","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/files","href":"/api-reference/files/create-file"},{"title":"Retrieve File","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/files/{id}","href":"/api-reference/files/retrieve-file"}]}]}]},{"tab":"Compliance","pages":[{"title":"Compliance","href":"/compliance/introduction"}]},{"tab":"Marketing","pages":[{"title":"Marketing","href":"/merchant-success/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Create Price - Flex Documentation","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}