Customer access token. Send it as Authorization: Bearer . Obtain it server side via POST /customers/{id}/authenticate (use the response accessToken), or from a customer portal session. The token must carry the customer:plan:switch permission.
Hints about side effects, for example that an active discount will not carry over.
Beispiel:
["active_discount_will_be_lost"]
War diese Seite hilfreich?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Fynn Docs","colors":{"primary":"#000","light":"#fff","dark":"#000"},"logo":{"light":"https://mintcdn.com/fynnsubscriptionbilling/kPbBeWVEZfmEic9q/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=kPbBeWVEZfmEic9q\u0026q=85\u0026s=83e4b30a53d77c3809e0f22afa29335d","dark":"https://mintcdn.com/fynnsubscriptionbilling/kPbBeWVEZfmEic9q/logo/dark.svg?fit=max\u0026auto=format\u0026n=kPbBeWVEZfmEic9q\u0026q=85\u0026s=5798319f6c8632d79fe789f72eaa94e2"},"favicon":"https://mintcdn.com/fynnsubscriptionbilling/zDQkHT5wBBQ3jA-O/favicon.svg?fit=max\u0026auto=format\u0026n=zDQkHT5wBBQ3jA-O\u0026q=85\u0026s=410ff1f698a399faed9fbb877457bb43","api":{"openapi":["assets/openapi.json","assets/openapi-v2-plans.json","assets/openapi-v2-offers.json","assets/openapi-v2-commission.json","assets/openapi-v2-payment-plans.json","assets/openapi-v2-finance.json"],"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript","php"]}},"navbar":{"links":[{"href":"https://cal.com/team/fynn/fynn-documentation","label":"Termin buchen"},{"href":"mailto:hi@fynn.eu","label":"Support"}],"primary":{"type":"button","label":"App Login","href":"https://app.fynn.eu"}},"footer":{"socials":{"x":"https://twitter.com/wearefynn","github":"https://github.com/fynn-digital","linkedin":"https://www.linkedin.com/company/wearefynn"}},"integrations":{"gtm":{"tagId":"GTM-NKGQ4TQ9"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"languages":[{"language":"de","default":true,"href":"introduction"},{"language":"en","href":"en/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fynnsubscriptionbilling","hasAudioNarration":false,"actualSubdomain":"fynnsubscriptionbilling","customDomains":["docs.fynn.eu"],"gitSource":{"type":"gitlab","owner":"fynn/core","repo":"core-api23","deployBranch":"main","contentDirectory":"public-docs","isPrivate":true,"projectId":396,"hostUrl":"https://git.netzfabrik.com","mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"REMOVE_BRANDING":{"status":"ENABLED"}},"buildId":"6af34a7b9e5c1288d03316fe","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"de","tag":"API Referenz","count":249},{"language":"de","tag":"Dokumentation","count":98},{"language":"de","tag":"API V2","count":71},{"language":"en","tag":"Documentation","count":64},{"language":"de","tag":"API","count":46},{"language":"de","tag":"Catalogue","count":42},{"language":"de","tag":"Angebote","count":36},{"language":"de","tag":"Subscription","count":30},{"language":"de","tag":"Customer","count":30},{"language":"de","tag":"Finanzberichte","count":29},{"language":"de","tag":"Payment","count":26},{"language":"default","tag":"API V2","count":18},{"language":"default","tag":"Dokumentation","count":15},{"language":"default","tag":"Pläne","count":15},{"language":"en","tag":"Integrations","count":15},{"language":"default","tag":"API","count":11},{"language":"default","tag":"API Referenz","count":10},{"language":"default","tag":"API documentation","count":10},{"language":"en","tag":"Products","count":9},{"language":"en","tag":"Settings","count":9},{"language":"en","tag":"Customers","count":7},{"language":"en","tag":"Subscriptions","count":7},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Plan-Verwaltung","count":6},{"language":"en","tag":"Payment Providers","count":6},{"language":"default","tag":"Nutzungsbasierte Abrechnung","count":5},{"language":"en","tag":"Accounting","count":5},{"language":"en","tag":"Developers","count":5},{"language":"en","tag":"Invoices","count":5},{"language":"default","tag":"KI-Assistent","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".update-container{display:flex}.update-container>div{position:unset!important}@media (min-width: 1024px){.update-container{flex-direction:column!important}}[data-component-part=\"update-label\"]{background:none}[data-component-part=\"update-tag\"]{-webkit-text-size-adjust:100%;tab-size:4;font-variation-settings:normal;-webkit-tap-highlight-color:transparent;font-feature-settings:\"cv02\",\"cv03\",\"cv04\",\"cv11\";--scroll-mt: 9.5rem;--font-inter: '__Inter_86cd50', '__Inter_Fallback_86cd50';--font-jetbrains-mono: '__JetBrains_Mono_3c557b', '__JetBrains_Mono_Fallback_3c557b';--primary: 39 19 64;--primary-light: 255 255 255;--primary-dark: 0 0 0;--background-light: 255 255 255;--background-dark: 0 0 0;--gray-50: 244 243 244;--gray-100: 239 238 239;--gray-200: 223 223 224;--gray-300: 207 206 207;--gray-400: 159 159 160;--gray-500: 113 112 113;--gray-600: 81 80 81;--gray-700: 63 63 64;--gray-800: 38 37 39;--gray-900: 23 23 24;--gray-950: 11 10 12;font-family:Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, \"Segoe UI\", Roboto, Helvetica, Arial, sans-serif, \"Apple Color Emoji\", \"Segoe UI Emoji\", \"Segoe UI Symbol\";-webkit-font-smoothing:antialiased;--tw-prose-body: #374151;--tw-prose-headings: #111827;--tw-prose-lead: #4b5563;--tw-prose-links: #111827;--tw-prose-bold: #111827;--tw-prose-counters: #6b7280;--tw-prose-bullets: #d1d5db;--tw-prose-hr: #e5e7eb;--tw-prose-quotes: #111827;--tw-prose-quote-borders: #e5e7eb;--tw-prose-captions: #6b7280;--tw-prose-kbd: #111827;--tw-prose-kbd-shadows: 17 24 39;--tw-prose-code: #111827;--tw-prose-pre-code: #e5e7eb;--tw-prose-pre-bg: #1f2937;--tw-prose-th-borders: #d1d5db;--tw-prose-td-borders: #e5e7eb;--tw-prose-invert-body: #d1d5db;--tw-prose-invert-headings: #fff;--tw-prose-invert-lead: #9ca3af;--tw-prose-invert-links: #fff;--tw-prose-invert-bold: #fff;--tw-prose-invert-counters: #9ca3af;--tw-prose-invert-bullets: #4b5563;--tw-prose-invert-hr: #374151;--tw-prose-invert-quotes: #f3f4f6;--tw-prose-invert-quote-borders: #374151;--tw-prose-invert-captions: #9ca3af;--tw-prose-invert-kbd: #fff;--tw-prose-invert-kbd-shadows: 255 255 255;--tw-prose-invert-code: #fff;--tw-prose-invert-pre-code: #d1d5db;--tw-prose-invert-pre-bg: rgba(0,0,0,.5);--tw-prose-invert-th-borders: #4b5563;--tw-prose-invert-td-borders: #374151;-webkit-user-modify:read-only;box-sizing:border-box;border-width:0;border-style:solid;border-color:rgb(var(--gray-200));--tw-border-spacing-x: 0;--tw-border-spacing-y: 0;--tw-translate-x: 0;--tw-translate-y: 0;--tw-rotate: 0;--tw-skew-x: 0;--tw-skew-y: 0;--tw-scale-x: 1;--tw-scale-y: 1;--tw-pan-x: ;--tw-pan-y: ;--tw-pinch-zoom: ;--tw-scroll-snap-strictness: proximity;--tw-gradient-from-position: ;--tw-gradient-via-position: ;--tw-gradient-to-position: ;--tw-ordinal: ;--tw-slashed-zero: ;--tw-numeric-figure: ;--tw-numeric-spacing: ;--tw-numeric-fraction: ;--tw-ring-inset: ;--tw-ring-offset-width: 0px;--tw-ring-offset-color: #fff;--tw-ring-color: rgba(59,130,246,.5);--tw-ring-offset-shadow: 0 0 #0000;--tw-ring-shadow: 0 0 #0000;--tw-shadow: 0 0 #0000;--tw-shadow-colored: 0 0 #0000;--tw-blur: ;--tw-brightness: ;--tw-contrast: ;--tw-grayscale: ;--tw-hue-rotate: ;--tw-invert: ;--tw-saturate: ;--tw-sepia: ;--tw-drop-shadow: ;--tw-backdrop-blur: ;--tw-backdrop-brightness: ;--tw-backdrop-contrast: ;--tw-backdrop-grayscale: ;--tw-backdrop-hue-rotate: ;--tw-backdrop-invert: ;--tw-backdrop-opacity: ;--tw-backdrop-saturate: ;--tw-backdrop-sepia: ;--tw-contain-size: ;--tw-contain-layout: ;--tw-contain-paint: ;--tw-contain-style: ;display:flex;flex-grow:0;cursor:pointer;align-items:center;justify-content:center;border-radius:var(--rounded-lg,.5rem);background-color:rgb(var(--primary)/.1);padding-left:.5rem;padding-right:.5rem;padding-top:.25rem;padding-bottom:.25rem;font-size:.875rem;line-height:1.25rem;font-weight:500;--tw-text-opacity: 1;color:rgb(var(--primary)/var(--tw-text-opacity))}"}],"page":{"pagePath":"v2-plans-api/customer/preview-plan-tier-switch","slug":"/v2-plans-api/customer/preview-plan-tier-switch","pageMetadata":{"openapi":"post /api/customer/subscriptions/{id}/plan-tier-preview","title":"Preview a tier switch","description":"Return a financial preview for switching the subscription into a target tier, with optional quantity overrides. This call does not change anything.","href":"/v2-plans-api/customer/preview-plan-tier-switch"},"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: \"Return a financial preview for switching the subscription into a target tier, with optional quantity overrides. This call does not change anything.\"\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":{"openapi":"post /api/customer/subscriptions/{id}/plan-tier-preview","title":"Preview a tier switch","description":"Return a financial preview for switching the subscription into a target tier, with optional quantity overrides. This call does not change anything.","href":"/v2-plans-api/customer/preview-plan-tier-switch"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/fynnsubscriptionbilling/086131e1768d5953/changelog-sidebar.js"],"openApiReferenceData":{"operation":{"operationId":"previewPlanTierSwitch","tags":["Plan switching (customer)"],"summary":"Preview a tier switch","description":"Return a financial preview for switching the subscription into a target tier, with optional quantity overrides. This call does not change anything.","security":["0dc179fa-4920-42b1-89a0-b4e3f5eabda2"],"parameters":["2204c82b-ce07-4e80-a66f-d11622cd199d"],"requestBody":"b4a8e74a-2c8d-48c6-a0fd-7513891aebd6","responses":{"200":"0535a182-235a-47e1-8a65-892c7aa25f78","401":"568a41f1-2aa9-4b40-bfb9-86b845b877ae","403":"b3062390-015c-416f-b895-05c3481bf9a2","404":"f7166d57-5815-4bf4-b166-f7e7253cc54b","422":"b082481c-41c7-41a8-8689-4d2be486a641"},"method":"post","type":"path","servers":["1bdffe7a-b339-4ac1-96c1-d109a10fe0b7","d6e10f74-0659-4625-ab4b-4fb5c436f00a"],"path":"/api/customer/subscriptions/{id}/plan-tier-preview","baseUrlOptions":["https://coreapi.io","https://preview.coreapi.io"],"title":"Preview a tier switch","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","php"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2204c82b-ce07-4e80-a66f-d11622cd199d":{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"1280792f-4e23-793d-8e9c-3a1bf36630bd","isRequired":true,"description":"The subscription UUID.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"The subscription UUID."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["planTierId"],"properties":{"planTierId":{"type":"string","description":"UUID of the target tier to preview.","isRequired":true,"uniqueKey":"planTierId","typeLabel":"string"},"items":{"type":"array","items":{"type":"object","required":["planTierItemId","quantity"],"properties":{"planTierItemId":{"type":"string","description":"UUID of the tier item to override.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].planTierItemId","typeLabel":"string"},"quantity":{"type":"number","minimum":0,"description":"Requested quantity. Must lie within the item minQuantity and maxQuantity and the item must be quantity editable.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"number"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"default":[],"description":"Optional quantity overrides for editable items of the target tier.","uniqueKey":"\\items","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"planTierId":"f5ece259-08ea-77a4-8bd9-9f3a9ed9e246","items":[]},"examples":{"Example":{"title":"Example","value":{"planTierId":"f5ece259-08ea-77a4-8bd9-9f3a9ed9e246","items":[]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"0535a182-235a-47e1-8a65-892c7aa25f78":{"description":"The switch preview. May be null when no schedule exists yet.","content":{"application/json":{"schema":{"type":"object","description":"Financial preview of a tier switch. creditAmount and chargeAmount are absolute decimal strings, the direction is implied by the field name.","properties":{"creditAmount":{"type":"string","example":"14.50","description":"Credit for unused time on the current items. 0.00 when the target tier does not credit.","uniqueKey":"creditAmount","typeLabel":"string"},"chargeAmount":{"type":"string","example":"24.50","description":"Charge for the partial period on the new items.","uniqueKey":"chargeAmount","typeLabel":"string"},"currency":{"type":"string","example":"EUR","uniqueKey":"currency","typeLabel":"string"},"effectiveAt":{"type":"string","format":"date-time","description":"Date the switch is calculated for. For end_of_period tiers the preview uses the current moment, so the amounts are an approximation.","uniqueKey":"effectiveAt","typeLabel":"string\u003cdate-time>"},"recurringTotal":{"type":"object","description":"Recurring amount for one billing period. Amounts are decimal strings.","properties":{"netAmount":{"type":"string","example":"49.00","uniqueKey":"recurringTotal.netAmount","typeLabel":"string"},"taxAmount":{"type":"string","example":"9.31","uniqueKey":"recurringTotal.taxAmount","typeLabel":"string"},"grossAmount":{"type":"string","example":"58.31","uniqueKey":"recurringTotal.grossAmount","typeLabel":"string"},"currency":{"type":"string","example":"EUR","uniqueKey":"recurringTotal.currency","typeLabel":"string"}},"uniqueKey":"recurringTotal","typeLabel":"object"},"warnings":{"type":"array","items":{"type":"string","uniqueKey":"warnings.items.[INDEX]","typeLabel":"string"},"example":["active_discount_will_be_lost"],"description":"Hints about side effects, for example that an active discount will not carry over.","uniqueKey":"warnings","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"creditAmount":"14.50","chargeAmount":"24.50","currency":"EUR","effectiveAt":"2023-11-07T05:31:56Z","recurringTotal":{"netAmount":"49.00","taxAmount":"9.31","grossAmount":"58.31","currency":"EUR"},"warnings":["active_discount_will_be_lost"]}}},"exampleType":"generated"}},"exampleType":"generated"},"568a41f1-2aa9-4b40-bfb9-86b845b877ae":{"description":"Authentication is missing or the token is invalid.","content":{"application/problem+json":{"schema":{"type":"object","description":"Problem detail error body (application/problem+json). Additional members may be present depending on the error.","properties":{"status":{"type":"integer","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"type":{"type":"string","description":"Stable machine readable error key.","example":"PLAN__NOT_FOUND","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","example":"An error occurred","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"detail":{"type":"string","example":"Plan not found.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["status","type","title","detail"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":404,"type":"PLAN__NOT_FOUND","title":"An error occurred","detail":"Plan not found."}}},"exampleType":"generated"}},"exampleType":"generated"},"b3062390-015c-416f-b895-05c3481bf9a2":{"description":"The token is valid but lacks the required permission.","content":{"application/problem+json":{"schema":{"type":"object","description":"Problem detail error body (application/problem+json). Additional members may be present depending on the error.","properties":{"status":{"type":"integer","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"type":{"type":"string","description":"Stable machine readable error key.","example":"PLAN__NOT_FOUND","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","example":"An error occurred","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"detail":{"type":"string","example":"Plan not found.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["status","type","title","detail"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":404,"type":"PLAN__NOT_FOUND","title":"An error occurred","detail":"Plan not found."}}},"exampleType":"generated"}},"exampleType":"generated"},"f7166d57-5815-4bf4-b166-f7e7253cc54b":{"description":"The requested resource does not exist for this Organisation.","content":{"application/problem+json":{"schema":{"type":"object","description":"Problem detail error body (application/problem+json). Additional members may be present depending on the error.","properties":{"status":{"type":"integer","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"type":{"type":"string","description":"Stable machine readable error key.","example":"PLAN__NOT_FOUND","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","example":"An error occurred","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"detail":{"type":"string","example":"Plan not found.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["status","type","title","detail"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":404,"type":"PLAN__NOT_FOUND","title":"An error occurred","detail":"Plan not found."}}},"exampleType":"generated"}},"exampleType":"generated"},"b082481c-41c7-41a8-8689-4d2be486a641":{"description":"The request failed validation or a business rule was violated.","content":{"application/problem+json":{"schema":{"oneOf":[{"type":"object","description":"Validation error body (application/problem+json) returned when input fails field level validation.","required":["status","type","title","violations"],"properties":{"status":{"type":"integer","example":422,"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"integer"},"type":{"type":"string","example":"https://tools.ietf.org/html/rfc2616#section-10","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"string"},"title":{"type":"string","example":"Validation Failed","isRequired":true,"uniqueKey":"oneOf.0.title","typeLabel":"string"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","example":"tiers[0].name","uniqueKey":"oneOf.0.violations.items.[INDEX].propertyPath","typeLabel":"string"},"message":{"type":"string","example":"This value should not be blank.","uniqueKey":"oneOf.0.violations.items.[INDEX].message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.violations.items.[INDEX].code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.violations.items.[INDEX].code.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.violations.items.[INDEX].code","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.violations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.violations","typeLabel":"object[]"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Problem detail error body (application/problem+json). Additional members may be present depending on the error.","required":["status","type","title","detail"],"properties":{"status":{"type":"integer","example":404,"isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"integer"},"type":{"type":"string","description":"Stable machine readable error key.","example":"PLAN__NOT_FOUND","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"string"},"title":{"type":"string","example":"An error occurred","isRequired":true,"uniqueKey":"oneOf.1.title","typeLabel":"string"},"detail":{"type":"string","example":"Plan not found.","isRequired":true,"uniqueKey":"oneOf.1.detail","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":422,"type":"https://tools.ietf.org/html/rfc2616#section-10","title":"Validation Failed","violations":[{"propertyPath":"tiers[0].name","message":"This value should not be blank.","code":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0dc179fa-4920-42b1-89a0-b4e3f5eabda2":{"CustomerToken":{"type":"http","scheme":"bearer","description":"Customer access token. Send it as Authorization: Bearer \u003ctoken>. Obtain it server side via POST /customers/{id}/authenticate (use the response accessToken), or from a customer portal session. The token must carry the customer:plan:switch permission.","scopes":[]}}},"servers":{"1bdffe7a-b339-4ac1-96c1-d109a10fe0b7":{"url":"https://coreapi.io","description":"Production"},"d6e10f74-0659-4625-ab4b-4fb5c436f00a":{"url":"https://preview.coreapi.io","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Customer access token. Send it as Authorization: Bearer \u003ctoken>. Obtain it server side via POST /customers/{id}/authenticate (use the response accessToken), or from a customer portal session. The token must carry the customer:plan:switch permission.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Customer access token. Send it as Authorization: Bearer \u003ctoken>. Obtain it server side via POST /customers/{id}/authenticate (use the response accessToken), or from a customer portal session. The token must carry the customer:plan:switch permission.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"CustomerToken","name":"Authorization"}],"title":"CustomerToken"}]},"originalFileLocation":"assets/openapi-v2-plans.json"},"subdomain":"fynnsubscriptionbilling","siteName":"Fynn Docs","title":"Preview a tier switch - Fynn Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"de":{"href":"/v2-plans-api/customer/preview-plan-tier-switch","matchLevel":0},"en":{"href":"/v2-plans-api/customer/preview-plan-tier-switch","matchLevel":0}}},"lastModified":"2026-06-21T11:06:11.722Z","originalFileLocation":"v2-plans-api/customer/preview-plan-tier-switch.mdx","locale":"de"},"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=\"Return a financial preview for switching the subscription into a target tier, with optional quantity overrides. This call does not change anything.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Fynn Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fynnsubscriptionbilling/aEyoysRsbJwnVfa3/_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/fynnsubscriptionbilling/aEyoysRsbJwnVfa3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fynnsubscriptionbilling/aEyoysRsbJwnVfa3/_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/fynnsubscriptionbilling/aEyoysRsbJwnVfa3/_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/fynnsubscriptionbilling/aEyoysRsbJwnVfa3/_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/fynnsubscriptionbilling/aEyoysRsbJwnVfa3/_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/fynnsubscriptionbilling/aEyoysRsbJwnVfa3/_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/fynnsubscriptionbilling/aEyoysRsbJwnVfa3/_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/fynnsubscriptionbilling/aEyoysRsbJwnVfa3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Preview a tier switch - Fynn Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Return a financial preview for switching the subscription into a target tier, with optional quantity overrides. This call does not change anything.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fynn Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.fynn.eu/v2-plans-api/customer/preview-plan-tier-switch\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fynnsubscriptionbilling.mintlify.site/_mintlify/api/og/v2?division=Tarifwechsel\u0026amp;title=Preview+a+tier+switch\u0026amp;description=Return+a+financial+preview+for+switching+the+subscription+into+a+target+tier%2C+with+optional+quantity+overrides.+This+call+does+not+change+anything.\u0026amp;theme=e7dd9c799652fa75e5fe0868\u0026amp;signature=4e072011111b08ba4205a77f2e5f47cdebc39ad9ee86a7685b89cfddf3f28d3f\">\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=\"Preview a tier switch - Fynn Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Return a financial preview for switching the subscription into a target tier, with optional quantity overrides. This call does not change anything.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fynnsubscriptionbilling.mintlify.site/_mintlify/api/og/v2?division=Tarifwechsel\u0026amp;title=Preview+a+tier+switch\u0026amp;description=Return+a+financial+preview+for+switching+the+subscription+into+a+target+tier%2C+with+optional+quantity+overrides.+This+call+does+not+change+anything.\u0026amp;theme=e7dd9c799652fa75e5fe0868\u0026amp;signature=4e072011111b08ba4205a77f2e5f47cdebc39ad9ee86a7685b89cfddf3f28d3f\">\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/fynnsubscriptionbilling/aEyoysRsbJwnVfa3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fynn Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.fynn.eu/v2-plans-api/customer/preview-plan-tier-switch\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2-plans-api/customer/preview-plan-tier-switch.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.fynn.eu/#organization\",\"name\":\"Fynn Docs\",\"url\":\"https://docs.fynn.eu\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fynnsubscriptionbilling/kPbBeWVEZfmEic9q/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=kPbBeWVEZfmEic9q\u0026q=85\u0026s=83e4b30a53d77c3809e0f22afa29335d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.fynn.eu#website\",\"name\":\"Fynn Docs\",\"url\":\"https://docs.fynn.eu\",\"publisher\":{\"@id\":\"https://docs.fynn.eu/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.fynn.eu/v2-plans-api/customer/preview-plan-tier-switch#webpage\",\"url\":\"https://docs.fynn.eu/v2-plans-api/customer/preview-plan-tier-switch\",\"name\":\"Preview a tier switch\",\"description\":\"Return a financial preview for switching the subscription into a target tier, with optional quantity overrides. This call does not change anything.\",\"dateModified\":\"2026-06-21T11:06:11.722Z\",\"isPartOf\":{\"@id\":\"https://docs.fynn.eu#website\"},\"breadcrumb\":{\"@id\":\"https://docs.fynn.eu/v2-plans-api/customer/preview-plan-tier-switch#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.fynn.eu/v2-plans-api/customer/preview-plan-tier-switch#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pläne\",\"item\":\"https://docs.fynn.eu/v2-plans-api/quickstart\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API\",\"item\":\"https://docs.fynn.eu/v2-plans-api/plans/list-plans\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Tarifwechsel\",\"item\":\"https://docs.fynn.eu/v2-plans-api/customer/plan-options\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Preview a tier switch\",\"item\":\"https://docs.fynn.eu/v2-plans-api/customer/preview-plan-tier-switch\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.fynn.eu/v2-plans-api/customer/preview-plan-tier-switch#apireference\",\"headline\":\"Preview a tier switch\",\"name\":\"Preview a tier switch\",\"description\":\"Return a financial preview for switching the subscription into a target tier, with optional quantity overrides. This call does not change anything.\",\"url\":\"https://docs.fynn.eu/v2-plans-api/customer/preview-plan-tier-switch\",\"mainEntityOfPage\":{\"@id\":\"https://docs.fynn.eu/v2-plans-api/customer/preview-plan-tier-switch#webpage\"},\"dateModified\":\"2026-06-21T11:06:11.722Z\",\"publisher\":{\"@id\":\"https://docs.fynn.eu/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.fynn.eu#website\"}}]}\u003c/script>","agentPointerHref":"/v2-plans-api/customer/preview-plan-tier-switch.md","siteName":"Fynn Docs","nav":{"global":null,"languages":[{"language":"de","default":true,"tabs":[{"tab":"Dokumentation","pages":[{"title":"Dokumentation","href":"/introduction"}]},{"tab":"Integrationen","pages":[{"title":"Integrationen","href":"/integrations/overview"}]},{"tab":"API Referenz","pages":[{"title":"API Referenz","href":"/api-reference/introduction"}]},{"tab":"API V2","groups":[{"group":"Einführung","icon":"compass","pages":[{"title":"Fynn API V2","sidebarTitle":"Einführung","icon":"compass","href":"/v2-plans-api/introduction"}]},{"group":"Grundlagen","icon":"cube","pages":[{"title":"Authentifizierung","sidebarTitle":"Authentifizierung","icon":"key","href":"/v2-plans-api/authentication"},{"title":"Asynchrone Abrechnung","sidebarTitle":"Asynchrone Abrechnung","icon":"receipt","href":"/v2-plans-api/billing"}]},{"group":"Pläne","icon":"layer-group","pages":[{"title":"Schnellstart","sidebarTitle":"Schnellstart","icon":"rocket","href":"/v2-plans-api/quickstart"},{"title":"Kernkonzepte","sidebarTitle":"Kernkonzepte","icon":"book","href":"/v2-plans-api/concepts"},{"title":"Up- und Downgrades","sidebarTitle":"Up- und Downgrades","icon":"arrow-up-arrow-down","href":"/v2-plans-api/upgrades-downgrades"},{"title":"Checkout","sidebarTitle":"Checkout","icon":"cart-shopping","href":"/v2-plans-api/checkout-and-sales-channels"},{"group":"API","pages":[{"group":"Plan-Verwaltung","pages":[{"openapi":"get /api/plans","title":"List plans","href":"/v2-plans-api/plans/list-plans"},{"openapi":"post /api/plans","title":"Create a plan","href":"/v2-plans-api/plans/create-plan"},{"openapi":"get /api/plans/{id}","title":"Retrieve a plan","href":"/v2-plans-api/plans/get-plan"},{"openapi":"put /api/plans/{id}","title":"Update a plan","href":"/v2-plans-api/plans/update-plan"},{"openapi":"post /api/plans/{id}/activate","title":"Activate a plan","href":"/v2-plans-api/plans/activate-plan"},{"openapi":"delete /api/plans/{id}","title":"Delete or archive a plan","href":"/v2-plans-api/plans/delete-plan"}]},{"group":"Checkout-Links","pages":[{"openapi":"post /api/plans/{id}/checkout-links","title":"Create a checkout link","href":"/v2-plans-api/checkout-links/create-checkout-link"},{"openapi":"get /api/plans/{id}/checkout-links","title":"List checkout links of a plan","href":"/v2-plans-api/checkout-links/list-checkout-links"}]},{"group":"Tarifwechsel","pages":[{"openapi":"get /api/customer/subscriptions/{id}/plan-options","title":"Get plan switch options","description":"Return the current tier of a subscription and all tiers it can reach, each with a financial preview. This endpoint runs in the customer context and requires a customer token with the customer.plan.switch scope.","href":"/v2-plans-api/customer/plan-options"},{"openapi":"post /api/customer/subscriptions/{id}/plan-tier-preview","title":"Preview a tier switch","href":"/v2-plans-api/customer/preview-plan-tier-switch"},{"openapi":"post /api/customer/subscriptions/{id}/switch-plan-tier","title":"Switch the plan tier","description":"Switch the subscription into a target tier. The change takes effect immediately or at the end of the current period, depending on the target tier. Any proration credit or charge is collected into the next invoice.","href":"/v2-plans-api/customer/switch-plan-tier"}]}]}]},{"group":"Angebote","icon":"file-signature","pages":[{"title":"Angebote","sidebarTitle":"Einführung","icon":"file-signature","href":"/v2-offers-api/introduction"},{"title":"Schnellstart","sidebarTitle":"Schnellstart","icon":"rocket","href":"/v2-offers-api/quickstart"},{"title":"Kernkonzepte","sidebarTitle":"Kernkonzepte","icon":"book","href":"/v2-offers-api/concepts"},{"title":"Der Angebots-Editor","sidebarTitle":"Der Editor","icon":"pen-ruler","href":"/v2-offers-api/editor"},{"title":"Die Angebots-Ansicht","sidebarTitle":"Angebots-Ansicht","icon":"eye","href":"/v2-offers-api/angebots-ansicht"},{"title":"Annahme und Signatur","sidebarTitle":"Annahme und Signatur","icon":"file-signature","href":"/v2-offers-api/acceptance-and-signing"},{"title":"Rechnungsdaten","sidebarTitle":"Rechnungsdaten","icon":"receipt","href":"/v2-offers-api/billing-details"},{"title":"Veröffentlichen und Empfänger","sidebarTitle":"Veröffentlichen","icon":"paper-plane","href":"/v2-offers-api/sending-and-recipients"},{"title":"Freigaben","sidebarTitle":"Freigaben","icon":"circle-check","href":"/v2-offers-api/freigaben"},{"title":"Einstellungen","sidebarTitle":"Einstellungen","icon":"gear","href":"/v2-offers-api/settings"},{"title":"Authentifizierung","sidebarTitle":"Authentifizierung","icon":"key","href":"/v2-offers-api/authentication"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"bell","href":"/v2-offers-api/webhooks"},{"group":"API","pages":[{"group":"Angebote","pages":[{"openapi":"assets/openapi-v2-offers.json get /offers","title":"List offers","href":"/v2-offers-api/offers/list-offers"},{"openapi":"assets/openapi-v2-offers.json get /api/offers/{id}","title":"Get an offer","href":"/v2-offers-api/offers/get-offer"},{"openapi":"assets/openapi-v2-offers.json put /offers/{id}","title":"Update an offer","href":"/v2-offers-api/offers/update-offer"},{"openapi":"assets/openapi-v2-offers.json get /offers/{id}/document","title":"Download an offer as PDF","href":"/v2-offers-api/offers/download-offer"},{"openapi":"assets/openapi-v2-offers.json post /api/offers/{id}/publish","title":"Publish an offer","href":"/v2-offers-api/offers/publish-offer"},{"openapi":"assets/openapi-v2-offers.json post /api/offers/{id}/accept","title":"Accept an offer manually","href":"/v2-offers-api/offers/accept-offer"},{"openapi":"assets/openapi-v2-offers.json post /offers/{id}/cancel-signing","title":"Cancel a signing process","href":"/v2-offers-api/offers/cancel-signing"},{"openapi":"assets/openapi-v2-offers.json post /offers/{id}/recipients","title":"Add a recipient","href":"/v2-offers-api/offers/add-recipient"},{"openapi":"assets/openapi-v2-offers.json get /api/offers/{id}/activities","title":"List offer activity","href":"/v2-offers-api/offers/list-activities"},{"openapi":"assets/openapi-v2-offers.json delete /offers/{id}","title":"Archive an offer","href":"/v2-offers-api/offers/archive-offer"}]},{"group":"Freigabe","pages":[{"openapi":"assets/openapi-v2-offers.json get /api/offers/{id}/approval","title":"Get the approval state","href":"/v2-offers-api/approval/get-approval"},{"openapi":"assets/openapi-v2-offers.json post /api/offers/{id}/approval/approve","title":"Approve a pending request","href":"/v2-offers-api/approval/approve"},{"openapi":"assets/openapi-v2-offers.json post /api/offers/{id}/approval/reject","title":"Reject a pending request","href":"/v2-offers-api/approval/reject"},{"openapi":"assets/openapi-v2-offers.json post /api/offers/{id}/approval/cancel","title":"Cancel a pending request","href":"/v2-offers-api/approval/cancel-approval"}]}]}]},{"group":"Finanzberichte","icon":"chart-line","pages":[{"title":"Finanzberichte: Konzepte","sidebarTitle":"Konzepte","icon":"book","href":"/v2-finance-api/concepts"},{"title":"Datensätze","sidebarTitle":"Datensätze","icon":"table","href":"/v2-finance-api/datasets"},{"title":"Drill-downs","sidebarTitle":"Drill-downs","icon":"magnifying-glass","href":"/v2-finance-api/drill-downs"},{"title":"Snapshots","sidebarTitle":"Snapshots","icon":"lock","href":"/v2-finance-api/snapshots"},{"title":"Excel-Exporte","sidebarTitle":"Excel-Exporte","icon":"file-excel","href":"/v2-finance-api/excel"},{"title":"Fehler","sidebarTitle":"Fehler","icon":"triangle-exclamation","href":"/v2-finance-api/errors"},{"title":"Definitionen","sidebarTitle":"Definitionen","icon":"book-open","href":"/v2-finance-api/definitions"},{"group":"API","pages":[{"group":"Datensätze","pages":[{"openapi":"assets/openapi-v2-finance.json get /api/analytics/finance/recurring","title":"Recurring revenue page datasets","href":"/v2-finance-api/datasets/get-recurring"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/finance/customers","title":"Customer base page datasets","href":"/v2-finance-api/datasets/get-customers"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/finance/liquidity","title":"Liquidity page datasets","href":"/v2-finance-api/datasets/get-liquidity"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/finance/revenue","title":"Revenue page datasets","href":"/v2-finance-api/datasets/get-revenue"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/finance/revenue/customers","title":"Revenue per customer, paged","href":"/v2-finance-api/datasets/get-revenue-customers"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/finance/overview","title":"Finance overview datasets","href":"/v2-finance-api/datasets/get-overview"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/mrr-financials","title":"MRR financials table","href":"/v2-finance-api/datasets/get-mrr-table"}]},{"group":"Drill-downs und Hinweise","pages":[{"openapi":"assets/openapi-v2-finance.json get /api/analytics/mrr-financials/details","title":"Lines behind one cell of the finance tables","href":"/v2-finance-api/drill-downs/get-details"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/mrr-financials/findings","title":"Data-quality findings of the MRR calculation","href":"/v2-finance-api/drill-downs/list-findings"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/mrr-financials/findings/{id}","title":"One data-quality finding with its explanation","href":"/v2-finance-api/drill-downs/get-finding"}]},{"group":"Snapshots","pages":[{"openapi":"assets/openapi-v2-finance.json get /api/analytics/finance/snapshots","title":"Month-end MRR snapshots","href":"/v2-finance-api/snapshots/list-snapshots"},{"openapi":"assets/openapi-v2-finance.json post /api/analytics/finance/snapshots","title":"Take a month-end MRR snapshot again","href":"/v2-finance-api/snapshots/take-snapshot"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/finance/snapshots/{month}/{version}","title":"Frozen MRR figures of a snapshot","href":"/v2-finance-api/snapshots/get-snapshot"}]},{"group":"Excel-Exporte","pages":[{"openapi":"assets/openapi-v2-finance.json get /api/analytics/finance/recurring/excel","title":"Export the recurring revenue page as XLSX","href":"/v2-finance-api/excel/export-recurring"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/finance/customers/excel","title":"Export the customer base page as XLSX","href":"/v2-finance-api/excel/export-customers"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/finance/liquidity/excel","title":"Export the liquidity page as XLSX","href":"/v2-finance-api/excel/export-liquidity"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/finance/revenue/excel","title":"Export the revenue page as XLSX","href":"/v2-finance-api/excel/export-revenue"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/mrr-financials/export/excel","title":"Export the MRR financials as XLSX","href":"/v2-finance-api/excel/export-mrr-table"},{"openapi":"assets/openapi-v2-finance.json get /api/analytics/mrr-financials/findings/export/excel","title":"Export the data-quality findings as XLSX","href":"/v2-finance-api/excel/export-findings"}]},{"group":"Definitionen","pages":[{"openapi":"assets/openapi-v2-finance.json get /api/analytics/finance/definitions","title":"Read the finance definitions catalogue","href":"/v2-finance-api/definitions/get-definitions"}]},{"group":"Einstellungen","pages":[{"openapi":"assets/openapi-v2-finance.json get /api/analytics/mrr-financials/settings","title":"Read the finance settings","href":"/v2-finance-api/settings/get-settings"},{"openapi":"assets/openapi-v2-finance.json patch /api/analytics/mrr-financials/settings","title":"Update the finance settings","href":"/v2-finance-api/settings/update-settings"}]}]}]},{"group":"Provisionen","icon":"percent","pages":[{"title":"Provisionen API","sidebarTitle":"Einführung","icon":"percent","href":"/v2-commission-api/introduction"},{"title":"Kernkonzepte","sidebarTitle":"Kernkonzepte","icon":"book","href":"/v2-commission-api/concepts"},{"group":"API","pages":[{"group":"Provisionspläne","pages":[{"openapi":"assets/openapi-v2-commission.json get /api/commissions/plans","title":"List commission plans","href":"/v2-commission-api/plans/list-plans"},{"openapi":"assets/openapi-v2-commission.json post /api/commissions/plans","title":"Create a commission plan","href":"/v2-commission-api/plans/create-plan"},{"openapi":"assets/openapi-v2-commission.json get /api/commissions/plans/{id}","title":"Get a commission plan","href":"/v2-commission-api/plans/get-plan"},{"openapi":"assets/openapi-v2-commission.json put /api/commissions/plans/{id}","title":"Update a commission plan","href":"/v2-commission-api/plans/update-plan"},{"openapi":"assets/openapi-v2-commission.json delete /api/commissions/plans/{id}","title":"Delete a commission plan","href":"/v2-commission-api/plans/delete-plan"}]}]}]},{"group":"Zahlungspläne","icon":"calendar-days","pages":[{"title":"Zahlungsplan API","sidebarTitle":"Einführung","icon":"calendar-days","href":"/v2-payment-plans-api/introduction"},{"title":"Schnellstart","sidebarTitle":"Schnellstart","icon":"rocket","href":"/v2-payment-plans-api/quickstart"},{"title":"Kernkonzepte","sidebarTitle":"Kernkonzepte","icon":"book","href":"/v2-payment-plans-api/concepts"},{"title":"Webhooks","sidebarTitle":"Webhooks","icon":"bell","href":"/v2-payment-plans-api/webhooks"},{"group":"API","pages":[{"group":"Zahlungsplan-Verwaltung","pages":[{"openapi":"assets/openapi-v2-payment-plans.json post /api/payment-plans","title":"Create a payment plan","href":"/v2-payment-plans-api/payment-plans/create-payment-plan"},{"openapi":"assets/openapi-v2-payment-plans.json get /api/payment-plans/{id}","title":"Get a payment plan","href":"/v2-payment-plans-api/payment-plans/get-payment-plan"},{"openapi":"assets/openapi-v2-payment-plans.json get /api/invoices/{id}/payment-plan","title":"Get the payment plan of an invoice","href":"/v2-payment-plans-api/payment-plans/get-invoice-payment-plan"},{"openapi":"assets/openapi-v2-payment-plans.json post /api/payment-plans/{id}/cancel","title":"Cancel a payment plan","href":"/v2-payment-plans-api/payment-plans/cancel-payment-plan"},{"openapi":"assets/openapi-v2-payment-plans.json post /api/payment-plans/{id}/extend","title":"Extend a payment plan","href":"/v2-payment-plans-api/payment-plans/extend-payment-plan"}]}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/2026-07"}]}]},{"language":"en","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/en/introduction"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/en/integrations/overview"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"API V2","groups":[{"group":"Introduction","icon":"compass","pages":[{"title":"Fynn API V2","sidebarTitle":"Einführung","icon":"compass","href":"/v2-plans-api/introduction"}]},{"group":"Fundamentals","icon":"cube","pages":[{"title":"Authentifizierung","sidebarTitle":"Authentifizierung","icon":"key","href":"/v2-plans-api/authentication"},{"title":"Asynchrone Abrechnung","sidebarTitle":"Asynchrone Abrechnung","icon":"receipt","href":"/v2-plans-api/billing"}]},{"group":"Plans","icon":"layer-group","pages":[{"title":"Schnellstart","sidebarTitle":"Schnellstart","icon":"rocket","href":"/v2-plans-api/quickstart"},{"title":"Kernkonzepte","sidebarTitle":"Kernkonzepte","icon":"book","href":"/v2-plans-api/concepts"},{"title":"Up- und Downgrades","sidebarTitle":"Up- und Downgrades","icon":"arrow-up-arrow-down","href":"/v2-plans-api/upgrades-downgrades"},{"title":"Checkout","sidebarTitle":"Checkout","icon":"cart-shopping","href":"/v2-plans-api/checkout-and-sales-channels"},{"group":"API","pages":[{"group":"Plan management","pages":[{"openapi":"get /api/plans","title":"List plans","href":"/v2-plans-api/plans/list-plans"},{"openapi":"post /api/plans","title":"Create a plan","href":"/v2-plans-api/plans/create-plan"},{"openapi":"get /api/plans/{id}","title":"Retrieve a plan","href":"/v2-plans-api/plans/get-plan"},{"openapi":"put /api/plans/{id}","title":"Update a plan","href":"/v2-plans-api/plans/update-plan"},{"openapi":"post /api/plans/{id}/activate","title":"Activate a plan","href":"/v2-plans-api/plans/activate-plan"},{"openapi":"delete /api/plans/{id}","title":"Delete or archive a plan","href":"/v2-plans-api/plans/delete-plan"}]},{"group":"Checkout links","pages":[{"openapi":"post /api/plans/{id}/checkout-links","title":"Create a checkout link","href":"/v2-plans-api/checkout-links/create-checkout-link"},{"openapi":"get /api/plans/{id}/checkout-links","title":"List checkout links of a plan","href":"/v2-plans-api/checkout-links/list-checkout-links"}]},{"group":"Plan switching","pages":[{"openapi":"get /api/customer/subscriptions/{id}/plan-options","title":"Get plan switch options","description":"Return the current tier of a subscription and all tiers it can reach, each with a financial preview. This endpoint runs in the customer context and requires a customer token with the customer.plan.switch scope.","href":"/v2-plans-api/customer/plan-options"},{"openapi":"post /api/customer/subscriptions/{id}/plan-tier-preview","title":"Preview a tier switch","href":"/v2-plans-api/customer/preview-plan-tier-switch"},{"openapi":"post /api/customer/subscriptions/{id}/switch-plan-tier","title":"Switch the plan tier","description":"Switch the subscription into a target tier. The change takes effect immediately or at the end of the current period, depending on the target tier. Any proration credit or charge is collected into the next invoice.","href":"/v2-plans-api/customer/switch-plan-tier"}]}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/en/changelog/overview"}]}]}]},"basePath":"","title":"Preview a tier switch - Fynn Docs","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}