Explore the Flexprice API interactively: the built-in playground on this site, or a local Swagger UI against the spec or a self-hosted instance
You do not need to run anything to try the API. Every endpoint page in the API Reference has a playground: choose the region, paste an API key, edit the body, and send. This page covers running Swagger UI yourself for cases the playground does not reach, such as a self-hosted deployment on a private network or a spec build from a branch.
A self-hosted Flexprice backend ships the same spec at docs/swagger/swagger-3-0.json in the repository. Serve Swagger UI next to it and point the server URL at your deployment:
Then in the UI, replace the server with http://localhost:8080/v1 (or your host) using the Servers dropdown’s editable field. If the browser blocks the request, the backend’s CORS setting needs to include the Swagger UI origin. See Configuration.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Flexprice","colors":{"primary":"#15547c","light":"#2580b5","dark":"#134a6b"},"logo":{"light":"https://mintcdn.com/flexprice/Qokjirde4CQUcFy8/images/FlexpriceWordMarkDark.png?fit=max\u0026auto=format\u0026n=Qokjirde4CQUcFy8\u0026q=85\u0026s=d706a1b6139418c2d57ba902fb0b6de4","dark":"https://mintcdn.com/flexprice/Qokjirde4CQUcFy8/images/FlexpriceWordMarkLight.png?fit=max\u0026auto=format\u0026n=Qokjirde4CQUcFy8\u0026q=85\u0026s=3fe3d9881552f4ebecb6f6aa7cfe2f66"},"favicon":"https://mintcdn.com/flexprice/Qokjirde4CQUcFy8/doc.png?fit=max\u0026auto=format\u0026n=Qokjirde4CQUcFy8\u0026q=85\u0026s=7e9ab0952b828b96d03f9298571462a4","api":{"examples":{"languages":["curl","python","typescript","go"]}},"background":{"decoration":"gradient","color":{"light":"#fffdf8","dark":"#010b13"}},"navbar":{"links":[],"primary":{"type":"button","label":"Dashboard","href":"https://admin.flexprice.io/"}},"footer":{"socials":{"github":"https://github.com/flexprice/flexprice","linkedin":"https://www.linkedin.com/company/flexpriceio","website":"https://flexprice.io/","x":"https://x.com/tryflexprice"}},"fonts":{"family":"Geist"},"integrations":{"ga4":{"measurementId":"G-9RV8NDCXNN"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Support","icon":"https://mintlify.s3.us-west-1.amazonaws.com/flexprice/images/anchors/mail.svg","href":"mailto:support@flexprice.io"},{"anchor":"Community","icon":"https://mintlify.s3.us-west-1.amazonaws.com/flexprice/images/anchors/slack.svg","href":"https://join.slack.com/t/flexpricecommunity/shared_invite/zt-39uat51l0-n8JmSikHZP~bHJNXladeaQ"},{"anchor":"Website","icon":"https://mintlify.s3.us-west-1.amazonaws.com/flexprice/images/anchors/flexprice.svg","href":"https://flexprice.io/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flexprice","hasAudioNarration":false,"actualSubdomain":"flexprice","customDomains":["docs.flexprice.io"],"gitSource":{"type":"github","owner":"flexprice","repo":"flexprice-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":false,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af17c40913e4653b1c1b824","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":339},{"language":"default","tag":"Resources","count":336},{"language":"default","tag":"Developers","count":152},{"language":"default","tag":"Documentation","count":125},{"language":"default","tag":"Integrations","count":102},{"language":"default","tag":"Webhook Events","count":72},{"language":"default","tag":"Subscriptions","count":46},{"language":"default","tag":"CLI","count":38},{"language":"default","tag":"Command reference","count":34},{"language":"default","tag":"Customers","count":25}]},"assistantConfig":{"enableStarterQuestions":false,"deflection":{"enabled":true,"email":"support@flexprice.io","showHelpButton":true}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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":"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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* latin-ext */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu6-K6h9Q.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu0-K4.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* latin-ext */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu6-K6h9Q.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu0-K4.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* latin-ext */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu6-K6h9Q.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu0-K4.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* latin-ext */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu6-K6h9Q.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'DM Sans';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/dmsans/v17/rP2Yp2ywxg089UriI5-g4vlH9VoD8Cmcqbu0-K4.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\nh1{font-family:'DM Sans', sans-serif;font-weight:700!important;letter-spacing:-0.01em!important}.title,[data-title],.page-title,.section-title{font-family:'DM Sans', sans-serif;font-weight:400;letter-spacing:0.025em!important}.nav-logo{height:22px}[class*=\"nav\"] a[href*=\"admin.flexprice.io\"],[class*=\"Navbar\"] a[href*=\"admin.flexprice.io\"]{background-color:#134a6b!important;color:#ffffff!important;font-weight:500;border-radius:6px;padding:0.5rem 1rem}[class*=\"nav\"] a[href*=\"admin.flexprice.io\"]:hover,[class*=\"Navbar\"] a[href*=\"admin.flexprice.io\"]:hover{background-color:#0d3d5c!important;color:#ffffff!important}.content-area,.\\32xl\\:max-w-2xl{max-width:50rem!important}.nav-anchor:hover>div{background-color:rgba(21, 84, 124, 0.08)!important}.dark .nav-anchor:hover>div{background-color:rgba(255, 255, 255, 0.08)!important}.nav-anchor img{background-color:transparent!important}.dark .nav-anchor img[src*=\"anchors/flexprice\"]{filter:brightness(0) invert(1)}"}],"page":{"pagePath":"developers/api-tooling/swagger-ui","slug":"/developers/api-tooling/swagger-ui","pageMetadata":{"title":"Swagger UI","description":"Explore the Flexprice API interactively: the built-in playground on this site, or a local Swagger UI against the spec or a self-hosted instance","href":"/developers/api-tooling/swagger-ui"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Explore the Flexprice API interactively: the built-in playground on this site, or a local Swagger UI against the spec or a self-hosted instance\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Card,CardGroup,CodeBlock,Heading,Table,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`You do not need to run anything to try the API. Every endpoint page in the `,_jsx(_components.a,{href:`/api-reference/introduction`,children:`API Reference`}),` has a playground: choose the region, paste an API key, edit the body, and send. This page covers running Swagger UI yourself for cases the playground does not reach, such as a self-hosted deployment on a private network or a spec build from a branch.`]}),`\n`,_jsx(Heading,{level:`2`,id:`run-swagger-ui-locally`,children:`Run Swagger UI locally`}),`\n`,_jsx(_components.p,{children:`Swagger UI is a static site that renders any OpenAPI document. Run it in Docker against the published spec:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -sSL`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://swagger.flexprice.io`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -o`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` flexprice-openapi.json`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`docker`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --rm`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -p`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 8081:8080`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -e`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` SWAGGER_JSON=/spec/flexprice-openapi.json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -v`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$PWD`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`:/spec\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` swaggerapi/swagger-ui`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Open `,_jsx(_components.code,{children:`http://localhost:8081`}),`, click `,_jsx(_components.strong,{children:`Authorize`}),`, and enter your API key for `,_jsx(_components.code,{children:`ApiKeyAuth`}),`. The `,_jsx(_components.strong,{children:`Servers`}),` dropdown lists the US and India regions from the spec.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Requests from a local Swagger UI go straight to the Flexprice API with your key. Use a sandbox key while exploring.`})}),`\n`,_jsx(Heading,{level:`2`,id:`running-swagger-ui-against-a-self-hosted-instance`,children:`Running Swagger UI against a self-hosted instance`}),`\n`,_jsxs(_components.p,{children:[`A self-hosted Flexprice backend ships the same spec at `,_jsx(_components.code,{children:`docs/swagger/swagger-3-0.json`}),` in the repository. Serve Swagger UI next to it and point the server URL at your deployment:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`docker`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` run`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --rm`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -p`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 8081:8080`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -e`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` SWAGGER_JSON=/spec/swagger-3-0.json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -v`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$PWD`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/docs/swagger:/spec\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` swaggerapi/swagger-ui`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Then in the UI, replace the server with `,_jsx(_components.code,{children:`http://localhost:8080/v1`}),` (or your host) using the `,_jsx(_components.strong,{children:`Servers`}),` dropdown’s editable field. If the browser blocks the request, the backend’s CORS setting needs to include the Swagger UI origin. See `,_jsx(_components.a,{href:`/docs/getting-started/configuration`,children:`Configuration`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`swagger-ui-postman-or-the-api-reference`,children:`Swagger UI, Postman, or the API reference?`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Tool`}),_jsx(_components.th,{children:`Best for`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`API Reference playground`}),_jsx(_components.td,{children:`Trying Flexprice Cloud endpoints with no setup`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Swagger UI`}),_jsx(_components.td,{children:`Self-hosted deployments, branch builds of the spec, air-gapped networks`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/developers/api-tooling/postman`,children:`Postman`})}),_jsx(_components.td,{children:`Saved requests, environments per region, sharing with a team`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/docs/cli/overview`,children:`CLI`})}),_jsx(_components.td,{children:`Scripting and anything you want to repeat`})]})]})]}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{icon:`https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/openapi.svg?fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=86c60dde91a4f53efc99608d54c919d0`,title:`OpenAPI spec`,href:`/developers/api-tooling/openapi-spec`,\"data-og-width\":`32`,width:`32`,\"data-og-height\":`32`,height:`32`,\"data-path\":`images/developers/icons/openapi.svg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/openapi.svg?w=280\u0026fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=2ced3b8e72437a88ae47d40fe9d70101 280w, https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/openapi.svg?w=560\u0026fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=4b718285f5f8159e21a1278fd1bec391 560w, https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/openapi.svg?w=840\u0026fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=fcf19765c287a580a8ab709b2f0fe9ff 840w, https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/openapi.svg?w=1100\u0026fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=c4788829e06412f72bbbebf8269ad68e 1100w, https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/openapi.svg?w=1650\u0026fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=d931f5d8d2c92a1a519b9031240fa083 1650w, https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/openapi.svg?w=2500\u0026fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=3c171583f3df4e4e43ab61790a65b00e 2500w`}),_jsx(Card,{icon:`https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/server.svg?fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=72538ffa0b9dbc84bc1ddc60f0d0a266`,title:`Self-hosting guide`,href:`/docs/getting-started/self-hosting-guide`,\"data-og-width\":`32`,width:`32`,\"data-og-height\":`32`,height:`32`,\"data-path\":`images/developers/icons/server.svg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/server.svg?w=280\u0026fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=ab8929b1dee00c6551521a9a6939d997 280w, https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/server.svg?w=560\u0026fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=4b4b80b5989e86dc8ec46c849775156c 560w, https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/server.svg?w=840\u0026fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=d372c4d0d148870da3f1e240e5ca2d5e 840w, https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/server.svg?w=1100\u0026fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=780e367f19db66cccaa490cd6b9b181e 1100w, https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/server.svg?w=1650\u0026fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=5b51348da760c46878c2d4648eacdfd2 1650w, https://mintcdn.com/flexprice/G4Mu88HxYrwMrXoR/images/developers/icons/server.svg?w=2500\u0026fit=max\u0026auto=format\u0026n=G4Mu88HxYrwMrXoR\u0026q=85\u0026s=67217e5a09bdbc58f467a864cdf94669 2500w`})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Swagger UI","description":"Explore the Flexprice API interactively: the built-in playground on this site, or a local Swagger UI against the spec or a self-hosted instance","href":"/developers/api-tooling/swagger-ui"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Run Swagger UI locally","slug":"run-swagger-ui-locally","depth":2,"children":[]},{"title":"Running Swagger UI against a self-hosted instance","slug":"running-swagger-ui-against-a-self-hosted-instance","depth":2,"children":[]},{"title":"Swagger UI, Postman, or the API reference?","slug":"swagger-ui-postman-or-the-api-reference","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/flexprice/c6cd5bf06bcd0181/reo-tracking.js"],"subdomain":"flexprice","siteName":"Flexprice","title":"Swagger UI - Flexprice","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T03:57:10.744Z","originalFileLocation":"developers/api-tooling/swagger-ui.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=\"Explore the Flexprice API interactively: the built-in playground on this site, or a local Swagger UI against the spec or a self-hosted instance\">\u003cmeta data-mint-head name=\"application-name\" content=\"Flexprice\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_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/flexprice/7xM46OYu1enH2rig/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Swagger UI - Flexprice\">\u003cmeta data-mint-head property=\"og:description\" content=\"Explore the Flexprice API interactively: the built-in playground on this site, or a local Swagger UI against the spec or a self-hosted instance\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Flexprice\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.flexprice.io/developers/api-tooling/swagger-ui\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flexprice.mintlify.site/_mintlify/api/og/v2?division=API+tooling\u0026amp;title=Swagger+UI\u0026amp;description=Explore+the+Flexprice+API+interactively%3A+the+built-in+playground+on+this+site%2C+or+a+local+Swagger+UI+against+the+spec+or+a+self-hosted+instance\u0026amp;theme=792146983879b831a3a27cee\u0026amp;signature=f4388d64e90f703b34d9e9af5ea4a5e8904ab62204b620414c3315abba2873e7\">\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=\"Swagger UI - Flexprice\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Explore the Flexprice API interactively: the built-in playground on this site, or a local Swagger UI against the spec or a self-hosted instance\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flexprice.mintlify.site/_mintlify/api/og/v2?division=API+tooling\u0026amp;title=Swagger+UI\u0026amp;description=Explore+the+Flexprice+API+interactively%3A+the+built-in+playground+on+this+site%2C+or+a+local+Swagger+UI+against+the+spec+or+a+self-hosted+instance\u0026amp;theme=792146983879b831a3a27cee\u0026amp;signature=f4388d64e90f703b34d9e9af5ea4a5e8904ab62204b620414c3315abba2873e7\">\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/flexprice/7xM46OYu1enH2rig/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Flexprice\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#15547c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.flexprice.io/developers/api-tooling/swagger-ui\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/api-tooling/swagger-ui.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.flexprice.io/#organization\",\"name\":\"Flexprice\",\"url\":\"https://docs.flexprice.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/flexprice/Qokjirde4CQUcFy8/images/FlexpriceWordMarkDark.png?fit=max\u0026auto=format\u0026n=Qokjirde4CQUcFy8\u0026q=85\u0026s=d706a1b6139418c2d57ba902fb0b6de4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.flexprice.io#website\",\"name\":\"Flexprice\",\"url\":\"https://docs.flexprice.io\",\"publisher\":{\"@id\":\"https://docs.flexprice.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.flexprice.io/developers/api-tooling/swagger-ui#webpage\",\"url\":\"https://docs.flexprice.io/developers/api-tooling/swagger-ui\",\"name\":\"Swagger UI\",\"description\":\"Explore the Flexprice API interactively: the built-in playground on this site, or a local Swagger UI against the spec or a self-hosted instance\",\"dateModified\":\"2026-10-14T03:57:10.744Z\",\"isPartOf\":{\"@id\":\"https://docs.flexprice.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.flexprice.io/developers/api-tooling/swagger-ui#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.flexprice.io/developers/api-tooling/swagger-ui#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Developers\",\"item\":\"https://docs.flexprice.io/developers/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API tooling\",\"item\":\"https://docs.flexprice.io/developers/api-tooling/openapi-spec\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Swagger UI\",\"item\":\"https://docs.flexprice.io/developers/api-tooling/swagger-ui\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.flexprice.io/developers/api-tooling/swagger-ui#article\",\"headline\":\"Swagger UI\",\"name\":\"Swagger UI\",\"description\":\"Explore the Flexprice API interactively: the built-in playground on this site, or a local Swagger UI against the spec or a self-hosted instance\",\"url\":\"https://docs.flexprice.io/developers/api-tooling/swagger-ui\",\"mainEntityOfPage\":{\"@id\":\"https://docs.flexprice.io/developers/api-tooling/swagger-ui#webpage\"},\"dateModified\":\"2026-10-14T03:57:10.744Z\",\"publisher\":{\"@id\":\"https://docs.flexprice.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.flexprice.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Flexprice\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Flexprice","nav":{"global":{"anchors":[{"anchor":"Support","icon":"https://mintlify.s3.us-west-1.amazonaws.com/flexprice/images/anchors/mail.svg","href":"mailto:support@flexprice.io"},{"anchor":"Community","icon":"https://mintlify.s3.us-west-1.amazonaws.com/flexprice/images/anchors/slack.svg","href":"https://join.slack.com/t/flexpricecommunity/shared_invite/zt-39uat51l0-n8JmSikHZP~bHJNXladeaQ"},{"anchor":"Website","icon":"https://mintlify.s3.us-west-1.amazonaws.com/flexprice/images/anchors/flexprice.svg","href":"https://flexprice.io/"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/welcome-to-flexprice"}]},{"tab":"Cookbooks","pages":[{"title":"Cookbooks","href":"/cookbooks/billing-recipes/usage-based-pricing"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"Developers","groups":[{"group":"Developers","pages":[{"title":"Developer Hub","mode":"wide","href":"/developers/overview"},{"title":"API reference","href":"/developers/api-reference"},{"group":"AI and agents","pages":[{"title":"Model Context Protocol (MCP)","href":"/docs/connect/mcp-server"},{"group":"Flexprice for Slack","root":{"title":"Flexprice for Slack","href":"/developers/ai/slack/overview"},"pages":[{"title":"Install and connect the Slack app","href":"/developers/ai/slack/install-and-connect"},{"title":"Ask billing questions in Slack","href":"/developers/ai/slack/ask-questions"},{"title":"Confirm changes from Slack","href":"/developers/ai/slack/confirm-changes"},{"title":"Slack app security and privacy","href":"/developers/ai/slack/security-and-privacy"},{"title":"Troubleshoot the Slack app","href":"/developers/ai/slack/troubleshooting"}]},{"title":"Agent Skills","href":"/developers/ai/agent-skills"}]},{"group":"SDKs","root":{"title":"SDKs","href":"/developers/sdks/overview"},"pages":[{"title":"Using the SDKs","href":"/developers/sdks/usage"},{"title":"Example app","href":"/developers/sdks/example-app"}]},{"group":"UI kit","root":{"title":"UI Kit","href":"/docs/exportable-ui/overview"},"pages":[{"title":"Install the UI kit","href":"/developers/frontend/install"},{"title":"Fetch entitlements and usage on the client","href":"/developers/frontend/fetch-entitlements-and-usage"},{"title":"Harden client-side access","href":"/developers/frontend/harden-client-access"},{"title":"Storybook","href":"/developers/frontend/storybook"},{"group":"Components","pages":[{"group":"Pricing","pages":[{"title":"Pricing Table","href":"/docs/exportable-ui/pricing-widget/pricing-table"},{"title":"Pricing Card","href":"/docs/exportable-ui/pricing-widget/pricing-card"}]},{"group":"Usage Widgets","root":{"title":"Usage Widgets","href":"/docs/exportable-ui/usage-widgets/usage-widgets"},"pages":[{"title":"Metric Cards","href":"/docs/exportable-ui/usage-widgets/metric-cards"},{"title":"Usage Trend Chart","href":"/docs/exportable-ui/usage-widgets/usage-trend-chart"},{"title":"Usage Breakdown","href":"/docs/exportable-ui/usage-widgets/usage-breakdown"},{"title":"Usage Quota","href":"/docs/exportable-ui/usage-widgets/usage-quota"}]},{"group":"Credits Widgets","root":{"title":"Credits Widgets","href":"/docs/exportable-ui/credits-widgets/credits-widgets"},"pages":[{"title":"Credit Balance","href":"/docs/exportable-ui/credits-widgets/credit-balance"},{"title":"Credit History","href":"/docs/exportable-ui/credits-widgets/credit-history"}]}]}]},{"group":"CLI","root":{"title":"Flexprice CLI","href":"/docs/cli/overview"},"pages":[{"title":"Quickstart","href":"/docs/cli/quickstart"},{"title":"Authentication","href":"/docs/cli/authentication"},{"title":"Global flags","href":"/docs/cli/global-flags"},{"title":"Output \u0026 scripting","href":"/docs/cli/output-and-scripting"},{"group":"Command reference","root":{"title":"CLI Command Reference","href":"/docs/cli-reference/overview"},"pages":[{"group":"Catalog","pages":[{"title":"Plans CLI Commands","sidebarTitle":"Plans","href":"/docs/cli-reference/resources/plans"},{"title":"Prices CLI Commands","sidebarTitle":"Prices","href":"/docs/cli-reference/resources/prices"},{"title":"Price Units CLI Commands","sidebarTitle":"Price Units","href":"/docs/cli-reference/resources/price-units"},{"title":"Features CLI Commands","sidebarTitle":"Features","href":"/docs/cli-reference/resources/features"},{"title":"Entitlements CLI Commands","sidebarTitle":"Entitlements","href":"/docs/cli-reference/resources/entitlements"},{"title":"Addons CLI Commands","sidebarTitle":"Addons","href":"/docs/cli-reference/resources/addons"},{"title":"Coupons CLI Commands","sidebarTitle":"Coupons","href":"/docs/cli-reference/resources/coupons"},{"title":"Coupon Associations CLI Commands","sidebarTitle":"Coupon Associations","href":"/docs/cli-reference/resources/coupon-associations"},{"title":"Credit Grants CLI Commands","sidebarTitle":"Credit Grants","href":"/docs/cli-reference/resources/credit-grants"},{"title":"Groups CLI Commands","sidebarTitle":"Groups","href":"/docs/cli-reference/resources/groups"},{"title":"Tax Rates CLI Commands","sidebarTitle":"Tax Rates","href":"/docs/cli-reference/resources/tax-rates"},{"title":"Tax Associations CLI Commands","sidebarTitle":"Tax Associations","href":"/docs/cli-reference/resources/tax-associations"}]},{"group":"Customers and subscriptions","pages":[{"title":"Customers CLI Commands","sidebarTitle":"Customers","href":"/docs/cli-reference/resources/customers"},{"title":"Subscriptions CLI Commands","sidebarTitle":"Subscriptions","href":"/docs/cli-reference/resources/subscriptions"},{"title":"Subscription Line Items CLI Commands","sidebarTitle":"Subscription Line Items","href":"/docs/cli-reference/resources/subscription-line-items"},{"title":"Subscription Schedules CLI Commands","sidebarTitle":"Subscription Schedules","href":"/docs/cli-reference/resources/subscription-schedules"},{"title":"Wallets CLI Commands","sidebarTitle":"Wallets","href":"/docs/cli-reference/resources/wallets"},{"title":"Alert Settings CLI Commands","sidebarTitle":"Alert Settings","href":"/docs/cli-reference/resources/alert-settings"},{"title":"Alerts CLI Commands","sidebarTitle":"Alerts","href":"/docs/cli-reference/resources/alerts"}]},{"group":"Billing","pages":[{"title":"Events CLI Commands","sidebarTitle":"Events","href":"/docs/cli-reference/resources/events"},{"title":"Invoices CLI Commands","sidebarTitle":"Invoices","href":"/docs/cli-reference/resources/invoices"},{"title":"Credit Notes CLI Commands","sidebarTitle":"Credit Notes","href":"/docs/cli-reference/resources/credit-notes"},{"title":"Payments CLI Commands","sidebarTitle":"Payments","href":"/docs/cli-reference/resources/payments"},{"title":"Checkout CLI Commands","sidebarTitle":"Checkout","href":"/docs/cli-reference/resources/checkout"},{"title":"Costs CLI Commands","sidebarTitle":"Costs","href":"/docs/cli-reference/resources/costs"}]},{"group":"Platform","pages":[{"title":"Environments CLI Commands","sidebarTitle":"Environments","href":"/docs/cli-reference/resources/environments"},{"title":"Integrations CLI Commands","sidebarTitle":"Integrations","href":"/docs/cli-reference/resources/integrations"},{"title":"RBAC CLI Commands","sidebarTitle":"RBAC","href":"/docs/cli-reference/resources/rbac"},{"title":"Scheduled Tasks CLI Commands","sidebarTitle":"Scheduled Tasks","href":"/docs/cli-reference/resources/scheduled-tasks"},{"title":"Secrets CLI Commands","sidebarTitle":"Secrets","href":"/docs/cli-reference/resources/secrets"},{"title":"Tasks CLI Commands","sidebarTitle":"Tasks","href":"/docs/cli-reference/resources/tasks"},{"title":"Tenants CLI Commands","sidebarTitle":"Tenants","href":"/docs/cli-reference/resources/tenants"},{"title":"Users CLI Commands","sidebarTitle":"Users","href":"/docs/cli-reference/resources/users"},{"title":"Workflows CLI Commands","sidebarTitle":"Workflows","href":"/docs/cli-reference/resources/workflows"}]}]}]},{"group":"API tooling","pages":[{"title":"OpenAPI spec","href":"/developers/api-tooling/openapi-spec"},{"title":"Postman collection","description":"Import the Flexprice OpenAPI document into Postman and configure an environment for each region and API key","href":"/developers/api-tooling/postman"},{"title":"Swagger UI","href":"/developers/api-tooling/swagger-ui"}]},{"group":"Webhooks","root":{"title":"Webhooks","description":"How Flexprice webhooks deliver invoice, payment, subscription, wallet, and usage events to your systems","href":"/docs/webhook/webhooks"},"pages":[{"title":"Set up an endpoint","href":"/developers/webhooks/set-up-an-endpoint"},{"title":"Signature verification","href":"/developers/webhooks/signature-verification"},{"title":"Retries and ordering","href":"/developers/webhooks/retries-and-ordering"},{"title":"Test webhooks locally","href":"/developers/webhooks/test-locally"},{"title":"Event catalog","mode":"wide","href":"/developers/webhooks/event-catalog"}]},{"group":"Support","pages":[{"title":"Troubleshooting hub","href":"/developers/troubleshooting"},{"title":"Status page and trust centre","href":"/developers/status-and-trust"}]},{"group":"Open source","pages":[{"group":"Contributing guide","root":{"title":"Contributing Guide","href":"/docs/contributing-guide/introduction"},"pages":[{"title":"Project Architecture","href":"/docs/contributing-guide/architechture"},{"title":"Frontend Development Setup","href":"/docs/contributing-guide/frontend-setup"},{"title":"Backend Development Setup","href":"/docs/contributing-guide/backend-setup"},{"title":"Code of Conduct","href":"/docs/contributing-guide/code-of-contuct"}]},{"title":"Self-hosting","href":"/developers/self-hosting"}]}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/docs/changelog"}]}]},"basePath":"","title":"Swagger UI - Flexprice","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":[],"chunks":[]}
