Creates a promotion code referencing an existing coupon. If code is omitted, a unique
code is generated automatically. The supplied code must be unique across your promotion
codes.
{"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":""},"chroma":{"liveDeploymentHistoryId":"6ae374b5b3f002741c1ab41f","collectionId":"02d9944d-fd1b-4f89-a595-9c3890413440","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae374b5b3f002741c1ab41f"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae3cfd39c57ecccbea1d926","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":188},{"language":"default","tag":"Guides","count":51},{"language":"default","tag":"Integration","count":29},{"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":"Disputes","count":8},{"language":"default","tag":"Shopify","count":7},{"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":"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":"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":"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":"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":"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":"billing-updated-9-15","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}],"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}.content img,[data-content] img,article img,main img{border:1px solid #e8eaed!important}.content img.rounded,[data-content] img.rounded,article img.rounded,main img.rounded{border:.5px solid #e8eaed!important}.brand-logo-grid img,.doc-screenshot img,.nav-logo,img.nav-logo,img.no-border{border:0!important}.dark .nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm,.nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm{--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}.nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm{background:rgba(17,24,39,.05)!important;background-color:rgba(17,24,39,.05)!important;color:#1f2937!important}.dark .nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm{background:rgba(229,231,235,.05)!important;background-color:rgba(229,231,235,.05)!important;color:#d1d5db!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,.05)!important;background-color:rgba(17,24,39,.05)!important}.dark .nav-anchor:hover .mr-4.rounded-md.p-1.shadow-sm[style*=background]{background:rgba(229,231,235,.05)!important;background-color:rgba(229,231,235,.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:#fff!important}.lucide.lucide-chevron-right{stroke:#0070fa!important}html.dark .lucide.lucide-chevron-right{stroke:#bab3ff!important}"}],"page":{"pagePath":"api-reference/promo-codes/create-promo-code","slug":"/api-reference/promo-codes/create-promo-code","pageMetadata":{"title":"Create Promo Code","description":"Creates a promotion code referencing an existing coupon. If `code` is omitted, a unique\ncode is generated automatically. The supplied `code` must be unique across your promotion\ncodes.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/promo_codes","href":"/api-reference/promo-codes/create-promo-code","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 promotion code referencing an existing coupon. If \", _jsx(_components.code, {\n children: \"code\"\n }), \" is omitted, a unique\\ncode is generated automatically. The supplied \", _jsx(_components.code, {\n children: \"code\"\n }), \" must be unique across your promotion\\ncodes.\"]\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 Promo Code","description":"Creates a promotion code referencing an existing coupon. If `code` is omitted, a unique\ncode is generated automatically. The supplied `code` must be unique across your promotion\ncodes.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/promo_codes","href":"/api-reference/promo-codes/create-promo-code","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/flex-87/f0156321fafa1974/postcss.config.js"],"openApiReferenceData":{"operation":{"tags":["Promo Codes"],"summary":"Create Promo Code","description":"Creates a promotion code referencing an existing coupon. If `code` is omitted, a unique\ncode is generated automatically. The supplied `code` must be unique across your promotion\ncodes.","operationId":"v1.promo_codes.create","requestBody":"c082e7fd-8965-4dd2-a2ce-f2a7c3704f5a","responses":{"200":"6e9165ce-89af-4c16-bf80-b17521e75401","401":"816944ec-9d21-4b10-ad24-0a1d5596515c","403":"e9749af3-5ac8-45c2-aa40-6ec0f42dcfab","404":"af41aa04-8472-481a-b40a-168b5e4832a8","409":"8dd4cf79-dfb8-4a63-878b-da495ec186d7","422":"96c30a6c-30ce-4df1-bc10-d4184b7bb276","429":"d7237f89-a252-4d9b-9526-74504fc03363"},"security":["cd75af42-2973-418c-b620-f2e30c7c2099"],"method":"post","type":"path","servers":["080577c1-39a5-4498-bb49-d7daab803f21"],"path":"/v1/promo_codes","baseUrlOptions":["https://api.withflex.com"],"title":"Create Promo Code","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"An envelope wrapping a single promotion code object.","content":{"application/json":{"schema":{"description":"An envelope wrapping a single promotion code object.","type":"object","required":["promo_code"],"properties":{"promo_code":{"description":"The promotion code.","type":"object","required":["coupon_id"],"properties":{"coupon_id":{"description":"ID of the Coupon this promotion code applies.","type":"string","example":"fcoup_1234567890","isRequired":true,"uniqueKey":"promo_code.coupon_id","typeLabel":"string"},"code":{"oneOf":[{"description":"The customer-facing code. Must be unique across your promotion codes. If null, a code is generated automatically.","type":"string","example":"SUMMER2016","uniqueKey":"promo_code.code.oneOf.0","typeLabel":"string"},{"description":"The customer-facing code. Must be unique across your promotion codes. If null, a code is generated automatically.","type":"null","example":"SUMMER2016","uniqueKey":"promo_code.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code.code","typeLabel":"string | null"},"max_redemptions":{"oneOf":[{"description":"The number of times the promo code can be redeemed.","type":"integer","format":"int32","maximum":2147483647,"example":100,"minimum":-2147483648,"uniqueKey":"promo_code.max_redemptions.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"The number of times the promo code can be redeemed.","type":"null","format":"int32","maximum":2147483647,"example":100,"minimum":-2147483648,"uniqueKey":"promo_code.max_redemptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code.max_redemptions","typeLabel":"integer\u003cint32> | null"},"customer":{"oneOf":[{"description":"The customer that can be associated with the promo code. If null, the promo code can be redeemed by any customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","uniqueKey":"promo_code.customer.oneOf.0","typeLabel":"string"},{"description":"The customer that can be associated with the promo code. If null, the promo code can be redeemed by any customer.","type":"null","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","uniqueKey":"promo_code.customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code.customer","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Metadata associated with the promo code.","type":"object","example":{"key":"value"},"uniqueKey":"promo_code.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata associated with the promo code.","type":"null","example":{"key":"value"},"uniqueKey":"promo_code.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code.metadata","typeLabel":"object | null"}},"example":{"coupon_id":"fcoup_1234567890","code":"SUMMER2016","max_redemptions":100,"customer":"fcus_01HACM7FZ1084XB1GB6053VM0D","metadata":{"key":"value"}},"isRequired":true,"uniqueKey":"promo_code","typeLabel":"object"}},"example":{"promo_code":{"coupon_id":"fcoup_1234567890","code":"SUMMER2016","max_redemptions":100,"customer":"fcus_01HACM7FZ1084XB1GB6053VM0D","metadata":{"key":"value"}}},"uniqueKey":"","typeLabel":"object"},"example":{"promo_code":{"coupon_id":"fcoup_1234567890","code":"SUMMER2016","max_redemptions":100,"customer":"fcus_01HACM7FZ1084XB1GB6053VM0D","metadata":{"key":"value"}}},"examples":{"Example":{"title":"Example","value":{"promo_code":{"coupon_id":"fcoup_1234567890","code":"SUMMER2016","max_redemptions":100,"customer":"fcus_01HACM7FZ1084XB1GB6053VM0D","metadata":{"key":"value"}}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"6e9165ce-89af-4c16-bf80-b17521e75401":{"description":"An envelope wrapping a single promotion code object.","content":{"application/json":{"schema":{"description":"An envelope wrapping a single promotion code object.","type":"object","required":["promo_code"],"properties":{"promo_code":{"description":"The promotion code.","type":"object","required":["active","code","coupon","created_at","promo_code_id","test_mode","times_redeemed"],"properties":{"promo_code_id":{"description":"The ID of the promo code.","type":"string","example":"fpromo_01HACM7FZ1084XB1GB6053VM0E","isRequired":true,"uniqueKey":"promo_code.promo_code_id","typeLabel":"string"},"code":{"description":"The customer-facing code. Regardless of case, this code must be unique across all active","type":"string","example":"SUMMER2016","isRequired":true,"uniqueKey":"promo_code.code","typeLabel":"string"},"coupon":{"description":"The coupon that the promo code represents.","type":"object","required":["coupon_id","created_at","duration","name","test_mode","valid"],"properties":{"coupon_id":{"description":"Unique identifier for the object.","type":"string","example":"fcoup_1234567890","isRequired":true,"uniqueKey":"promo_code.coupon.coupon_id","typeLabel":"string"},"duration":{"type":"string","enum":["once","repeating","forever"],"x-ms-enum":{"name":"CouponDuration","modelAsString":false,"values":[{"value":"once","name":"Once","description":"Applies to the first charge from a subscription with this coupon applied."},{"value":"repeating","name":"Repeating","description":"Applies to charges in the first duration_in_months months from a subscription with this coupon applied."},{"value":"forever","name":"Forever","description":"Applies to all charges from a subscription with this coupon applied."}]},"description":"One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.","example":"once","isRequired":true,"uniqueKey":"promo_code.coupon.duration","typeLabel":"enum\u003cstring>"},"name":{"description":"Name of the coupon displayed to customers.","type":"string","example":"Example","isRequired":true,"uniqueKey":"promo_code.coupon.name","typeLabel":"string"},"valid":{"description":"Taking account of the above properties, whether this coupon can still be applied to a customer.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"promo_code.coupon.valid","typeLabel":"boolean"},"created_at":{"description":"Date when this coupon was created.","type":"string","example":"2026-06-15T14:30:00Z","isRequired":true,"uniqueKey":"promo_code.coupon.created_at","typeLabel":"string"},"test_mode":{"description":"Whether the coupon is in test mode","type":"boolean","example":false,"isRequired":true,"uniqueKey":"promo_code.coupon.test_mode","typeLabel":"boolean"},"amount_off":{"oneOf":[{"description":"Amount that will be taken off the subtotal of any invoices for this customer.","type":"integer","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648,"uniqueKey":"promo_code.coupon.amount_off.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Amount that will be taken off the subtotal of any invoices for this customer.","type":"null","format":"int32","maximum":2147483647,"example":2500,"minimum":-2147483648,"uniqueKey":"promo_code.coupon.amount_off.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code.coupon.amount_off","typeLabel":"integer\u003cint32> | null"},"applies_to":{"oneOf":[{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["products"],"example":{"products":["fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"]},"properties":{"products":{"description":"The product that this coupon applies to.","type":"array","items":{"type":"string","example":"fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"promo_code.coupon.applies_to.oneOf.0.products.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"promo_code.coupon.applies_to.oneOf.0.products","typeLabel":"string[]"}},"uniqueKey":"promo_code.coupon.applies_to.oneOf.0","typeLabel":"object"},{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["prices"],"properties":{"prices":{"description":"The price that this coupon applies to.","type":"array","items":{"type":"string","example":"fprice_01J9XR8M3K7VZ8N2YB4WJ6T0RA","uniqueKey":"promo_code.coupon.applies_to.oneOf.1.prices.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"promo_code.coupon.applies_to.oneOf.1.prices","typeLabel":"string[]"}},"uniqueKey":"promo_code.coupon.applies_to.oneOf.1","typeLabel":"object"},{"type":"object","description":"An object containing the ID of the product that the coupon can be applied to.","required":["fee_types"],"properties":{"fee_types":{"description":"The fee types that this coupon applies to.","type":"array","items":{"description":"The kind of fee applied to a checkout session: a Letter of Medical Necessity consultation fee, or a custom fee you define.","type":"string","enum":["lmn_consultation","custom"],"example":"lmn_consultation","uniqueKey":"promo_code.coupon.applies_to.oneOf.2.fee_types.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"promo_code.coupon.applies_to.oneOf.2.fee_types","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"promo_code.coupon.applies_to.oneOf.2","typeLabel":"object"},{"type":"string","description":"An object containing the ID of the product that the coupon can be applied to.","enum":["shipping"],"example":{"products":["fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA"]},"uniqueKey":"promo_code.coupon.applies_to.oneOf.3","typeLabel":"enum\u003cstring>"},{"type":"null","description":"An object containing the ID of the product that the coupon can be applied to.","uniqueKey":"promo_code.coupon.applies_to.oneOf.4","typeLabel":"null"}],"uniqueKey":"promo_code.coupon.applies_to","typeLabel":"object · object · object · enum\u003cstring> · null"},"duration_in_months":{"oneOf":[{"description":"If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"promo_code.coupon.duration_in_months.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"promo_code.coupon.duration_in_months.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code.coupon.duration_in_months","typeLabel":"integer\u003cint32> | null"},"metadata":{"oneOf":[{"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"object","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"promo_code.coupon.metadata.oneOf.0","typeLabel":"object"},{"description":"Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","type":"null","example":{"order_id":"8842","channel":"shopify"},"uniqueKey":"promo_code.coupon.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code.coupon.metadata","typeLabel":"object | null"},"percent_off":{"oneOf":[{"description":"Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.","type":"number","format":"double","uniqueKey":"promo_code.coupon.percent_off.oneOf.0","typeLabel":"number\u003cdouble>"},{"description":"Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.","type":"null","format":"double","uniqueKey":"promo_code.coupon.percent_off.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code.coupon.percent_off","typeLabel":"number\u003cdouble> | null"},"max_redemptions":{"oneOf":[{"description":"Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"promo_code.coupon.max_redemptions.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"promo_code.coupon.max_redemptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code.coupon.max_redemptions","typeLabel":"integer\u003cint32> | null"},"times_redeemed":{"oneOf":[{"description":"Number of times this coupon has been applied to a customer.","type":"integer","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"promo_code.coupon.times_redeemed.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"Number of times this coupon has been applied to a customer.","type":"null","format":"int32","maximum":2147483647,"minimum":-2147483648,"uniqueKey":"promo_code.coupon.times_redeemed.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code.coupon.times_redeemed","typeLabel":"integer\u003cint32> | null"}},"example":{"coupon_id":"fcoup_1234567890","amount_off":100,"applies_to":null,"duration":"once","duration_in_months":null,"metadata":{"key":"value"},"name":"Coupon","percent_off":10,"max_redemptions":100,"times_redeemed":0,"valid":true,"created_at":"2024-05-17T14:59:21Z","test_mode":true},"isRequired":true,"uniqueKey":"promo_code.coupon","typeLabel":"object"},"times_redeemed":{"description":"The number of times the promo code has been redeemed.","type":"integer","format":"int32","example":0,"minimum":-2147483648,"maximum":2147483647,"isRequired":true,"uniqueKey":"promo_code.times_redeemed","typeLabel":"integer\u003cint32>"},"created_at":{"description":"The date and time the promo code was created.","type":"string","example":"2024-05-17T14:59:21Z","isRequired":true,"uniqueKey":"promo_code.created_at","typeLabel":"string"},"active":{"description":"Whether the promo code is currently active.","type":"boolean","example":true,"isRequired":true,"uniqueKey":"promo_code.active","typeLabel":"boolean"},"test_mode":{"description":"Whether the promo code is in test mode.","type":"boolean","example":false,"isRequired":true,"uniqueKey":"promo_code.test_mode","typeLabel":"boolean"},"max_redemptions":{"oneOf":[{"description":"The number of times the promo code can be redeemed.","type":"integer","format":"int32","maximum":2147483647,"example":100,"minimum":-2147483648,"uniqueKey":"promo_code.max_redemptions.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"The number of times the promo code can be redeemed.","type":"null","format":"int32","maximum":2147483647,"example":100,"minimum":-2147483648,"uniqueKey":"promo_code.max_redemptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code.max_redemptions","typeLabel":"integer\u003cint32> | null"},"customer":{"oneOf":[{"description":"The customer that can be associated with the promo code. If null, the promo code can be redeemed by any customer.","type":"string","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","uniqueKey":"promo_code.customer.oneOf.0","typeLabel":"string"},{"description":"The customer that can be associated with the promo code. If null, the promo code can be redeemed by any customer.","type":"null","example":"fcus_01HACM7FZ1084XB1GB6053VM0D","uniqueKey":"promo_code.customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code.customer","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Metadata associated with the promo code.","type":"object","example":{"key":"value"},"uniqueKey":"promo_code.metadata.oneOf.0","typeLabel":"object"},{"description":"Metadata associated with the promo code.","type":"null","example":{"key":"value"},"uniqueKey":"promo_code.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"promo_code.metadata","typeLabel":"object | null"}},"example":{"promo_code_id":"fpromo_01HACM7FZ1084XB1GB6053VM0E","code":"SUMMER2016","coupon":{"coupon_id":"fcoup_1234567890","amount_off":100,"applies_to":null,"duration":"once","duration_in_months":null,"metadata":{"key":"value"},"name":"Coupon","percent_off":10,"max_redemptions":100,"times_redeemed":0,"valid":true,"created_at":"2024-05-17T14:59:21Z","test_mode":true},"max_redemptions":100,"times_redeemed":0,"created_at":"2024-05-17T14:59:21Z","customer":"fcus_01HACM7FZ1084XB1GB6053VM0D","active":true,"metadata":{"key":"value"},"test_mode":false},"isRequired":true,"uniqueKey":"promo_code","typeLabel":"object"}},"example":{"promo_code":{"promo_code_id":"fpromo_01HACM7FZ1084XB1GB6053VM0E","code":"SUMMER2016","coupon":{"coupon_id":"fcoup_1234567890","amount_off":100,"applies_to":null,"duration":"once","duration_in_months":null,"metadata":{"key":"value"},"name":"Coupon","percent_off":10,"max_redemptions":100,"times_redeemed":0,"valid":true,"created_at":"2024-05-17T14:59:21Z","test_mode":true},"max_redemptions":100,"times_redeemed":0,"created_at":"2024-05-17T14:59:21Z","customer":"fcus_01HACM7FZ1084XB1GB6053VM0D","active":true,"metadata":{"key":"value"},"test_mode":false}},"uniqueKey":"","typeLabel":"object"},"example":{"promo_code":{"promo_code_id":"fpromo_01HACM7FZ1084XB1GB6053VM0E","code":"SUMMER2016","coupon":{"coupon_id":"fcoup_1234567890","amount_off":100,"applies_to":null,"duration":"once","duration_in_months":null,"metadata":{"key":"value"},"name":"Coupon","percent_off":10,"max_redemptions":100,"times_redeemed":0,"valid":true,"created_at":"2024-05-17T14:59:21Z","test_mode":true},"max_redemptions":100,"times_redeemed":0,"created_at":"2024-05-17T14:59:21Z","customer":"fcus_01HACM7FZ1084XB1GB6053VM0D","active":true,"metadata":{"key":"value"},"test_mode":false}},"examples":{"Example":{"title":"Example","value":{"promo_code":{"promo_code_id":"fpromo_01HACM7FZ1084XB1GB6053VM0E","code":"SUMMER2016","coupon":{"coupon_id":"fcoup_1234567890","amount_off":100,"applies_to":null,"duration":"once","duration_in_months":null,"metadata":{"key":"value"},"name":"Coupon","percent_off":10,"max_redemptions":100,"times_redeemed":0,"valid":true,"created_at":"2024-05-17T14:59:21Z","test_mode":true},"max_redemptions":100,"times_redeemed":0,"created_at":"2024-05-17T14:59:21Z","customer":"fcus_01HACM7FZ1084XB1GB6053VM0D","active":true,"metadata":{"key":"value"},"test_mode":false}}}},"exampleType":"examples"}},"exampleType":"examples"},"816944ec-9d21-4b10-ad24-0a1d5596515c":{"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"},"e9749af3-5ac8-45c2-aa40-6ec0f42dcfab":{"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"},"af41aa04-8472-481a-b40a-168b5e4832a8":{"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"},"8dd4cf79-dfb8-4a63-878b-da495ec186d7":{"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"},"96c30a6c-30ce-4df1-bc10-d4184b7bb276":{"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"},"d7237f89-a252-4d9b-9526-74504fc03363":{"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":{"cd75af42-2973-418c-b620-f2e30c7c2099":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Use a Bearer token to access this API.","scopes":["promo_codes:write"],"schemeName":"BearerAuth"}}},"servers":{"080577c1-39a5-4498-bb49-d7daab803f21":{"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":["promo_codes: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 Promo Code - Flex Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T22:54:20.659Z","originalFileLocation":"api-reference/promo-codes/create-promo-code.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 promotion code referencing an existing coupon. If code is omitted, a unique code is generated automatically. The supplied code must be unique across your promotion codes.\">\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 Promo Code - Flex Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a promotion code referencing an existing coupon. If code is omitted, a unique code is generated automatically. The supplied code must be unique across your promotion codes.\">\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/promo-codes/create-promo-code\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flex-87.mintlify.app/_mintlify/api/og/v2?division=Promo+Codes\u0026amp;title=Create+Promo+Code\u0026amp;description=Creates+a+promotion+code+referencing+an+existing+coupon.+If+%60code%60+is+omitted%2C+a+unique%0Acode+is+generated+automatically.+The+supplied+%60code%60+must+be+unique+acro\u0026amp;theme=166c4e73f0167deeef40f76e\u0026amp;signature=588c0597ede91842ce5568c786ee6ba985776cfe1f8ecbf6897f333e05a1369c\">\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 Promo Code - Flex Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a promotion code referencing an existing coupon. If code is omitted, a unique code is generated automatically. The supplied code must be unique across your promotion codes.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flex-87.mintlify.app/_mintlify/api/og/v2?division=Promo+Codes\u0026amp;title=Create+Promo+Code\u0026amp;description=Creates+a+promotion+code+referencing+an+existing+coupon.+If+%60code%60+is+omitted%2C+a+unique%0Acode+is+generated+automatically.+The+supplied+%60code%60+must+be+unique+acro\u0026amp;theme=166c4e73f0167deeef40f76e\u0026amp;signature=588c0597ede91842ce5568c786ee6ba985776cfe1f8ecbf6897f333e05a1369c\">\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/promo-codes/create-promo-code\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/promo-codes/create-promo-code.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/promo-codes/create-promo-code#webpage\",\"url\":\"https://docs.withflex.com/api-reference/promo-codes/create-promo-code\",\"name\":\"Create Promo Code\",\"description\":\"Creates a promotion code referencing an existing coupon. If code is omitted, a unique code is generated automatically. The supplied code must be unique across your promotion codes.\",\"dateModified\":\"2026-10-28T22:54:20.659Z\",\"isPartOf\":{\"@id\":\"https://docs.withflex.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.withflex.com/api-reference/promo-codes/create-promo-code#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.withflex.com/api-reference/promo-codes/create-promo-code#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\":\"Promo Codes\",\"item\":\"https://docs.withflex.com/api-reference/promo-codes/list-promo-codes\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Promo Code\",\"item\":\"https://docs.withflex.com/api-reference/promo-codes/create-promo-code\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.withflex.com/api-reference/promo-codes/create-promo-code#apireference\",\"headline\":\"Create Promo Code\",\"name\":\"Create Promo Code\",\"description\":\"Creates a promotion code referencing an existing coupon. If code is omitted, a unique code is generated automatically. The supplied code must be unique across your promotion codes.\",\"url\":\"https://docs.withflex.com/api-reference/promo-codes/create-promo-code\",\"mainEntityOfPage\":{\"@id\":\"https://docs.withflex.com/api-reference/promo-codes/create-promo-code#webpage\"},\"dateModified\":\"2026-10-28T22:54:20.659Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","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","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","description":"Returns a list of your promotion codes. Optionally filter by `active`.","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","description":"Retrieves a promotion code by its ID.","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 Promo Code - Flex Documentation","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}