Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Scopes
subscription:write
Pfadparameter
id
string
erforderlich
Subscription identifier
Body
application/jsontext/html
The updated Subscription resource
cancellationDateType
enum<string>
The type how the cancellation date should be interpreted.
Verfügbare Optionen:
immediate,
next_possible,
custom
Beispiel:
"next_possible"
cancellationDate
string<date-time> | null
The date when the subscription should be cancelled. Required if the type is custom.
Beispiel:
"2022-12-31"
sendConfirmationEmail
boolean
If the confirmation email should be sent to the customer.
Beispiel:
true
reason
string | null
The reason code why the subscription should be cancelled.
Antwort
Subscription resource updated
id
string
read-only
Beispiel:
"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
externalId
string | null
paymentMethod
object | null
The payment method of the subscription. If null, the default payment method of the customer is used.
Show child attributes
invoiceAddress
object | null
The invoice address of the subscription. If null, the default invoice address of the customer is used.
Show child attributes
number
string
The number of the subscription.
Beispiel:
"S-00000001"
customer
object
Show child attributes
plan
object | null
The plan this subscription is based on.
Show child attributes
name
string | null
The name of the subscription. Defaults to the name of the plan. This will be used in the invoice for the grouping headers.
Beispiel:
"Fitness M"
billingGroup
object | null
The billing group defines the billing cycle of the subscription.
periods
object[]
Show child attributes
status
any
read-only
The status of the subscription.
Possible values:
draft: The subscription is in draft mode and not active yet.
active: The subscription is active and will be billed.
paused: The subscription is paused and will not be billed.
cancelled: The subscription is cancelled and will not be billed anymore.
terminated: The subscription is terminated and will not be billed anymore.
offer: The subscription is an offer and waiting for acceptance.
Beispiel:
"active"
activatedAt
string<date-time> | null
read-only
The date the subscription was activated.
Beispiel:
"2021-01-01T00:00:00+00:00"
poNumber
string | null
The po number of the subscription.
Beispiel:
"PO-00000001"
contractDetails
object
The contract details of the subscription.
Show child attributes
trialEndsOn
string<date-time> | null
read-only
The date the trial period ends.
Beispiel:
"2021-01-01T00:00:00+00:00"
customFields
object | null
Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide
Show child attributes
Beispiel:
{ "field1": "value1", "field2": "value2" }
createdAt
string<date-time>
read-only
The date and time when the resource was created.
Beispiel:
"2021-01-01T00:00:00+00:00"
updatedAt
string<date-time>
read-only
The date and time when the resource was last updated.
Beispiel:
"2021-01-01T00:00:00+00:00"
defaultPaymentMethod
boolean
read-only
The payment method is null, we use the default payment method of the customer.
defaultInvoiceAddress
boolean
read-only
The invoice address is null, we use the default invoice address of the customer.
nextBillingDate
string<date-time> | null
read-only
The next billing date of the subscription.
lastBillingAt
string<date-time> | null
read-only
The last billing date of the subscription.
cancellationDate
string<date-time> | null
read-only
The date the subscription will be cancelled.
cancelledAt
string<date-time> | null
read-only
The date when the subscription was cancelled.
isCancellationPending
boolean
read-only
Indicates if the subscription is pending for cancellation. If true, the subscription will be cancelled in the future and the cancellation could be revoked.
nextPossibleCancellationDate
string[] | null
read-only
partner
object | null
The partner of the customer.
Show child attributes
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":"6af84b254f86660c4a24beba","clientVersion":"0.0.4143","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":"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":"llms-txt-v2","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":"api-reference/subscription/cancel-subscription","slug":"/api-reference/subscription/cancel-subscription","pageMetadata":{"openapi":"put /subscriptions/{id}/cancel","title":"Cancel subscription","description":"Cancel the subscription. This will stop billing and the subscription will be inactive after the cancellation date.\n\n\u003csup>Required permissions: `subscription:write`\u003c/sup>","href":"/api-reference/subscription/cancel-subscription"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Cancel the subscription. This will stop billing and the subscription will be inactive after the cancellation date.\"\n }), \"\\n\", _jsxs(\"sup\", {\n children: [\"Required permissions: \", _jsx(_components.code, {\n children: \"subscription:write\"\n })]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"put /subscriptions/{id}/cancel","title":"Cancel subscription","description":"Cancel the subscription. This will stop billing and the subscription will be inactive after the cancellation date.\n\n\u003csup>Required permissions: `subscription:write`\u003c/sup>","href":"/api-reference/subscription/cancel-subscription"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/fynnsubscriptionbilling/086131e1768d5953/changelog-sidebar.js"],"openApiReferenceData":{"operation":{"operationId":"api_subscriptions_idcancel_put","tags":["Subscription"],"responses":{"200":"4c00d650-a7d1-4560-95f1-e53f11559804","400":"e672e208-4c90-4c33-b6af-2438081947d2","404":"03601d8b-0179-4410-8868-5032cfc61038","422":"b021bedc-c6cc-4138-8df8-208b3ff28964"},"summary":"Cancel subscription","description":"Cancel the subscription. This will stop billing and the subscription will be inactive after the cancellation date.\n\n\u003csup>Required permissions: `subscription:write`\u003c/sup>","parameters":["3241641b-45f2-4820-a3d5-1ea6714831f1"],"requestBody":"3006f40e-036f-4f7d-8c3f-c32f3171870b","deprecated":false,"security":["ec83da86-04b7-4e27-94ab-a01fa192cecc"],"x-codeSamples":[{"lang":"bash","label":"cURL","source":"curl -X PUT \\\n /subscriptions/{id}/cancel \\\n --header \"Content-Type: application/json\" \\\n --header \"Authorization: Bearer \u003ctoken>\" \\\n --data '{\n \"cancellationDateType\": \"next_possible\",\n \"cancellationDate\": \"2022-12-31\",\n \"sendConfirmationEmail\": \"1\",\n \"reason\": \"\"\n}'"}],"method":"put","type":"path","servers":["987b4dcd-9d5f-4357-a99f-0dbd47556601","a53b6fbc-bcf4-4920-9f87-1223f86cceba"],"path":"/subscriptions/{id}/cancel","baseUrlOptions":["https://coreapi.io","https://preview.coreapi.io"],"title":"Cancel subscription","codeSamples":[{"label":"cURL","lang":"bash","source":"curl -X PUT \\\n /subscriptions/{id}/cancel \\\n --header \"Content-Type: application/json\" \\\n --header \"Authorization: Bearer \u003ctoken>\" \\\n --data '{\n \"cancellationDateType\": \"next_possible\",\n \"cancellationDate\": \"2022-12-31\",\n \"sendConfirmationEmail\": \"1\",\n \"reason\": \"\"\n}'"}],"requestExampleLanguages":["bash","python","javascript","php"],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"3241641b-45f2-4820-a3d5-1ea6714831f1":{"name":"id","in":"path","description":"Subscription identifier","required":true,"deprecated":false,"schema":{"type":"string","isRequired":true,"description":"Subscription identifier","uniqueKey":"","typeLabel":"string"},"style":"simple","explode":false}},"requestBody":{"description":"The updated Subscription resource","content":{"application/json":{"schema":{"type":"object","description":"","deprecated":false,"properties":{"cancellationDateType":{"description":"The type how the cancellation date should be interpreted.","example":"next_possible","type":"string","enum":["immediate","next_possible","custom"],"uniqueKey":"cancellationDateType","typeLabel":"enum\u003cstring>"},"cancellationDate":{"oneOf":[{"description":"The date when the subscription should be cancelled. Required if the type is `custom`.","example":"2022-12-31","type":"string","format":"date-time","uniqueKey":"cancellationDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The date when the subscription should be cancelled. Required if the type is `custom`.","example":"2022-12-31","type":"null","format":"date-time","uniqueKey":"cancellationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellationDate","typeLabel":"string\u003cdate-time> | null"},"sendConfirmationEmail":{"description":"If the confirmation email should be sent to the customer.","example":true,"type":"boolean","uniqueKey":"sendConfirmationEmail","typeLabel":"boolean"},"reason":{"oneOf":[{"description":"The reason code why the subscription should be cancelled.","type":"string","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"description":"The reason code why the subscription should be cancelled.","type":"null","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"cancellationDateType":"next_possible","cancellationDate":"2022-12-31","sendConfirmationEmail":true,"reason":"\u003cstring>"}}},"exampleType":"generated"},"text/html":{"schema":{"type":"object","description":"","deprecated":false,"properties":{"cancellationDateType":{"description":"The type how the cancellation date should be interpreted.","example":"next_possible","type":"string","enum":["immediate","next_possible","custom"],"uniqueKey":"cancellationDateType","typeLabel":"enum\u003cstring>"},"cancellationDate":{"oneOf":[{"description":"The date when the subscription should be cancelled. Required if the type is `custom`.","example":"2022-12-31","type":"string","format":"date-time","uniqueKey":"cancellationDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The date when the subscription should be cancelled. Required if the type is `custom`.","example":"2022-12-31","type":"null","format":"date-time","uniqueKey":"cancellationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellationDate","typeLabel":"string\u003cdate-time> | null"},"sendConfirmationEmail":{"description":"If the confirmation email should be sent to the customer.","example":true,"type":"boolean","uniqueKey":"sendConfirmationEmail","typeLabel":"boolean"},"reason":{"oneOf":[{"description":"The reason code why the subscription should be cancelled.","type":"string","uniqueKey":"reason.oneOf.0","typeLabel":"string"},{"description":"The reason code why the subscription should be cancelled.","type":"null","uniqueKey":"reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"reason","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"cancellationDateType":"next_possible","cancellationDate":"2022-12-31","sendConfirmationEmail":true,"reason":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"4c00d650-a7d1-4560-95f1-e53f11559804":{"description":"Subscription resource updated","content":{"application/json":{"schema":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"example":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","type":"string","uniqueKey":"id","typeLabel":"string"},"externalId":{"oneOf":[{"type":"string","uniqueKey":"externalId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalId","typeLabel":"string | null"},"paymentMethod":{"oneOf":[{"type":"object","description":"The payment method of the subscription. If null, the default payment method of the customer is used.","properties":{"id":{"readOnly":true,"type":"string","description":"Unique identifier of the payment method","example":"c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b","uniqueKey":"paymentMethod.oneOf.0.id","typeLabel":"string"},"gatewayName":{"type":"string","enum":["wallet","sepa_debit","stripe","fake_provider","paypal","bank_transfer","go_cardless","testing"],"description":"The payment gateway used to process the payment method","uniqueKey":"paymentMethod.oneOf.0.gatewayName","typeLabel":"enum\u003cstring>"},"type":{"oneOf":[{"type":"string","enum":["sepa_debit","card","paypal","bank_transfer","wallet","fake_provider",null],"description":"The type of the payment method","uniqueKey":"paymentMethod.oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["sepa_debit","card","paypal","bank_transfer","wallet","fake_provider",null],"description":"The type of the payment method","uniqueKey":"paymentMethod.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.type","typeLabel":"enum\u003cstring> | null"},"default":{"type":"boolean","description":"Whether this is the default payment method for the customer","example":true,"uniqueKey":"paymentMethod.oneOf.0.default","typeLabel":"boolean"},"status":{"default":"active","example":"active","type":"string","enum":["active","action_required","expired","revoked","gateway_unconfigured"],"description":"The current status of the payment method","uniqueKey":"paymentMethod.oneOf.0.status","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"Whether the payment method is enabled for use","example":true,"uniqueKey":"paymentMethod.oneOf.0.enabled","typeLabel":"boolean"},"name":{"oneOf":[{"type":"string","description":"Display name of the payment method","example":"Visa (4242)","uniqueKey":"paymentMethod.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display name of the payment method","example":"Visa (4242)","uniqueKey":"paymentMethod.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.name","typeLabel":"string | null"},"creationDate":{"readOnly":true,"type":"string","format":"date-time","description":"The date when the payment method was created","example":"2024-01-15T10:30:00+00:00","uniqueKey":"paymentMethod.oneOf.0.creationDate","typeLabel":"string\u003cdate-time>"},"expirationDate":{"oneOf":[{"type":"string","format":"date-time","description":"The expiration date of the payment method, if applicable","example":"2026-12-31T23:59:59+00:00","uniqueKey":"paymentMethod.oneOf.0.expirationDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The expiration date of the payment method, if applicable","example":"2026-12-31T23:59:59+00:00","uniqueKey":"paymentMethod.oneOf.0.expirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.expirationDate","typeLabel":"string\u003cdate-time> | null"},"card":{"readOnly":true,"description":"The card data of the payment method, if the type is \"card\"","type":"object","properties":{"brand":{"type":"string","example":"Visa","description":"The brand of the card","uniqueKey":"paymentMethod.oneOf.0.card.brand","typeLabel":"string"},"last4":{"type":"string","example":"4242","description":"The last 4 digits of the card","uniqueKey":"paymentMethod.oneOf.0.card.last4","typeLabel":"string"},"expMonth":{"type":"integer","example":12,"description":"The expiration month of the card","uniqueKey":"paymentMethod.oneOf.0.card.expMonth","typeLabel":"integer"},"expYear":{"type":"integer","example":2022,"description":"The expiration year of the card","uniqueKey":"paymentMethod.oneOf.0.card.expYear","typeLabel":"integer"},"cardHolder":{"type":"string","example":"Max Mustermann","description":"The card holder name","uniqueKey":"paymentMethod.oneOf.0.card.cardHolder","typeLabel":"string"}},"uniqueKey":"paymentMethod.oneOf.0.card","typeLabel":"object"},"sepaDebit":{"readOnly":true,"description":"The sepa mandate data of the payment method, if the type is \"sepa_debit\"","type":"object","properties":{"iban":{"type":"string","example":"DE8937*********3232","description":"The iban of the sepa mandate","uniqueKey":"paymentMethod.oneOf.0.sepaDebit.iban","typeLabel":"string"},"bic":{"type":"string","example":"COBADEFFXXX","description":"The bic of the sepa mandate","uniqueKey":"paymentMethod.oneOf.0.sepaDebit.bic","typeLabel":"string"},"mandateReference":{"type":"string","example":"MNDT-2021-123456","description":"The mandate reference of the sepa mandate","uniqueKey":"paymentMethod.oneOf.0.sepaDebit.mandateReference","typeLabel":"string"},"signingDate":{"type":"string","example":"2021-01-01T00:00:00+00:00","description":"The signing date of the sepa mandate","uniqueKey":"paymentMethod.oneOf.0.sepaDebit.signingDate","typeLabel":"string"}},"uniqueKey":"paymentMethod.oneOf.0.sepaDebit","typeLabel":"object"},"paypal":{"readOnly":true,"description":"The paypal data of the payment method, if the type is \"paypal\"","type":"object","properties":{"email":{"type":"string","example":"max@mustermann.de","description":"The email of the paypal account","uniqueKey":"paymentMethod.oneOf.0.paypal.email","typeLabel":"string"},"billingAgreementId":{"type":"string","example":"I-1J5gqz2eZvKYlo2C2X2X2X2X","description":"The billing agreement id of the paypal account","uniqueKey":"paymentMethod.oneOf.0.paypal.billingAgreementId","typeLabel":"string"}},"uniqueKey":"paymentMethod.oneOf.0.paypal","typeLabel":"object"}},"uniqueKey":"paymentMethod.oneOf.0","typeLabel":"object"},{"type":"null","description":"The payment method of the subscription. If null, the default payment method of the customer is used.","uniqueKey":"paymentMethod.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod","typeLabel":"object | null"},"invoiceAddress":{"oneOf":[{"type":"object","description":"The invoice address of the subscription. If null, the default invoice address of the customer is used.","properties":{"id":{"readOnly":true,"type":"string","uniqueKey":"invoiceAddress.oneOf.0.id","typeLabel":"string"},"vatId":{"oneOf":[{"description":"VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.","example":"DE123456789","type":"string","uniqueKey":"invoiceAddress.oneOf.0.vatId.oneOf.0","typeLabel":"string"},{"description":"VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.","example":"DE123456789","type":"null","uniqueKey":"invoiceAddress.oneOf.0.vatId.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress.oneOf.0.vatId","typeLabel":"string | null"},"type":{"example":"TYPE_DEFAULT","enum":["TYPE_DEFAULT","TYPE_INVOICE"],"type":"string","uniqueKey":"invoiceAddress.oneOf.0.type","typeLabel":"enum\u003cstring>"},"default":{"example":"true","type":"boolean","uniqueKey":"invoiceAddress.oneOf.0.default","typeLabel":"boolean"},"status":{"readOnly":true,"example":"active","enum":["active","archived"],"type":"string","uniqueKey":"invoiceAddress.oneOf.0.status","typeLabel":"enum\u003cstring>"},"city":{"example":"Berlin","type":"string","uniqueKey":"invoiceAddress.oneOf.0.city","typeLabel":"string"},"zip":{"example":"12345","type":"string","uniqueKey":"invoiceAddress.oneOf.0.zip","typeLabel":"string"},"street":{"example":"Musterstraße","type":"string","uniqueKey":"invoiceAddress.oneOf.0.street","typeLabel":"string"},"houseNumber":{"example":"1a","type":"string","uniqueKey":"invoiceAddress.oneOf.0.houseNumber","typeLabel":"string"},"countryCode":{"example":"DE","type":"string","uniqueKey":"invoiceAddress.oneOf.0.countryCode","typeLabel":"string"},"companyName":{"oneOf":[{"description":"Company name, which will be used to bill to.","example":"ACME Inc.","type":"string","uniqueKey":"invoiceAddress.oneOf.0.companyName.oneOf.0","typeLabel":"string"},{"description":"Company name, which will be used to bill to.","example":"ACME Inc.","type":"null","uniqueKey":"invoiceAddress.oneOf.0.companyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress.oneOf.0.companyName","typeLabel":"string | null"},"salutation":{"example":"Herr","enum":["Firma","Herr","Frau"],"type":"string","uniqueKey":"invoiceAddress.oneOf.0.salutation","typeLabel":"enum\u003cstring>"},"addition":{"oneOf":[{"description":"Additional address information, which will be shown on generated documents like invoices, reminders, etc.","example":"c/o John Doe","type":"string","uniqueKey":"invoiceAddress.oneOf.0.addition.oneOf.0","typeLabel":"string"},{"description":"Additional address information, which will be shown on generated documents like invoices, reminders, etc.","example":"c/o John Doe","type":"null","uniqueKey":"invoiceAddress.oneOf.0.addition.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress.oneOf.0.addition","typeLabel":"string | null"},"costCentre":{"oneOf":[{"description":"Cost centre, which will be shown on generated documents like invoices, reminders, etc.","example":"123456789","type":"string","uniqueKey":"invoiceAddress.oneOf.0.costCentre.oneOf.0","typeLabel":"string"},{"description":"Cost centre, which will be shown on generated documents like invoices, reminders, etc.","example":"123456789","type":"null","uniqueKey":"invoiceAddress.oneOf.0.costCentre.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress.oneOf.0.costCentre","typeLabel":"string | null"},"firstName":{"oneOf":[{"description":"First name, which will be shown on generated documents like invoices, reminders, etc.","example":"John","type":"string","uniqueKey":"invoiceAddress.oneOf.0.firstName.oneOf.0","typeLabel":"string"},{"description":"First name, which will be shown on generated documents like invoices, reminders, etc.","example":"John","type":"null","uniqueKey":"invoiceAddress.oneOf.0.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress.oneOf.0.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"description":"Last name, which will be shown on generated documents like invoices, reminders, etc.","example":"Doe","type":"string","uniqueKey":"invoiceAddress.oneOf.0.lastName.oneOf.0","typeLabel":"string"},{"description":"Last name, which will be shown on generated documents like invoices, reminders, etc.","example":"Doe","type":"null","uniqueKey":"invoiceAddress.oneOf.0.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress.oneOf.0.lastName","typeLabel":"string | null"}},"uniqueKey":"invoiceAddress.oneOf.0","typeLabel":"object"},{"type":"null","description":"The invoice address of the subscription. If null, the default invoice address of the customer is used.","uniqueKey":"invoiceAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress","typeLabel":"object | null"},"number":{"description":"The number of the subscription.","example":"S-00000001","type":"string","uniqueKey":"number","typeLabel":"string"},"customer":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"example":"00000000-0000-0000-0000-000000000000","type":"string","uniqueKey":"customer.id","typeLabel":"string"},"customerNumber":{"minLength":2,"maxLength":255,"example":"CUSTOMER-000","nullable":false,"type":"string","uniqueKey":"customer.customerNumber","typeLabel":"string"},"timeZone":{"readOnly":true,"default":"Europe/Berlin","example":"Europe/Berlin","type":"string","uniqueKey":"customer.timeZone","typeLabel":"string"},"firstName":{"oneOf":[{"minLength":2,"maxLength":255,"description":"Can be empty if the customer is a company.","example":"John","type":"string","uniqueKey":"customer.firstName.oneOf.0","typeLabel":"string"},{"minLength":2,"maxLength":255,"description":"Can be empty if the customer is a company.","example":"John","type":"null","uniqueKey":"customer.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"minLength":2,"maxLength":255,"description":"Can be empty if the customer is a company.","example":"Doe","type":"string","uniqueKey":"customer.lastName.oneOf.0","typeLabel":"string"},{"minLength":2,"maxLength":255,"description":"Can be empty if the customer is a company.","example":"Doe","type":"null","uniqueKey":"customer.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.lastName","typeLabel":"string | null"},"currencyCode":{"description":"Can be empty. In this case the default currency of the tenant is used.","externalDocs":{"url":"https://schema.org/priceCurrency"},"example":"EUR","type":"string","uniqueKey":"customer.currencyCode","typeLabel":"string"},"companyName":{"oneOf":[{"minLength":2,"maxLength":255,"example":"Acme Inc.","type":"string","uniqueKey":"customer.companyName.oneOf.0","typeLabel":"string"},{"minLength":2,"maxLength":255,"example":"Acme Inc.","type":"null","uniqueKey":"customer.companyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.companyName","typeLabel":"string | null"},"datevId":{"oneOf":[{"minLength":2,"maxLength":255,"description":"The ID of the customer in DATEV","example":"123456789","type":"string","uniqueKey":"customer.datevId.oneOf.0","typeLabel":"string"},{"minLength":2,"maxLength":255,"description":"The ID of the customer in DATEV","example":"123456789","type":"null","uniqueKey":"customer.datevId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.datevId","typeLabel":"string | null"},"status":{"default":"STATUS_ACTIVE","example":"STATUS_ACTIVE","enum":["STATUS_ACTIVE","STATUS_ARCHIVED","STATUS_SUSPENDED"],"type":"string","uniqueKey":"customer.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"customer","typeLabel":"object"},"plan":{"oneOf":[{"type":"object","description":"The plan this subscription is based on.","properties":{"id":{"readOnly":true,"description":"The unique identifier of the plan.","example":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","type":"string","uniqueKey":"plan.oneOf.0.id","typeLabel":"string"},"family":{"oneOf":[{"type":"object","description":"Allow to group plans together. This allows to upgrade or downgrade between plans in the same family.","properties":{"id":{"readOnly":true,"example":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","type":"string","uniqueKey":"plan.oneOf.0.family.oneOf.0.id","typeLabel":"string"},"createdAt":{"readOnly":true,"description":"The date and time when the resource was created.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"plan.oneOf.0.family.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"readOnly":true,"description":"The date and time when the resource was last updated.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"plan.oneOf.0.family.oneOf.0.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"plan.oneOf.0.family.oneOf.0","typeLabel":"object"},{"type":"null","description":"Allow to group plans together. This allows to upgrade or downgrade between plans in the same family.","uniqueKey":"plan.oneOf.0.family.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.family","typeLabel":"object | null"},"code":{"description":"The code of the plan. This is used to identify the plan e.g. in the checkout url.","example":"basic-m2023","type":"string","uniqueKey":"plan.oneOf.0.code","typeLabel":"string"},"originProduct":{"oneOf":[{"type":"object","description":"The origin product this plan belongs to. This is relevant for advanced analytics.","required":["type","measurement","taxGroup"],"properties":{"type":{"description":"The type of the product.\n - `product`: recurring billed product\n - `charge`: one-time billing\n - `plan`: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.\n","type":"string","enum":["product","charge","plan"],"isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.type","typeLabel":"enum\u003cstring>"},"measurement":{"type":"object","description":"The measurement that is used for the price plan. This could define the quantity or a metered usage.","deprecated":false,"properties":{"unit":{"oneOf":[{"type":"object","description":"The unit of the measurement.","properties":{"id":{"type":"object","description":"","deprecated":false,"readOnly":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit.oneOf.0.id","typeLabel":"object"},"name":{"example":"Stück","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit.oneOf.0.name","typeLabel":"string"},"createdAt":{"readOnly":true,"description":"The date and time when the resource was created.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"readOnly":true,"description":"The date and time when the resource was last updated.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit.oneOf.0.updatedAt","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit.oneOf.0","typeLabel":"object"},{"type":"null","description":"The unit of the measurement.","isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit","typeLabel":"object | null"},"code":{"minLength":1,"maxLength":255,"description":"A unique code which can be used to identify the measurement.","example":"users","type":"string","isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.code","typeLabel":"string"},"id":{"readOnly":true,"description":"A unique identifier for the measurement.","example":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.id","typeLabel":"string"},"description":{"oneOf":[{"maxLength":255,"description":"A description of the measurement, which is shown in the summary of the usage data in the invoice.","example":"The number of users.","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.description.oneOf.0","typeLabel":"string"},{"maxLength":255,"description":"A description of the measurement, which is shown in the summary of the usage data in the invoice.","example":"The number of users.","type":"null","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.description","typeLabel":"string | null"},"aggregationType":{"description":"The aggregation type of the measurement. Describes how the quantity is calculated. This cannot be changed after creation, otherwise it would change the whole calculation for existing subscriptions.\n\nPossible values:\n * `count`: The number of sent measurements in the billing interval. Metered usage, which resets to 0 after each billing interval.\n * `count_unique`: The number of unique sent measurements in the billing interval, identified by the id given on event creation.\n * `max`: The maximum value of all sent measurements in the billing interval. Metered usage, which resets to 0 after each billing interval.\n * `sum`: The sum of all sent measurements in the billing interval.\n * `last_value`: The last sent measurement.\n * `average`: The average of all sent measurements in the billing interval.","default":"last_value","example":"sum","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.aggregationType","typeLabel":"any"},"fairBilling":{"description":"If set to false, the measurement will be billed for the whole billing interval, even if the quantity changes, or the item is cancelled / terminated during the billing interval.","default":true,"example":true,"type":"boolean","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.fairBilling","typeLabel":"boolean"},"type":{"description":"The type of the measurement. This cannot be changed after creation, otherwise it would change the whole calculation for existing subscriptions.\n\nPossible values:\n * `instant_metered`: The measurement value is reset to 0 after each push. The measurement gets billed immediately and an invoice is created. The aggregation type must be \"last_value\".\n * `metered`: The measurement value is reset to 0 after each billing interval.\n * `recurring`: The measurement value is not reset to 0 after each billing interval and the last value is used for all following billing intervals. The aggregation type must be \"last_value\".","default":"recurring","example":"recurring","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.type","typeLabel":"any"}},"required":["unit","code"],"isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement","typeLabel":"object"},"taxGroup":{"type":"object","description":"The tax group that is used for the product.","deprecated":false,"isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.taxGroup","typeLabel":"object"},"id":{"readOnly":true,"description":"The unique identifier of the product.","example":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.id","typeLabel":"string"},"name":{"description":"The name of the product based on the current tenant language. This will be displayed on customer communication.","example":"Basic","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.name","typeLabel":"string"},"description":{"oneOf":[{"description":"The description of the product based on the current tenant language.","example":"For small teams.","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.description.oneOf.0","typeLabel":"string"},{"description":"The description of the product based on the current tenant language.","example":"For small teams.","type":"null","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.description","typeLabel":"string | null"},"internalName":{"oneOf":[{"description":"Internal name of the product, to differentiate between products with the same name. This will shown in web-app lists, selections and reports.","example":"Basic (Weekly)","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.internalName.oneOf.0","typeLabel":"string"},{"description":"Internal name of the product, to differentiate between products with the same name. This will shown in web-app lists, selections and reports.","example":"Basic (Weekly)","type":"null","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.internalName.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.internalName","typeLabel":"string | null"},"invoiceVisibility":{"description":"Defines when the product should be displayed in the invoice.\n - `always`: The product is always displayed in the invoice.\n - `only_if_charged`: The product is only displayed in the invoice if it is charged.\n","type":"string","enum":["always","only_if_charged"],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.invoiceVisibility","typeLabel":"enum\u003cstring>"},"costCentre":{"oneOf":[{"type":"object","description":"The cost centre is used for accounting exports.","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.costCentre.oneOf.0","typeLabel":"object"},{"type":"null","description":"The cost centre is used for accounting exports.","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.costCentre.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.costCentre","typeLabel":"object | null"},"costCentre2":{"oneOf":[{"type":"object","description":"The KOST2 cost centre is used for accounting exports (DATEV axis KOST2).","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.costCentre2.oneOf.0","typeLabel":"object"},{"type":"null","description":"The KOST2 cost centre is used for accounting exports (DATEV axis KOST2).","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.costCentre2.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.costCentre2","typeLabel":"object | null"},"customFields":{"oneOf":[{"additionalProperties":{"type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.customFields.oneOf.0.additionalProperties","typeLabel":"string"},"type":"object","example":{"field1":"value1","field2":"value2"},"description":"Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under \\\"/custom-fields\\\" in the API documentation. The input is validated against the configuration. For more details see [Custom Fields Guide](/guide/tenant/custom-fields)","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.customFields.oneOf.0","typeLabel":"object"},{"additionalProperties":{"type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.customFields.oneOf.1.additionalProperties","typeLabel":"string"},"type":"null","example":{"field1":"value1","field2":"value2"},"description":"Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under \\\"/custom-fields\\\" in the API documentation. The input is validated against the configuration. For more details see [Custom Fields Guide](/guide/tenant/custom-fields)","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.customFields.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.customFields","typeLabel":"object | null"}},"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0","typeLabel":"object"},{"type":"null","description":"The origin product this plan belongs to. This is relevant for advanced analytics.","uniqueKey":"plan.oneOf.0.originProduct.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct","typeLabel":"object | null"},"allowCheckout":{"description":"Allow to checkout this plan. If this is set to false, the plan will not be available in the checkout and can only be assigned to a subscription by the API or in the admin panel. The plan.code is a part of the checkout url.","default":true,"example":true,"type":"boolean","uniqueKey":"plan.oneOf.0.allowCheckout","typeLabel":"boolean"},"status":{"readOnly":true,"description":"The status of the plan.\n\nPossible values:\n * `draft`: The plan is a draft and not available for usage in a subscription.\n * `active`: The plan is active and can be used in a subscription.\n * `archived`: The plan is archived and not longer available for usage in a subscription.\n * `inactive`: The plan is inactive and not available for usage in a subscription.","default":"draft","example":"draft","uniqueKey":"plan.oneOf.0.status","typeLabel":"any"},"changeBehaviour":{"description":"Define the allowed actions after subscription by customer, for upgrade / downgrade.","default":"not_changeable","example":"upgradeable_and_downgradeable","type":"string","enum":["upgradeable","downgradeable","upgradeable_and_downgradeable","not_changeable"],"uniqueKey":"plan.oneOf.0.changeBehaviour","typeLabel":"enum\u003cstring>"},"changeApplyBehaviour":{"description":"Define the behaviour when a plan change will be applied. If null the default behaviour will be used.","default":"end_of_period","example":"end_of_period","type":"string","enum":["immediately","end_of_period"],"uniqueKey":"plan.oneOf.0.changeApplyBehaviour","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"plan.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"name":{"readOnly":true,"description":"The name of this plan","type":"string","uniqueKey":"plan.oneOf.0.name","typeLabel":"string"},"description":{"oneOf":[{"readOnly":true,"description":"The description of this plan","type":"string","uniqueKey":"plan.oneOf.0.description.oneOf.0","typeLabel":"string"},{"readOnly":true,"description":"The description of this plan","type":"null","uniqueKey":"plan.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.description","typeLabel":"string | null"}},"uniqueKey":"plan.oneOf.0","typeLabel":"object"},{"type":"null","description":"The plan this subscription is based on.","uniqueKey":"plan.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan","typeLabel":"object | null"},"name":{"oneOf":[{"description":"The name of the subscription. Defaults to the name of the plan. This will be used in the invoice for the grouping headers.","example":"Fitness M","type":"string","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"description":"The name of the subscription. Defaults to the name of the plan. This will be used in the invoice for the grouping headers.","example":"Fitness M","type":"null","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"billingGroup":{"oneOf":[{"type":"object","description":"The billing group defines the billing cycle of the subscription.","uniqueKey":"billingGroup.oneOf.0","typeLabel":"object"},{"type":"null","description":"The billing group defines the billing cycle of the subscription.","uniqueKey":"billingGroup.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingGroup","typeLabel":"object | null"},"periods":{"type":"array","items":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"type":"string","uniqueKey":"periods.items.[INDEX].id","typeLabel":"string"},"contractPeriodCount":{"readOnly":true,"type":"integer","uniqueKey":"periods.items.[INDEX].contractPeriodCount","typeLabel":"integer"},"contractPeriod":{"type":"object","description":"","deprecated":false,"readOnly":true,"uniqueKey":"periods.items.[INDEX].contractPeriod","typeLabel":"object"},"cancellationPeriod":{"type":"object","description":"","deprecated":false,"readOnly":true,"uniqueKey":"periods.items.[INDEX].cancellationPeriod","typeLabel":"object"},"createdAt":{"readOnly":true,"type":"string","format":"date-time","uniqueKey":"periods.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"readOnly":true,"type":"string","format":"date-time","uniqueKey":"periods.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"periods.items.[INDEX]","typeLabel":"object"},"uniqueKey":"periods","typeLabel":"object[]"},"status":{"readOnly":true,"description":"The status of the subscription.\n\nPossible values:\n * `draft`: The subscription is in draft mode and not active yet.\n * `active`: The subscription is active and will be billed.\n * `paused`: The subscription is paused and will not be billed.\n * `cancelled`: The subscription is cancelled and will not be billed anymore.\n * `terminated`: The subscription is terminated and will not be billed anymore.\n * `offer`: The subscription is an offer and waiting for acceptance.","example":"active","uniqueKey":"status","typeLabel":"any"},"activatedAt":{"oneOf":[{"readOnly":true,"description":"The date the subscription was activated.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"activatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"readOnly":true,"description":"The date the subscription was activated.","example":"2021-01-01T00:00:00+00:00","type":"null","format":"date-time","uniqueKey":"activatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"activatedAt","typeLabel":"string\u003cdate-time> | null"},"poNumber":{"oneOf":[{"description":"The po number of the subscription.","example":"PO-00000001","type":"string","uniqueKey":"poNumber.oneOf.0","typeLabel":"string"},{"description":"The po number of the subscription.","example":"PO-00000001","type":"null","uniqueKey":"poNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"poNumber","typeLabel":"string | null"},"contractDetails":{"type":"object","description":"The contract details of the subscription.","deprecated":false,"properties":{"contractStart":{"description":"The start of the contract.","type":"string","format":"date-time","uniqueKey":"contractDetails.contractStart","typeLabel":"string\u003cdate-time>"},"contractEnd":{"oneOf":[{"description":"The end of the contract.","type":"string","format":"date-time","uniqueKey":"contractDetails.contractEnd.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The end of the contract.","type":"null","format":"date-time","uniqueKey":"contractDetails.contractEnd.oneOf.1","typeLabel":"null"}],"uniqueKey":"contractDetails.contractEnd","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"contractDetails","typeLabel":"object"},"trialEndsOn":{"oneOf":[{"readOnly":true,"description":"The date the trial period ends.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"trialEndsOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"readOnly":true,"description":"The date the trial period ends.","example":"2021-01-01T00:00:00+00:00","type":"null","format":"date-time","uniqueKey":"trialEndsOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"trialEndsOn","typeLabel":"string\u003cdate-time> | null"},"customFields":{"oneOf":[{"additionalProperties":{"type":"string","uniqueKey":"customFields.oneOf.0.additionalProperties","typeLabel":"string"},"type":"object","example":{"field1":"value1","field2":"value2"},"description":"Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under \\\"/custom-fields\\\" in the API documentation. The input is validated against the configuration. For more details see [Custom Fields Guide](/guide/tenant/custom-fields)","uniqueKey":"customFields.oneOf.0","typeLabel":"object"},{"additionalProperties":{"type":"string","uniqueKey":"customFields.oneOf.1.additionalProperties","typeLabel":"string"},"type":"null","example":{"field1":"value1","field2":"value2"},"description":"Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under \\\"/custom-fields\\\" in the API documentation. The input is validated against the configuration. For more details see [Custom Fields Guide](/guide/tenant/custom-fields)","uniqueKey":"customFields.oneOf.1","typeLabel":"null"}],"uniqueKey":"customFields","typeLabel":"object | null"},"createdAt":{"readOnly":true,"description":"The date and time when the resource was created.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"readOnly":true,"description":"The date and time when the resource was last updated.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"defaultPaymentMethod":{"readOnly":true,"description":"The payment method is null, we use the default payment method of the customer.","type":"boolean","uniqueKey":"defaultPaymentMethod","typeLabel":"boolean"},"defaultInvoiceAddress":{"readOnly":true,"description":"The invoice address is null, we use the default invoice address of the customer.","type":"boolean","uniqueKey":"defaultInvoiceAddress","typeLabel":"boolean"},"nextBillingDate":{"oneOf":[{"readOnly":true,"description":"The next billing date of the subscription.","type":"string","format":"date-time","uniqueKey":"nextBillingDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"readOnly":true,"description":"The next billing date of the subscription.","type":"null","format":"date-time","uniqueKey":"nextBillingDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"nextBillingDate","typeLabel":"string\u003cdate-time> | null"},"lastBillingAt":{"oneOf":[{"readOnly":true,"description":"The last billing date of the subscription.","type":"string","format":"date-time","uniqueKey":"lastBillingAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"readOnly":true,"description":"The last billing date of the subscription.","type":"null","format":"date-time","uniqueKey":"lastBillingAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastBillingAt","typeLabel":"string\u003cdate-time> | null"},"cancellationDate":{"oneOf":[{"readOnly":true,"description":"The date the subscription will be cancelled.","type":"string","format":"date-time","uniqueKey":"cancellationDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"readOnly":true,"description":"The date the subscription will be cancelled.","type":"null","format":"date-time","uniqueKey":"cancellationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellationDate","typeLabel":"string\u003cdate-time> | null"},"cancelledAt":{"oneOf":[{"readOnly":true,"description":"The date when the subscription was cancelled.","type":"string","format":"date-time","uniqueKey":"cancelledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"readOnly":true,"description":"The date when the subscription was cancelled.","type":"null","format":"date-time","uniqueKey":"cancelledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancelledAt","typeLabel":"string\u003cdate-time> | null"},"isCancellationPending":{"readOnly":true,"description":"Indicates if the subscription is pending for cancellation. If true, the subscription will be cancelled in the future and the cancellation could be revoked.","type":"boolean","uniqueKey":"isCancellationPending","typeLabel":"boolean"},"nextPossibleCancellationDate":{"oneOf":[{"readOnly":true,"type":"array","items":{"type":"string","uniqueKey":"nextPossibleCancellationDate.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"nextPossibleCancellationDate.oneOf.0","typeLabel":"string[]"},{"readOnly":true,"type":"null","items":{"type":"string"},"uniqueKey":"nextPossibleCancellationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"nextPossibleCancellationDate","typeLabel":"string[] | null"},"partner":{"oneOf":[{"type":"object","description":"The partner of the customer.","properties":{"id":{"description":"The ID of the partner","example":"ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b","type":"string","uniqueKey":"partner.oneOf.0.id","typeLabel":"string"},"name":{"description":"The name of the partner","example":"John Doe","type":"string","uniqueKey":"partner.oneOf.0.name","typeLabel":"string"},"number":{"description":"The customer number of the partner","example":"123456","type":"string","uniqueKey":"partner.oneOf.0.number","typeLabel":"string"},"email":{"oneOf":[{"description":"The email address of the partner","example":"partner@example.com","type":"string","uniqueKey":"partner.oneOf.0.email.oneOf.0","typeLabel":"string"},{"description":"The email address of the partner","example":"partner@example.com","type":"null","uniqueKey":"partner.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"partner.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"partner.oneOf.0","typeLabel":"object"},{"type":"null","description":"The partner of the customer.","uniqueKey":"partner.oneOf.1","typeLabel":"null"}],"uniqueKey":"partner","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","externalId":"\u003cstring>","paymentMethod":{"id":"c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b","gatewayName":"wallet","type":"sepa_debit","default":true,"status":"active","enabled":true,"name":"Visa (4242)","creationDate":"2024-01-15T10:30:00+00:00","expirationDate":"2026-12-31T23:59:59+00:00","card":{"brand":"Visa","last4":"4242","expMonth":12,"expYear":2022,"cardHolder":"Max Mustermann"},"sepaDebit":{"iban":"DE8937*********3232","bic":"COBADEFFXXX","mandateReference":"MNDT-2021-123456","signingDate":"2021-01-01T00:00:00+00:00"},"paypal":{"email":"max@mustermann.de","billingAgreementId":"I-1J5gqz2eZvKYlo2C2X2X2X2X"}},"invoiceAddress":{"id":"\u003cstring>","vatId":"DE123456789","type":"TYPE_DEFAULT","default":"true","status":"active","city":"Berlin","zip":"12345","street":"Musterstraße","houseNumber":"1a","countryCode":"DE","companyName":"ACME Inc.","salutation":"Herr","addition":"c/o John Doe","costCentre":"123456789","firstName":"John","lastName":"Doe"},"number":"S-00000001","customer":{"id":"00000000-0000-0000-0000-000000000000","customerNumber":"CUSTOMER-000","timeZone":"Europe/Berlin","firstName":"John","lastName":"Doe","currencyCode":"EUR","companyName":"Acme Inc.","datevId":"123456789","status":"STATUS_ACTIVE"},"plan":{"id":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","family":{"id":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","createdAt":"2021-01-01T00:00:00+00:00","updatedAt":"2021-01-01T00:00:00+00:00"},"code":"basic-m2023","originProduct":{"type":"product","measurement":{"unit":{"id":{},"name":"Stück","createdAt":"2021-01-01T00:00:00+00:00","updatedAt":"2021-01-01T00:00:00+00:00"},"code":"users","id":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","description":"The number of users.","aggregationType":"sum","fairBilling":true,"type":"recurring"},"taxGroup":{},"id":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","name":"Basic","description":"For small teams.","internalName":"Basic (Weekly)","invoiceVisibility":"always","costCentre":{},"costCentre2":{},"customFields":{"field1":"value1","field2":"value2"}},"allowCheckout":true,"status":"draft","changeBehaviour":"upgradeable_and_downgradeable","changeApplyBehaviour":"end_of_period","createdAt":"2023-11-07T05:31:56Z","name":"\u003cstring>","description":"\u003cstring>"},"name":"Fitness M","billingGroup":{},"periods":[{"id":"\u003cstring>","contractPeriodCount":123,"contractPeriod":{},"cancellationPeriod":{},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}],"status":"active","activatedAt":"2021-01-01T00:00:00+00:00","poNumber":"PO-00000001","contractDetails":{"contractStart":"2023-11-07T05:31:56Z","contractEnd":"2023-11-07T05:31:56Z"},"trialEndsOn":"2021-01-01T00:00:00+00:00","customFields":{"field1":"value1","field2":"value2"},"createdAt":"2021-01-01T00:00:00+00:00","updatedAt":"2021-01-01T00:00:00+00:00","defaultPaymentMethod":true,"defaultInvoiceAddress":true,"nextBillingDate":"2023-11-07T05:31:56Z","lastBillingAt":"2023-11-07T05:31:56Z","cancellationDate":"2023-11-07T05:31:56Z","cancelledAt":"2023-11-07T05:31:56Z","isCancellationPending":true,"nextPossibleCancellationDate":["\u003cstring>"],"partner":{"id":"ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b","name":"John Doe","number":"123456","email":"partner@example.com"}}}},"exampleType":"generated"},"text/html":{"schema":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"example":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","type":"string","uniqueKey":"id","typeLabel":"string"},"externalId":{"oneOf":[{"type":"string","uniqueKey":"externalId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalId","typeLabel":"string | null"},"paymentMethod":{"oneOf":[{"type":"object","description":"The payment method of the subscription. If null, the default payment method of the customer is used.","properties":{"id":{"readOnly":true,"type":"string","description":"Unique identifier of the payment method","example":"c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b","uniqueKey":"paymentMethod.oneOf.0.id","typeLabel":"string"},"gatewayName":{"type":"string","enum":["wallet","sepa_debit","stripe","fake_provider","paypal","bank_transfer","go_cardless","testing"],"description":"The payment gateway used to process the payment method","uniqueKey":"paymentMethod.oneOf.0.gatewayName","typeLabel":"enum\u003cstring>"},"type":{"oneOf":[{"type":"string","enum":["sepa_debit","card","paypal","bank_transfer","wallet","fake_provider",null],"description":"The type of the payment method","uniqueKey":"paymentMethod.oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["sepa_debit","card","paypal","bank_transfer","wallet","fake_provider",null],"description":"The type of the payment method","uniqueKey":"paymentMethod.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.type","typeLabel":"enum\u003cstring> | null"},"default":{"type":"boolean","description":"Whether this is the default payment method for the customer","example":true,"uniqueKey":"paymentMethod.oneOf.0.default","typeLabel":"boolean"},"status":{"default":"active","example":"active","type":"string","enum":["active","action_required","expired","revoked","gateway_unconfigured"],"description":"The current status of the payment method","uniqueKey":"paymentMethod.oneOf.0.status","typeLabel":"enum\u003cstring>"},"enabled":{"type":"boolean","description":"Whether the payment method is enabled for use","example":true,"uniqueKey":"paymentMethod.oneOf.0.enabled","typeLabel":"boolean"},"name":{"oneOf":[{"type":"string","description":"Display name of the payment method","example":"Visa (4242)","uniqueKey":"paymentMethod.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display name of the payment method","example":"Visa (4242)","uniqueKey":"paymentMethod.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.name","typeLabel":"string | null"},"creationDate":{"readOnly":true,"type":"string","format":"date-time","description":"The date when the payment method was created","example":"2024-01-15T10:30:00+00:00","uniqueKey":"paymentMethod.oneOf.0.creationDate","typeLabel":"string\u003cdate-time>"},"expirationDate":{"oneOf":[{"type":"string","format":"date-time","description":"The expiration date of the payment method, if applicable","example":"2026-12-31T23:59:59+00:00","uniqueKey":"paymentMethod.oneOf.0.expirationDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The expiration date of the payment method, if applicable","example":"2026-12-31T23:59:59+00:00","uniqueKey":"paymentMethod.oneOf.0.expirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.oneOf.0.expirationDate","typeLabel":"string\u003cdate-time> | null"},"card":{"readOnly":true,"description":"The card data of the payment method, if the type is \"card\"","type":"object","properties":{"brand":{"type":"string","example":"Visa","description":"The brand of the card","uniqueKey":"paymentMethod.oneOf.0.card.brand","typeLabel":"string"},"last4":{"type":"string","example":"4242","description":"The last 4 digits of the card","uniqueKey":"paymentMethod.oneOf.0.card.last4","typeLabel":"string"},"expMonth":{"type":"integer","example":12,"description":"The expiration month of the card","uniqueKey":"paymentMethod.oneOf.0.card.expMonth","typeLabel":"integer"},"expYear":{"type":"integer","example":2022,"description":"The expiration year of the card","uniqueKey":"paymentMethod.oneOf.0.card.expYear","typeLabel":"integer"},"cardHolder":{"type":"string","example":"Max Mustermann","description":"The card holder name","uniqueKey":"paymentMethod.oneOf.0.card.cardHolder","typeLabel":"string"}},"uniqueKey":"paymentMethod.oneOf.0.card","typeLabel":"object"},"sepaDebit":{"readOnly":true,"description":"The sepa mandate data of the payment method, if the type is \"sepa_debit\"","type":"object","properties":{"iban":{"type":"string","example":"DE8937*********3232","description":"The iban of the sepa mandate","uniqueKey":"paymentMethod.oneOf.0.sepaDebit.iban","typeLabel":"string"},"bic":{"type":"string","example":"COBADEFFXXX","description":"The bic of the sepa mandate","uniqueKey":"paymentMethod.oneOf.0.sepaDebit.bic","typeLabel":"string"},"mandateReference":{"type":"string","example":"MNDT-2021-123456","description":"The mandate reference of the sepa mandate","uniqueKey":"paymentMethod.oneOf.0.sepaDebit.mandateReference","typeLabel":"string"},"signingDate":{"type":"string","example":"2021-01-01T00:00:00+00:00","description":"The signing date of the sepa mandate","uniqueKey":"paymentMethod.oneOf.0.sepaDebit.signingDate","typeLabel":"string"}},"uniqueKey":"paymentMethod.oneOf.0.sepaDebit","typeLabel":"object"},"paypal":{"readOnly":true,"description":"The paypal data of the payment method, if the type is \"paypal\"","type":"object","properties":{"email":{"type":"string","example":"max@mustermann.de","description":"The email of the paypal account","uniqueKey":"paymentMethod.oneOf.0.paypal.email","typeLabel":"string"},"billingAgreementId":{"type":"string","example":"I-1J5gqz2eZvKYlo2C2X2X2X2X","description":"The billing agreement id of the paypal account","uniqueKey":"paymentMethod.oneOf.0.paypal.billingAgreementId","typeLabel":"string"}},"uniqueKey":"paymentMethod.oneOf.0.paypal","typeLabel":"object"}},"uniqueKey":"paymentMethod.oneOf.0","typeLabel":"object"},{"type":"null","description":"The payment method of the subscription. If null, the default payment method of the customer is used.","uniqueKey":"paymentMethod.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod","typeLabel":"object | null"},"invoiceAddress":{"oneOf":[{"type":"object","description":"The invoice address of the subscription. If null, the default invoice address of the customer is used.","properties":{"id":{"readOnly":true,"type":"string","uniqueKey":"invoiceAddress.oneOf.0.id","typeLabel":"string"},"vatId":{"oneOf":[{"description":"VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.","example":"DE123456789","type":"string","uniqueKey":"invoiceAddress.oneOf.0.vatId.oneOf.0","typeLabel":"string"},{"description":"VAT ID, which will be used to bill to. If not provided, we will use the customer vat id.","example":"DE123456789","type":"null","uniqueKey":"invoiceAddress.oneOf.0.vatId.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress.oneOf.0.vatId","typeLabel":"string | null"},"type":{"example":"TYPE_DEFAULT","enum":["TYPE_DEFAULT","TYPE_INVOICE"],"type":"string","uniqueKey":"invoiceAddress.oneOf.0.type","typeLabel":"enum\u003cstring>"},"default":{"example":"true","type":"boolean","uniqueKey":"invoiceAddress.oneOf.0.default","typeLabel":"boolean"},"status":{"readOnly":true,"example":"active","enum":["active","archived"],"type":"string","uniqueKey":"invoiceAddress.oneOf.0.status","typeLabel":"enum\u003cstring>"},"city":{"example":"Berlin","type":"string","uniqueKey":"invoiceAddress.oneOf.0.city","typeLabel":"string"},"zip":{"example":"12345","type":"string","uniqueKey":"invoiceAddress.oneOf.0.zip","typeLabel":"string"},"street":{"example":"Musterstraße","type":"string","uniqueKey":"invoiceAddress.oneOf.0.street","typeLabel":"string"},"houseNumber":{"example":"1a","type":"string","uniqueKey":"invoiceAddress.oneOf.0.houseNumber","typeLabel":"string"},"countryCode":{"example":"DE","type":"string","uniqueKey":"invoiceAddress.oneOf.0.countryCode","typeLabel":"string"},"companyName":{"oneOf":[{"description":"Company name, which will be used to bill to.","example":"ACME Inc.","type":"string","uniqueKey":"invoiceAddress.oneOf.0.companyName.oneOf.0","typeLabel":"string"},{"description":"Company name, which will be used to bill to.","example":"ACME Inc.","type":"null","uniqueKey":"invoiceAddress.oneOf.0.companyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress.oneOf.0.companyName","typeLabel":"string | null"},"salutation":{"example":"Herr","enum":["Firma","Herr","Frau"],"type":"string","uniqueKey":"invoiceAddress.oneOf.0.salutation","typeLabel":"enum\u003cstring>"},"addition":{"oneOf":[{"description":"Additional address information, which will be shown on generated documents like invoices, reminders, etc.","example":"c/o John Doe","type":"string","uniqueKey":"invoiceAddress.oneOf.0.addition.oneOf.0","typeLabel":"string"},{"description":"Additional address information, which will be shown on generated documents like invoices, reminders, etc.","example":"c/o John Doe","type":"null","uniqueKey":"invoiceAddress.oneOf.0.addition.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress.oneOf.0.addition","typeLabel":"string | null"},"costCentre":{"oneOf":[{"description":"Cost centre, which will be shown on generated documents like invoices, reminders, etc.","example":"123456789","type":"string","uniqueKey":"invoiceAddress.oneOf.0.costCentre.oneOf.0","typeLabel":"string"},{"description":"Cost centre, which will be shown on generated documents like invoices, reminders, etc.","example":"123456789","type":"null","uniqueKey":"invoiceAddress.oneOf.0.costCentre.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress.oneOf.0.costCentre","typeLabel":"string | null"},"firstName":{"oneOf":[{"description":"First name, which will be shown on generated documents like invoices, reminders, etc.","example":"John","type":"string","uniqueKey":"invoiceAddress.oneOf.0.firstName.oneOf.0","typeLabel":"string"},{"description":"First name, which will be shown on generated documents like invoices, reminders, etc.","example":"John","type":"null","uniqueKey":"invoiceAddress.oneOf.0.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress.oneOf.0.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"description":"Last name, which will be shown on generated documents like invoices, reminders, etc.","example":"Doe","type":"string","uniqueKey":"invoiceAddress.oneOf.0.lastName.oneOf.0","typeLabel":"string"},{"description":"Last name, which will be shown on generated documents like invoices, reminders, etc.","example":"Doe","type":"null","uniqueKey":"invoiceAddress.oneOf.0.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress.oneOf.0.lastName","typeLabel":"string | null"}},"uniqueKey":"invoiceAddress.oneOf.0","typeLabel":"object"},{"type":"null","description":"The invoice address of the subscription. If null, the default invoice address of the customer is used.","uniqueKey":"invoiceAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAddress","typeLabel":"object | null"},"number":{"description":"The number of the subscription.","example":"S-00000001","type":"string","uniqueKey":"number","typeLabel":"string"},"customer":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"example":"00000000-0000-0000-0000-000000000000","type":"string","uniqueKey":"customer.id","typeLabel":"string"},"customerNumber":{"minLength":2,"maxLength":255,"example":"CUSTOMER-000","nullable":false,"type":"string","uniqueKey":"customer.customerNumber","typeLabel":"string"},"timeZone":{"readOnly":true,"default":"Europe/Berlin","example":"Europe/Berlin","type":"string","uniqueKey":"customer.timeZone","typeLabel":"string"},"firstName":{"oneOf":[{"minLength":2,"maxLength":255,"description":"Can be empty if the customer is a company.","example":"John","type":"string","uniqueKey":"customer.firstName.oneOf.0","typeLabel":"string"},{"minLength":2,"maxLength":255,"description":"Can be empty if the customer is a company.","example":"John","type":"null","uniqueKey":"customer.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"minLength":2,"maxLength":255,"description":"Can be empty if the customer is a company.","example":"Doe","type":"string","uniqueKey":"customer.lastName.oneOf.0","typeLabel":"string"},{"minLength":2,"maxLength":255,"description":"Can be empty if the customer is a company.","example":"Doe","type":"null","uniqueKey":"customer.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.lastName","typeLabel":"string | null"},"currencyCode":{"description":"Can be empty. In this case the default currency of the tenant is used.","externalDocs":{"url":"https://schema.org/priceCurrency"},"example":"EUR","type":"string","uniqueKey":"customer.currencyCode","typeLabel":"string"},"companyName":{"oneOf":[{"minLength":2,"maxLength":255,"example":"Acme Inc.","type":"string","uniqueKey":"customer.companyName.oneOf.0","typeLabel":"string"},{"minLength":2,"maxLength":255,"example":"Acme Inc.","type":"null","uniqueKey":"customer.companyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.companyName","typeLabel":"string | null"},"datevId":{"oneOf":[{"minLength":2,"maxLength":255,"description":"The ID of the customer in DATEV","example":"123456789","type":"string","uniqueKey":"customer.datevId.oneOf.0","typeLabel":"string"},{"minLength":2,"maxLength":255,"description":"The ID of the customer in DATEV","example":"123456789","type":"null","uniqueKey":"customer.datevId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.datevId","typeLabel":"string | null"},"status":{"default":"STATUS_ACTIVE","example":"STATUS_ACTIVE","enum":["STATUS_ACTIVE","STATUS_ARCHIVED","STATUS_SUSPENDED"],"type":"string","uniqueKey":"customer.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"customer","typeLabel":"object"},"plan":{"oneOf":[{"type":"object","description":"The plan this subscription is based on.","properties":{"id":{"readOnly":true,"description":"The unique identifier of the plan.","example":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","type":"string","uniqueKey":"plan.oneOf.0.id","typeLabel":"string"},"family":{"oneOf":[{"type":"object","description":"Allow to group plans together. This allows to upgrade or downgrade between plans in the same family.","properties":{"id":{"readOnly":true,"example":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","type":"string","uniqueKey":"plan.oneOf.0.family.oneOf.0.id","typeLabel":"string"},"createdAt":{"readOnly":true,"description":"The date and time when the resource was created.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"plan.oneOf.0.family.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"readOnly":true,"description":"The date and time when the resource was last updated.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"plan.oneOf.0.family.oneOf.0.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"plan.oneOf.0.family.oneOf.0","typeLabel":"object"},{"type":"null","description":"Allow to group plans together. This allows to upgrade or downgrade between plans in the same family.","uniqueKey":"plan.oneOf.0.family.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.family","typeLabel":"object | null"},"code":{"description":"The code of the plan. This is used to identify the plan e.g. in the checkout url.","example":"basic-m2023","type":"string","uniqueKey":"plan.oneOf.0.code","typeLabel":"string"},"originProduct":{"oneOf":[{"type":"object","description":"The origin product this plan belongs to. This is relevant for advanced analytics.","required":["type","measurement","taxGroup"],"properties":{"type":{"description":"The type of the product.\n - `product`: recurring billed product\n - `charge`: one-time billing\n - `plan`: plan specific product, which cannot be used as a normal product. Will be filtered out in any product lists.\n","type":"string","enum":["product","charge","plan"],"isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.type","typeLabel":"enum\u003cstring>"},"measurement":{"type":"object","description":"The measurement that is used for the price plan. This could define the quantity or a metered usage.","deprecated":false,"properties":{"unit":{"oneOf":[{"type":"object","description":"The unit of the measurement.","properties":{"id":{"type":"object","description":"","deprecated":false,"readOnly":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit.oneOf.0.id","typeLabel":"object"},"name":{"example":"Stück","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit.oneOf.0.name","typeLabel":"string"},"createdAt":{"readOnly":true,"description":"The date and time when the resource was created.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"readOnly":true,"description":"The date and time when the resource was last updated.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit.oneOf.0.updatedAt","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit.oneOf.0","typeLabel":"object"},{"type":"null","description":"The unit of the measurement.","isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.unit","typeLabel":"object | null"},"code":{"minLength":1,"maxLength":255,"description":"A unique code which can be used to identify the measurement.","example":"users","type":"string","isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.code","typeLabel":"string"},"id":{"readOnly":true,"description":"A unique identifier for the measurement.","example":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.id","typeLabel":"string"},"description":{"oneOf":[{"maxLength":255,"description":"A description of the measurement, which is shown in the summary of the usage data in the invoice.","example":"The number of users.","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.description.oneOf.0","typeLabel":"string"},{"maxLength":255,"description":"A description of the measurement, which is shown in the summary of the usage data in the invoice.","example":"The number of users.","type":"null","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.description","typeLabel":"string | null"},"aggregationType":{"description":"The aggregation type of the measurement. Describes how the quantity is calculated. This cannot be changed after creation, otherwise it would change the whole calculation for existing subscriptions.\n\nPossible values:\n * `count`: The number of sent measurements in the billing interval. Metered usage, which resets to 0 after each billing interval.\n * `count_unique`: The number of unique sent measurements in the billing interval, identified by the id given on event creation.\n * `max`: The maximum value of all sent measurements in the billing interval. Metered usage, which resets to 0 after each billing interval.\n * `sum`: The sum of all sent measurements in the billing interval.\n * `last_value`: The last sent measurement.\n * `average`: The average of all sent measurements in the billing interval.","default":"last_value","example":"sum","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.aggregationType","typeLabel":"any"},"fairBilling":{"description":"If set to false, the measurement will be billed for the whole billing interval, even if the quantity changes, or the item is cancelled / terminated during the billing interval.","default":true,"example":true,"type":"boolean","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.fairBilling","typeLabel":"boolean"},"type":{"description":"The type of the measurement. This cannot be changed after creation, otherwise it would change the whole calculation for existing subscriptions.\n\nPossible values:\n * `instant_metered`: The measurement value is reset to 0 after each push. The measurement gets billed immediately and an invoice is created. The aggregation type must be \"last_value\".\n * `metered`: The measurement value is reset to 0 after each billing interval.\n * `recurring`: The measurement value is not reset to 0 after each billing interval and the last value is used for all following billing intervals. The aggregation type must be \"last_value\".","default":"recurring","example":"recurring","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement.type","typeLabel":"any"}},"required":["unit","code"],"isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.measurement","typeLabel":"object"},"taxGroup":{"type":"object","description":"The tax group that is used for the product.","deprecated":false,"isRequired":true,"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.taxGroup","typeLabel":"object"},"id":{"readOnly":true,"description":"The unique identifier of the product.","example":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.id","typeLabel":"string"},"name":{"description":"The name of the product based on the current tenant language. This will be displayed on customer communication.","example":"Basic","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.name","typeLabel":"string"},"description":{"oneOf":[{"description":"The description of the product based on the current tenant language.","example":"For small teams.","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.description.oneOf.0","typeLabel":"string"},{"description":"The description of the product based on the current tenant language.","example":"For small teams.","type":"null","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.description","typeLabel":"string | null"},"internalName":{"oneOf":[{"description":"Internal name of the product, to differentiate between products with the same name. This will shown in web-app lists, selections and reports.","example":"Basic (Weekly)","type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.internalName.oneOf.0","typeLabel":"string"},{"description":"Internal name of the product, to differentiate between products with the same name. This will shown in web-app lists, selections and reports.","example":"Basic (Weekly)","type":"null","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.internalName.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.internalName","typeLabel":"string | null"},"invoiceVisibility":{"description":"Defines when the product should be displayed in the invoice.\n - `always`: The product is always displayed in the invoice.\n - `only_if_charged`: The product is only displayed in the invoice if it is charged.\n","type":"string","enum":["always","only_if_charged"],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.invoiceVisibility","typeLabel":"enum\u003cstring>"},"costCentre":{"oneOf":[{"type":"object","description":"The cost centre is used for accounting exports.","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.costCentre.oneOf.0","typeLabel":"object"},{"type":"null","description":"The cost centre is used for accounting exports.","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.costCentre.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.costCentre","typeLabel":"object | null"},"costCentre2":{"oneOf":[{"type":"object","description":"The KOST2 cost centre is used for accounting exports (DATEV axis KOST2).","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.costCentre2.oneOf.0","typeLabel":"object"},{"type":"null","description":"The KOST2 cost centre is used for accounting exports (DATEV axis KOST2).","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.costCentre2.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.costCentre2","typeLabel":"object | null"},"customFields":{"oneOf":[{"additionalProperties":{"type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.customFields.oneOf.0.additionalProperties","typeLabel":"string"},"type":"object","example":{"field1":"value1","field2":"value2"},"description":"Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under \\\"/custom-fields\\\" in the API documentation. The input is validated against the configuration. For more details see [Custom Fields Guide](/guide/tenant/custom-fields)","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.customFields.oneOf.0","typeLabel":"object"},{"additionalProperties":{"type":"string","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.customFields.oneOf.1.additionalProperties","typeLabel":"string"},"type":"null","example":{"field1":"value1","field2":"value2"},"description":"Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under \\\"/custom-fields\\\" in the API documentation. The input is validated against the configuration. For more details see [Custom Fields Guide](/guide/tenant/custom-fields)","uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.customFields.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0.customFields","typeLabel":"object | null"}},"uniqueKey":"plan.oneOf.0.originProduct.oneOf.0","typeLabel":"object"},{"type":"null","description":"The origin product this plan belongs to. This is relevant for advanced analytics.","uniqueKey":"plan.oneOf.0.originProduct.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.originProduct","typeLabel":"object | null"},"allowCheckout":{"description":"Allow to checkout this plan. If this is set to false, the plan will not be available in the checkout and can only be assigned to a subscription by the API or in the admin panel. The plan.code is a part of the checkout url.","default":true,"example":true,"type":"boolean","uniqueKey":"plan.oneOf.0.allowCheckout","typeLabel":"boolean"},"status":{"readOnly":true,"description":"The status of the plan.\n\nPossible values:\n * `draft`: The plan is a draft and not available for usage in a subscription.\n * `active`: The plan is active and can be used in a subscription.\n * `archived`: The plan is archived and not longer available for usage in a subscription.\n * `inactive`: The plan is inactive and not available for usage in a subscription.","default":"draft","example":"draft","uniqueKey":"plan.oneOf.0.status","typeLabel":"any"},"changeBehaviour":{"description":"Define the allowed actions after subscription by customer, for upgrade / downgrade.","default":"not_changeable","example":"upgradeable_and_downgradeable","type":"string","enum":["upgradeable","downgradeable","upgradeable_and_downgradeable","not_changeable"],"uniqueKey":"plan.oneOf.0.changeBehaviour","typeLabel":"enum\u003cstring>"},"changeApplyBehaviour":{"description":"Define the behaviour when a plan change will be applied. If null the default behaviour will be used.","default":"end_of_period","example":"end_of_period","type":"string","enum":["immediately","end_of_period"],"uniqueKey":"plan.oneOf.0.changeApplyBehaviour","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"plan.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"name":{"readOnly":true,"description":"The name of this plan","type":"string","uniqueKey":"plan.oneOf.0.name","typeLabel":"string"},"description":{"oneOf":[{"readOnly":true,"description":"The description of this plan","type":"string","uniqueKey":"plan.oneOf.0.description.oneOf.0","typeLabel":"string"},{"readOnly":true,"description":"The description of this plan","type":"null","uniqueKey":"plan.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.oneOf.0.description","typeLabel":"string | null"}},"uniqueKey":"plan.oneOf.0","typeLabel":"object"},{"type":"null","description":"The plan this subscription is based on.","uniqueKey":"plan.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan","typeLabel":"object | null"},"name":{"oneOf":[{"description":"The name of the subscription. Defaults to the name of the plan. This will be used in the invoice for the grouping headers.","example":"Fitness M","type":"string","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"description":"The name of the subscription. Defaults to the name of the plan. This will be used in the invoice for the grouping headers.","example":"Fitness M","type":"null","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"billingGroup":{"oneOf":[{"type":"object","description":"The billing group defines the billing cycle of the subscription.","uniqueKey":"billingGroup.oneOf.0","typeLabel":"object"},{"type":"null","description":"The billing group defines the billing cycle of the subscription.","uniqueKey":"billingGroup.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingGroup","typeLabel":"object | null"},"periods":{"type":"array","items":{"type":"object","description":"","deprecated":false,"properties":{"id":{"readOnly":true,"type":"string","uniqueKey":"periods.items.[INDEX].id","typeLabel":"string"},"contractPeriodCount":{"readOnly":true,"type":"integer","uniqueKey":"periods.items.[INDEX].contractPeriodCount","typeLabel":"integer"},"contractPeriod":{"type":"object","description":"","deprecated":false,"readOnly":true,"uniqueKey":"periods.items.[INDEX].contractPeriod","typeLabel":"object"},"cancellationPeriod":{"type":"object","description":"","deprecated":false,"readOnly":true,"uniqueKey":"periods.items.[INDEX].cancellationPeriod","typeLabel":"object"},"createdAt":{"readOnly":true,"type":"string","format":"date-time","uniqueKey":"periods.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"readOnly":true,"type":"string","format":"date-time","uniqueKey":"periods.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"periods.items.[INDEX]","typeLabel":"object"},"uniqueKey":"periods","typeLabel":"object[]"},"status":{"readOnly":true,"description":"The status of the subscription.\n\nPossible values:\n * `draft`: The subscription is in draft mode and not active yet.\n * `active`: The subscription is active and will be billed.\n * `paused`: The subscription is paused and will not be billed.\n * `cancelled`: The subscription is cancelled and will not be billed anymore.\n * `terminated`: The subscription is terminated and will not be billed anymore.\n * `offer`: The subscription is an offer and waiting for acceptance.","example":"active","uniqueKey":"status","typeLabel":"any"},"activatedAt":{"oneOf":[{"readOnly":true,"description":"The date the subscription was activated.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"activatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"readOnly":true,"description":"The date the subscription was activated.","example":"2021-01-01T00:00:00+00:00","type":"null","format":"date-time","uniqueKey":"activatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"activatedAt","typeLabel":"string\u003cdate-time> | null"},"poNumber":{"oneOf":[{"description":"The po number of the subscription.","example":"PO-00000001","type":"string","uniqueKey":"poNumber.oneOf.0","typeLabel":"string"},{"description":"The po number of the subscription.","example":"PO-00000001","type":"null","uniqueKey":"poNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"poNumber","typeLabel":"string | null"},"contractDetails":{"type":"object","description":"The contract details of the subscription.","deprecated":false,"properties":{"contractStart":{"description":"The start of the contract.","type":"string","format":"date-time","uniqueKey":"contractDetails.contractStart","typeLabel":"string\u003cdate-time>"},"contractEnd":{"oneOf":[{"description":"The end of the contract.","type":"string","format":"date-time","uniqueKey":"contractDetails.contractEnd.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The end of the contract.","type":"null","format":"date-time","uniqueKey":"contractDetails.contractEnd.oneOf.1","typeLabel":"null"}],"uniqueKey":"contractDetails.contractEnd","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"contractDetails","typeLabel":"object"},"trialEndsOn":{"oneOf":[{"readOnly":true,"description":"The date the trial period ends.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"trialEndsOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"readOnly":true,"description":"The date the trial period ends.","example":"2021-01-01T00:00:00+00:00","type":"null","format":"date-time","uniqueKey":"trialEndsOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"trialEndsOn","typeLabel":"string\u003cdate-time> | null"},"customFields":{"oneOf":[{"additionalProperties":{"type":"string","uniqueKey":"customFields.oneOf.0.additionalProperties","typeLabel":"string"},"type":"object","example":{"field1":"value1","field2":"value2"},"description":"Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under \\\"/custom-fields\\\" in the API documentation. The input is validated against the configuration. For more details see [Custom Fields Guide](/guide/tenant/custom-fields)","uniqueKey":"customFields.oneOf.0","typeLabel":"object"},{"additionalProperties":{"type":"string","uniqueKey":"customFields.oneOf.1.additionalProperties","typeLabel":"string"},"type":"null","example":{"field1":"value1","field2":"value2"},"description":"Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under \\\"/custom-fields\\\" in the API documentation. The input is validated against the configuration. For more details see [Custom Fields Guide](/guide/tenant/custom-fields)","uniqueKey":"customFields.oneOf.1","typeLabel":"null"}],"uniqueKey":"customFields","typeLabel":"object | null"},"createdAt":{"readOnly":true,"description":"The date and time when the resource was created.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"readOnly":true,"description":"The date and time when the resource was last updated.","example":"2021-01-01T00:00:00+00:00","type":"string","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"defaultPaymentMethod":{"readOnly":true,"description":"The payment method is null, we use the default payment method of the customer.","type":"boolean","uniqueKey":"defaultPaymentMethod","typeLabel":"boolean"},"defaultInvoiceAddress":{"readOnly":true,"description":"The invoice address is null, we use the default invoice address of the customer.","type":"boolean","uniqueKey":"defaultInvoiceAddress","typeLabel":"boolean"},"nextBillingDate":{"oneOf":[{"readOnly":true,"description":"The next billing date of the subscription.","type":"string","format":"date-time","uniqueKey":"nextBillingDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"readOnly":true,"description":"The next billing date of the subscription.","type":"null","format":"date-time","uniqueKey":"nextBillingDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"nextBillingDate","typeLabel":"string\u003cdate-time> | null"},"lastBillingAt":{"oneOf":[{"readOnly":true,"description":"The last billing date of the subscription.","type":"string","format":"date-time","uniqueKey":"lastBillingAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"readOnly":true,"description":"The last billing date of the subscription.","type":"null","format":"date-time","uniqueKey":"lastBillingAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastBillingAt","typeLabel":"string\u003cdate-time> | null"},"cancellationDate":{"oneOf":[{"readOnly":true,"description":"The date the subscription will be cancelled.","type":"string","format":"date-time","uniqueKey":"cancellationDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"readOnly":true,"description":"The date the subscription will be cancelled.","type":"null","format":"date-time","uniqueKey":"cancellationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellationDate","typeLabel":"string\u003cdate-time> | null"},"cancelledAt":{"oneOf":[{"readOnly":true,"description":"The date when the subscription was cancelled.","type":"string","format":"date-time","uniqueKey":"cancelledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"readOnly":true,"description":"The date when the subscription was cancelled.","type":"null","format":"date-time","uniqueKey":"cancelledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancelledAt","typeLabel":"string\u003cdate-time> | null"},"isCancellationPending":{"readOnly":true,"description":"Indicates if the subscription is pending for cancellation. If true, the subscription will be cancelled in the future and the cancellation could be revoked.","type":"boolean","uniqueKey":"isCancellationPending","typeLabel":"boolean"},"nextPossibleCancellationDate":{"oneOf":[{"readOnly":true,"type":"array","items":{"type":"string","uniqueKey":"nextPossibleCancellationDate.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"nextPossibleCancellationDate.oneOf.0","typeLabel":"string[]"},{"readOnly":true,"type":"null","items":{"type":"string"},"uniqueKey":"nextPossibleCancellationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"nextPossibleCancellationDate","typeLabel":"string[] | null"},"partner":{"oneOf":[{"type":"object","description":"The partner of the customer.","properties":{"id":{"description":"The ID of the partner","example":"ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b","type":"string","uniqueKey":"partner.oneOf.0.id","typeLabel":"string"},"name":{"description":"The name of the partner","example":"John Doe","type":"string","uniqueKey":"partner.oneOf.0.name","typeLabel":"string"},"number":{"description":"The customer number of the partner","example":"123456","type":"string","uniqueKey":"partner.oneOf.0.number","typeLabel":"string"},"email":{"oneOf":[{"description":"The email address of the partner","example":"partner@example.com","type":"string","uniqueKey":"partner.oneOf.0.email.oneOf.0","typeLabel":"string"},{"description":"The email address of the partner","example":"partner@example.com","type":"null","uniqueKey":"partner.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"partner.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"partner.oneOf.0","typeLabel":"object"},{"type":"null","description":"The partner of the customer.","uniqueKey":"partner.oneOf.1","typeLabel":"null"}],"uniqueKey":"partner","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","externalId":"\u003cstring>","paymentMethod":{"id":"c1a2b3c4-d5e6-4f7a-8b9b-0c1d2e3f4a5b","gatewayName":"wallet","type":"sepa_debit","default":true,"status":"active","enabled":true,"name":"Visa (4242)","creationDate":"2024-01-15T10:30:00+00:00","expirationDate":"2026-12-31T23:59:59+00:00","card":{"brand":"Visa","last4":"4242","expMonth":12,"expYear":2022,"cardHolder":"Max Mustermann"},"sepaDebit":{"iban":"DE8937*********3232","bic":"COBADEFFXXX","mandateReference":"MNDT-2021-123456","signingDate":"2021-01-01T00:00:00+00:00"},"paypal":{"email":"max@mustermann.de","billingAgreementId":"I-1J5gqz2eZvKYlo2C2X2X2X2X"}},"invoiceAddress":{"id":"\u003cstring>","vatId":"DE123456789","type":"TYPE_DEFAULT","default":"true","status":"active","city":"Berlin","zip":"12345","street":"Musterstraße","houseNumber":"1a","countryCode":"DE","companyName":"ACME Inc.","salutation":"Herr","addition":"c/o John Doe","costCentre":"123456789","firstName":"John","lastName":"Doe"},"number":"S-00000001","customer":{"id":"00000000-0000-0000-0000-000000000000","customerNumber":"CUSTOMER-000","timeZone":"Europe/Berlin","firstName":"John","lastName":"Doe","currencyCode":"EUR","companyName":"Acme Inc.","datevId":"123456789","status":"STATUS_ACTIVE"},"plan":{"id":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","family":{"id":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","createdAt":"2021-01-01T00:00:00+00:00","updatedAt":"2021-01-01T00:00:00+00:00"},"code":"basic-m2023","originProduct":{"type":"product","measurement":{"unit":{"id":{},"name":"Stück","createdAt":"2021-01-01T00:00:00+00:00","updatedAt":"2021-01-01T00:00:00+00:00"},"code":"users","id":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","description":"The number of users.","aggregationType":"sum","fairBilling":true,"type":"recurring"},"taxGroup":{},"id":"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b","name":"Basic","description":"For small teams.","internalName":"Basic (Weekly)","invoiceVisibility":"always","costCentre":{},"costCentre2":{},"customFields":{"field1":"value1","field2":"value2"}},"allowCheckout":true,"status":"draft","changeBehaviour":"upgradeable_and_downgradeable","changeApplyBehaviour":"end_of_period","createdAt":"2023-11-07T05:31:56Z","name":"\u003cstring>","description":"\u003cstring>"},"name":"Fitness M","billingGroup":{},"periods":[{"id":"\u003cstring>","contractPeriodCount":123,"contractPeriod":{},"cancellationPeriod":{},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}],"status":"active","activatedAt":"2021-01-01T00:00:00+00:00","poNumber":"PO-00000001","contractDetails":{"contractStart":"2023-11-07T05:31:56Z","contractEnd":"2023-11-07T05:31:56Z"},"trialEndsOn":"2021-01-01T00:00:00+00:00","customFields":{"field1":"value1","field2":"value2"},"createdAt":"2021-01-01T00:00:00+00:00","updatedAt":"2021-01-01T00:00:00+00:00","defaultPaymentMethod":true,"defaultInvoiceAddress":true,"nextBillingDate":"2023-11-07T05:31:56Z","lastBillingAt":"2023-11-07T05:31:56Z","cancellationDate":"2023-11-07T05:31:56Z","cancelledAt":"2023-11-07T05:31:56Z","isCancellationPending":true,"nextPossibleCancellationDate":["\u003cstring>"],"partner":{"id":"ad8f7e7d-3b3b-4b3b-8b3b-3b3b3b3b3b3b","name":"John Doe","number":"123456","email":"partner@example.com"}}}},"exampleType":"generated"}},"links":{},"exampleType":"generated"},"e672e208-4c90-4c33-b6af-2438081947d2":{"description":"Invalid input","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"03601d8b-0179-4410-8868-5032cfc61038":{"description":"Resource not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"b021bedc-c6cc-4138-8df8-208b3ff28964":{"description":"Unprocessable entity","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"ec83da86-04b7-4e27-94ab-a01fa192cecc":{"JWT":{"type":"http","scheme":"bearer","scopes":["subscription:write"]}}},"servers":{"987b4dcd-9d5f-4357-a99f-0dbd47556601":{"url":"https://coreapi.io","description":"Production"},"a53b6fbc-bcf4-4920-9f87-1223f86cceba":{"url":"https://preview.coreapi.io","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":["subscription:write"]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"JWT","name":"Authorization"}],"title":"JWT"}]},"originalFileLocation":"assets/openapi.json"},"subdomain":"fynnsubscriptionbilling","siteName":"Fynn Docs","title":"Cancel subscription - Fynn Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"de":{"href":"/api-reference/subscription/cancel-subscription","matchLevel":0},"en":{"href":"/en/introduction","matchLevel":4}}},"lastModified":"2026-01-28T23:39:16.427Z","originalFileLocation":"api-reference/subscription/cancel-subscription.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=\"Cancel the subscription. This will stop billing and the subscription will be inactive after the cancellation date. Required permissions: subscription:write\">\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=\"Cancel subscription - Fynn Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cancel the subscription. This will stop billing and the subscription will be inactive after the cancellation date. Required permissions: subscription:write\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fynn Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.fynn.eu/api-reference/subscription/cancel-subscription\">\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=Subscription\u0026amp;title=Cancel+subscription\u0026amp;description=Cancel+the+subscription.+This+will+stop+billing+and+the+subscription+will+be+inactive+after+the+cancellation+date.%0A%0A%3Csup%3ERequired+permissions%3A+%60subscription%3Awri\u0026amp;theme=e7dd9c799652fa75e5fe0868\u0026amp;signature=05864142989bb7c11a7cd4430555fc314c7350fcc1690f1a94ff62bbc06cc215\">\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=\"Cancel subscription - Fynn Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cancel the subscription. This will stop billing and the subscription will be inactive after the cancellation date. Required permissions: subscription:write\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fynnsubscriptionbilling.mintlify.site/_mintlify/api/og/v2?division=Subscription\u0026amp;title=Cancel+subscription\u0026amp;description=Cancel+the+subscription.+This+will+stop+billing+and+the+subscription+will+be+inactive+after+the+cancellation+date.%0A%0A%3Csup%3ERequired+permissions%3A+%60subscription%3Awri\u0026amp;theme=e7dd9c799652fa75e5fe0868\u0026amp;signature=05864142989bb7c11a7cd4430555fc314c7350fcc1690f1a94ff62bbc06cc215\">\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/api-reference/subscription/cancel-subscription\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/subscription/cancel-subscription.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/api-reference/subscription/cancel-subscription#webpage\",\"url\":\"https://docs.fynn.eu/api-reference/subscription/cancel-subscription\",\"name\":\"Cancel subscription\",\"description\":\"Cancel the subscription. This will stop billing and the subscription will be inactive after the cancellation date. Required permissions: subscription:write\",\"dateModified\":\"2026-01-28T23:39:16.427Z\",\"isPartOf\":{\"@id\":\"https://docs.fynn.eu#website\"},\"breadcrumb\":{\"@id\":\"https://docs.fynn.eu/api-reference/subscription/cancel-subscription#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.fynn.eu/api-reference/subscription/cancel-subscription#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subscription\",\"item\":\"https://docs.fynn.eu/api-reference/subscription/get-all-subscriptions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cancel subscription\",\"item\":\"https://docs.fynn.eu/api-reference/subscription/cancel-subscription\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.fynn.eu/api-reference/subscription/cancel-subscription#apireference\",\"headline\":\"Cancel subscription\",\"name\":\"Cancel subscription\",\"description\":\"Cancel the subscription. This will stop billing and the subscription will be inactive after the cancellation date. Required permissions: subscription:write\",\"url\":\"https://docs.fynn.eu/api-reference/subscription/cancel-subscription\",\"mainEntityOfPage\":{\"@id\":\"https://docs.fynn.eu/api-reference/subscription/cancel-subscription#webpage\"},\"dateModified\":\"2026-01-28T23:39:16.427Z\",\"publisher\":{\"@id\":\"https://docs.fynn.eu/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.fynn.eu#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/subscription/cancel-subscription.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","groups":[{"group":"API documentation","pages":[{"title":"Getting started","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"group":"Guides","pages":[{"title":"Manage payment methods on your own payment page","href":"/api-reference/guides/add-payment-method"},{"title":"Collect Usage Data","href":"/api-reference/guides/collect-usage-data"},{"title":"Wallet Top-Up","href":"/api-reference/guides/wallet-top-up"},{"title":"Wallet Payout","href":"/api-reference/guides/wallet-payout"},{"title":"Enable manual invoice checks","href":"/api-reference/guides/enable-manual-invoice-check"},{"title":"Implement Self-Service Upgrades","sidebarTitle":"Upgrades \u0026 Downgrades","href":"/api-reference/guides/implement-upgrades"}]},{"group":"Migrations","pages":[{"title":"Migration: Measurements → Nutzungsmetriken","sidebarTitle":"Measurements Deprecation","href":"/api-reference/migrations/measurements-deprecation"}]},{"group":"Usage Events","pages":[{"title":"Usage Events API","href":"/api-reference/usage-events/overview"}]}]},{"group":"User","pages":[{"openapi":"post /auth/register","title":"Register a new user","href":"/api-reference/user/register-a-new-user"},{"openapi":"post /user/complete","title":"Complete the user registration","href":"/api-reference/user/complete-the-user-registration"},{"openapi":"get /user/accounts","title":"Get the current user's accounts","href":"/api-reference/user/get-the-current-users-accounts"},{"openapi":"post /user/default-tenant","title":"Set the default tenant of the current user","href":"/api-reference/user/set-the-default-tenant-of-the-current-user"},{"openapi":"get /user/login-activities","title":"Get all login activities","href":"/api-reference/user/get-all-login-activities"},{"openapi":"get /user/me","title":"Get the current user","href":"/api-reference/user/get-the-current-user"},{"group":"Api Tokens","pages":[{"openapi":"get /user/api-tokens","title":"Get all api tokens","href":"/api-reference/userapitoken/get-all-api-tokens"},{"openapi":"post /user/api-tokens","title":"Create api token","href":"/api-reference/userapitoken/create-api-token"},{"openapi":"delete /user/api-tokens/{id}","title":"Delete api token","href":"/api-reference/userapitoken/delete-api-token"}]}]},{"group":"Tenant","pages":[{"openapi":"post /tenants","title":"Create a new tenant","href":"/api-reference/tenant/create-a-new-tenant"},{"openapi":"get /tenants/{id}","title":"Get a tenant","href":"/api-reference/tenant/get-a-tenant"},{"openapi":"patch /tenants/{id}","title":"Update a tenant","href":"/api-reference/tenant/update-a-tenant"},{"openapi":"get /user/tenants","title":"Get the tenants of the current user","href":"/api-reference/tenant/get-the-tenants-of-the-current-user"}]},{"group":"Customer","pages":[{"openapi":"get /customers","title":"Get customers","href":"/api-reference/customer/get-customers"},{"openapi":"post /customers","title":"Create customer","href":"/api-reference/customer/create-customer"},{"openapi":"get /customers/{id}","title":"Get customer","href":"/api-reference/customer/get-customer"},{"openapi":"put /customers/{id}","title":"Update customer","href":"/api-reference/customer/update-customer"},{"openapi":"put /customers/{id}/archive","title":"Archive customer","href":"/api-reference/customer/archive-customer"},{"openapi":"delete /customers/{id}","title":"Delete customer","href":"/api-reference/customer/delete-customer"},{"openapi":"post /customers/{id}/comment","title":"Add comment","href":"/api-reference/customer/add-comment"},{"group":"Hierarchy","pages":[{"openapi":"put /customers/{customerId}/set-parent","title":"Set parent customer","href":"/api-reference/customer/set-parent-customer"},{"openapi":"put /customers/{customerId}/remove-parent","title":"Remove parent customer","href":"/api-reference/customer/remove-parent-customer"},{"openapi":"get /customers/{customerId}/children","title":"Get customer children","href":"/api-reference/customer/get-customer-children"},{"openapi":"get /customers/{customerId}/hierarchy","title":"Get customer hierarchy","href":"/api-reference/customer/get-customer-hierarchy"}]},{"group":"Address","pages":[{"openapi":"get /customers/{customerId}/addresses","title":"Get all customer addresses","href":"/api-reference/customeraddress/get-all-customer-addresses"},{"openapi":"post /customers/{customerId}/addresses","title":"Add a customer address","href":"/api-reference/customeraddress/add-a-customer-address"},{"openapi":"get /customer-addresses/{id}","title":"Get a customer address","href":"/api-reference/customeraddress/get-a-customer-address"},{"openapi":"put /customer-addresses/{id}","title":"Update a customer address","href":"/api-reference/customeraddress/update-a-customer-address"},{"openapi":"delete /customer-addresses/{id}","title":"Delete a customer address","href":"/api-reference/customeraddress/delete-a-customer-address"},{"openapi":"post /customer-addresses/{id}/default","title":"Set a customer address as default","href":"/api-reference/customeraddress/set-a-customer-address-as-default"},{"openapi":"put /customer-addresses/{id}/unset-default","title":"Unset a customer address as default","href":"/api-reference/customeraddress/unset-a-customer-address-as-default"}]},{"group":"Email","pages":[{"openapi":"get /customers/{customerId}/email-addresses","title":"Get customer email addresses","href":"/api-reference/customeremail/get-customer-email-addresses"},{"openapi":"post /customers/{customerId}/email-addresses","title":"Create customer email address","href":"/api-reference/customeremail/create-customer-email-address"},{"openapi":"get /customer-email-addresses/{id}","title":"Get customer email address","href":"/api-reference/customeremail/get-customer-email-address"},{"openapi":"patch /customer-email-addresses/{id}","title":"Update customer email address","href":"/api-reference/customeremail/update-customer-email-address"},{"openapi":"delete /customer-email-addresses/{id}","title":"Delete customer email address","href":"/api-reference/customeremail/delete-customer-email-address"},{"openapi":"post /customer-email-addresses/{id}/default","title":"Set default customer email address","href":"/api-reference/customeremail/set-default-customer-email-address"}]},{"group":"Settings","pages":[{"openapi":"get /customers/{id}/settings/{context}","title":"Get settings","href":"/api-reference/customersettings/get-settings"},{"openapi":"patch /customers/{id}/settings/{context}","title":"Update settings","href":"/api-reference/customersettings/update-settings"}]},{"group":"Authentication","pages":[{"openapi":"post /customers/{id}/authenticate","title":"Generate customer authentication","href":"/api-reference/customer/authenticate-customer"},{"openapi":"post /customers/{id}/send-login-email","title":"Send login email to customer","href":"/api-reference/customer/send-login-email"},{"openapi":"post /public/customer/request-login-link","title":"Request a login link for the customer portal","href":"/api-reference/customerotp/request-login-link"},{"openapi":"post /public/customer/request-otp","title":"Request a one time token for a customer","href":"/api-reference/customerotp/request-a-one-time-token-for-a-customer"}]}]},{"group":"Catalogue","pages":[{"group":"Unit","pages":[{"openapi":"get /units","title":"Get all units","href":"/api-reference/unit/get-all-units"},{"openapi":"post /units","title":"Create a unit","href":"/api-reference/unit/create-a-unit"},{"openapi":"get /units/{id}","title":"Get a unit","href":"/api-reference/unit/get-a-unit"},{"openapi":"put /units/{id}","title":"Update a unit","href":"/api-reference/unit/update-a-unit"}]},{"group":"Measurement","pages":[{"openapi":"get /catalogue/measurements","title":"Get all measurements.","href":"/api-reference/measurement/get-all-measurements"},{"openapi":"post /catalogue/measurements","title":"Create a measurement.","href":"/api-reference/measurement/create-a-measurement"},{"openapi":"get /catalogue/measurements/{id}","title":"Get a measurement.","href":"/api-reference/measurement/get-a-measurement"},{"openapi":"put /catalogue/measurements/{id}","title":"Update a measurement.","href":"/api-reference/measurement/update-a-measurement"},{"openapi":"delete /catalogue/measurements/{id}","title":"Delete a measurement.","href":"/api-reference/measurement/delete-a-measurement"}]},{"group":"Product","pages":[{"openapi":"get /catalogue/products","title":"Get products","href":"/api-reference/product/get-products"},{"openapi":"post /catalogue/products","title":"Create a product","href":"/api-reference/product/create-a-product"},{"openapi":"get /catalogue/products/{id}","title":"Get a product","href":"/api-reference/product/get-a-product"},{"openapi":"put /catalogue/products/{id}","title":"Update a product","href":"/api-reference/product/update-a-product"},{"openapi":"delete /catalogue/products/{id}","title":"Delete a product","href":"/api-reference/product/delete-a-product"},{"openapi":"put /catalogue/products/{id}/archive","title":"Archive a product","href":"/api-reference/product/archive-a-product"}]},{"group":"Product Family","pages":[{"openapi":"get /product-families","title":"Get a collection of product families","href":"/api-reference/productfamily/get-a-collection-of-product-families"},{"openapi":"post /product-families","title":"Create a product family","href":"/api-reference/productfamily/create-a-product-family"},{"openapi":"get /product-families/{id}","title":"Get a product family","href":"/api-reference/productfamily/get-a-product-family"},{"openapi":"put /product-families/{id}","title":"Update a product family","href":"/api-reference/productfamily/update-a-product-family"},{"openapi":"delete /product-families/{id}","title":"Delete a product family","href":"/api-reference/productfamily/delete-a-product-family"},{"openapi":"put /product-families/{id}/products","title":"Add products to a product family","href":"/api-reference/productfamily/add-products-to-a-product-family"},{"openapi":"get /product-family-tree","title":"Get a product family tree","href":"/api-reference/productfamily/get-a-product-family-tree"}]},{"group":"Product Group","pages":[{"openapi":"get /catalogue/product-groups","title":"Get product groups","href":"/api-reference/productgroup/get-product-groups"},{"openapi":"post /catalogue/product-groups","title":"Create a product group","href":"/api-reference/productgroup/create-product-group"},{"openapi":"get /catalogue/product-groups/{id}","title":"Get a product group","href":"/api-reference/productgroup/get-product-group"},{"openapi":"put /catalogue/product-groups/{id}","title":"Update a product group","href":"/api-reference/productgroup/update-product-group"},{"openapi":"delete /catalogue/product-groups/{id}","title":"Delete a product group","href":"/api-reference/productgroup/delete-product-group"},{"openapi":"put /subscription-items/{id}/product-group","title":"Enable Up- \u0026 Downgrades","sidebarTitle":"Enable Up- \u0026 Downgrades","href":"/api-reference/productgroup/assign-product-group"},{"openapi":"get /subscription-items/{id}/change-options","title":"Get change options","href":"/api-reference/productgroup/get-change-options"},{"openapi":"post /product-group-memberships/{id}/apply","title":"Change Tier","sidebarTitle":"Change Tier","href":"/api-reference/productgroup/apply-membership"}]},{"group":"Price Plan","pages":[{"openapi":"get /price-plans","title":"Get all prices.","href":"/api-reference/priceplan/get-all-prices"},{"openapi":"post /price-plans","title":"Create a new price plan.","href":"/api-reference/priceplan/create-a-new-price-plan"},{"openapi":"get /price-plans/{id}","title":"Get a price.","href":"/api-reference/priceplan/get-a-price"},{"openapi":"put /price-plans/{id}","title":"Update a price plan.","href":"/api-reference/priceplan/update-a-price-plan"},{"openapi":"put /price-plans/{id}/archive","title":"Archive a price plan.","href":"/api-reference/priceplan/archive-a-price-plan"}]},{"group":"Coupon","pages":[{"openapi":"get /coupons","title":"Get all coupons","href":"/api-reference/coupon/get-all-coupons"},{"openapi":"post /coupons","title":"Create a coupon","href":"/api-reference/coupon/create-a-coupon"},{"openapi":"get /coupons/{couponId}/redeemptions","title":"Get all redeemptions for a coupon","href":"/api-reference/coupon/get-all-redeemptions-for-a-coupon"},{"openapi":"get /coupons/{id}","title":"Get a coupon","href":"/api-reference/coupon/get-a-coupon"},{"openapi":"put /coupons/{id}","title":"Update a coupon","href":"/api-reference/coupon/update-a-coupon"},{"openapi":"delete /coupons/{id}","title":"Delete a coupon","href":"/api-reference/coupon/delete-a-coupon"},{"openapi":"put /coupons/{id}/toggle","title":"Toggle a coupon","href":"/api-reference/coupon/toggle-a-coupon"}]}]},{"group":"Subscription","pages":[{"openapi":"get /subscriptions","title":"Get all subscriptions","href":"/api-reference/subscription/get-all-subscriptions"},{"openapi":"post /subscriptions","title":"Create subscription","href":"/api-reference/subscription/create-subscription"},{"openapi":"post /subscriptions/from-plan","title":"Create subscription from plan","href":"/api-reference/subscription/create-subscription-from-plan"},{"openapi":"get /subscriptions/{id}","title":"Get subscription","href":"/api-reference/subscription/get-subscription"},{"openapi":"put /subscriptions/{id}","title":"Update subscription","href":"/api-reference/subscription/update-subscription"},{"openapi":"delete /subscriptions/{id}","title":"Delete subscription","href":"/api-reference/subscription/delete-subscription"},{"openapi":"put /subscriptions/{id}/activate","title":"Activate subscription","href":"/api-reference/subscription/activate-subscription"},{"openapi":"get /subscriptions/{id}/estimated-amount","title":"Get estimated amount","href":"/api-reference/subscription/get-estimated-amount"},{"openapi":"get /subscriptions/{id}/estimated-invoice","title":"Get estimated invoice","href":"/api-reference/subscription/get-estimated-invoice"},{"openapi":"put /subscriptions/{id}/extend-trial","title":"Extend trial","href":"/api-reference/subscription/extend-trial"},{"openapi":"put /subscriptions/{id}/invoice-address","title":"Update invoice address","href":"/api-reference/subscription/update-invoice-address"},{"openapi":"put /subscriptions/{id}/pause","title":"Pause subscription","href":"/api-reference/subscription/pause-subscription"},{"openapi":"put /subscriptions/{id}/payment-method","title":"Update payment method","href":"/api-reference/subscription/update-payment-method"},{"openapi":"post /subscriptions/{id}/products","title":"Order products","href":"/api-reference/subscription/order-products"},{"openapi":"put /subscriptions/{id}/resume","title":"Resume subscription","href":"/api-reference/subscription/resume-subscription"},{"openapi":"put /subscriptions/{id}/revoke-trial","title":"Revoke trial","description":"Revoke the trial period of the subscription and start billing immediately, as it would without a trial.\n\n\u003csup>Required permissions: `subscription:write`\u003c/sup>","href":"/api-reference/subscription/revoke-trial"},{"openapi":"put /subscriptions/{id}/cancel","title":"Cancel subscription","href":"/api-reference/subscription/cancel-subscription"},{"title":"Subscription Transition","description":"Transition a subscription to new products and price plans.","href":"/api-reference/subscription/transition"},{"openapi":"post /subscriptions/{id}/comment","title":"Add comment","href":"/api-reference/subscription/add-comment"},{"group":"Item","pages":[{"openapi":"get /subscription-items/{id}","title":"Get a subscription item.","href":"/api-reference/subscriptionitem/get-a-subscription-item"},{"openapi":"patch /subscription-items/{id}","title":"Update a subscription item.","href":"/api-reference/subscriptionitem/update-a-subscription-item"},{"openapi":"delete /subscription-items/{id}","title":"Remove a subscription item.","href":"/api-reference/subscriptionitem/remove-a-subscription-item"},{"openapi":"get /subscription-item-applied-discounts/{id}","title":"Get a subscription item applied discount.","href":"/api-reference/subscriptionitem/get-a-subscription-item-applied-discount"},{"openapi":"get /subscription-items/{id}/estimated-amount","title":"Get estimated amount","href":"/api-reference/subscriptionitem/get-estimated-amount"}]},{"group":"Measurement","pages":[{"openapi":"post /subscription-measurements","title":"Add a subscription measurement.","href":"/api-reference/subscription-measurement/add-a-subscription-measurement"},{"openapi":"post /subscription-measurements/batch","title":"Add a batch of subscription measurement.","href":"/api-reference/subscription-measurement/add-a-batch-of-subscription-measurement"},{"openapi":"get /subscription-measurements/{id}","title":"Get a subscription measurement.","href":"/api-reference/subscription-measurement/get-a-subscription-measurement"}]},{"group":"Billing Group","pages":[{"openapi":"get /customers/{customerId}/billing-groups","title":"Get a collection of billing groups","href":"/api-reference/billinggroup/get-a-collection-of-billing-groups"},{"openapi":"post /billing-groups","title":"Create a billing group","href":"/api-reference/billinggroup/create-a-billing-group"},{"openapi":"get /billing-groups/{id}","title":"Get a billing group","href":"/api-reference/billinggroup/get-a-billing-group"}]}]},{"group":"Invoice","pages":[{"openapi":"get /invoices","title":"Get invoices","href":"/api-reference/invoice/get-invoices"},{"openapi":"post /invoices","title":"Create draft invoice","href":"/api-reference/invoice/create-draft-invoice"},{"openapi":"get /invoices/{id}","title":"Get invoice","href":"/api-reference/invoice/get-invoice"},{"openapi":"put /invoices/{id}","title":"Update draft invoice","href":"/api-reference/invoice/update-draft-invoice"},{"openapi":"delete /invoices/{id}","title":"Delete invoice","href":"/api-reference/invoice/delete-invoice"},{"openapi":"post /invoices/{id}/finalize","title":"Finalize invoice","href":"/api-reference/invoice/finalize-invoice"},{"openapi":"post /invoices/{id}/pdf","title":"Upload custom invoice PDF","href":"/api-reference/invoice/upload-invoice-pdf"},{"openapi":"post /invoices/{id}/cancel","title":"Cancel invoice","href":"/api-reference/invoice/cancel-invoice"},{"openapi":"post /invoices/{id}/credit","title":"Credit invoice","href":"/api-reference/invoice/credit-invoice"},{"openapi":"post /invoices/{id}/duplicate","title":"Duplicate invoice","href":"/api-reference/invoice/duplicate-invoice"},{"openapi":"put /invoices/{id}/resend","title":"Resend invoice","href":"/api-reference/invoice/resend-invoice"},{"openapi":"put /invoices/{id}/download-link","title":"Get invoice download link","href":"/api-reference/invoice/get-invoice-download-link"},{"openapi":"get /invoices/{id}/preview","title":"Get invoice preview","href":"/api-reference/invoice/get-invoice-preview"},{"openapi":"put /invoices/{id}/close","title":"Close invoice","href":"/api-reference/invoice/close-invoice"},{"openapi":"post /invoices/{id}/payments","title":"Add invoice payment","href":"/api-reference/invoice/add-invoice-payment"},{"openapi":"post /invoices/{id}/customer-address","title":"Set invoice customer address","href":"/api-reference/invoice/set-invoice-customer-address"},{"openapi":"post /invoices/{id}/payment-method","title":"Set invoice payment method","href":"/api-reference/invoice/set-invoice-payment-method"},{"openapi":"put /invoices/{id}/internal-note","title":"Set invoice note","href":"/api-reference/invoice/set-invoice-note"},{"openapi":"put /invoices/{id}/dunning","title":"Toggle dunning","href":"/api-reference/invoice/toggle-dunning"},{"openapi":"post /invoices/{id}/position-items","title":"Add invoice position items","href":"/api-reference/invoice/add-invoice-position-items"},{"openapi":"post /invoices/{id}/comment","title":"Add comment","href":"/api-reference/invoice/add-comment"},{"group":"Position Item","pages":[{"openapi":"get /invoice-position-items/{id}","title":"Get an invoice position item","href":"/api-reference/invoicepositionitem/get-an-invoice-position-item"},{"openapi":"put /invoice-position-items/{id}","title":"Update an invoice position item","href":"/api-reference/invoicepositionitem/update-an-invoice-position-item"},{"openapi":"delete /invoice-position-items/{id}","title":"Delete an invoice position item","href":"/api-reference/invoicepositionitem/delete-an-invoice-position-item"}]},{"group":"Billing Run","pages":[{"openapi":"get /invoices/{invoiceId}/billing-run","title":"Get billing run details for an invoice","href":"/api-reference/billingrun/get-billing-run-details-for-an-invoice"}]}]},{"group":"Payment","pages":[{"group":"Payment Method","pages":[{"openapi":"get /customers/{customerId}/payment-methods","title":"Get customer's payment methods","href":"/api-reference/paymentmethod/get-customers-payment-methods"},{"openapi":"post /payment-methods","title":"Create payment method","href":"/api-reference/paymentmethod/create-payment-method"},{"openapi":"post /payment-methods/link","title":"Create payment method link","href":"/api-reference/paymentmethod/create-payment-method-link"},{"openapi":"post /payment-methods/migrate/stripe","title":"Migrate stripe payment methods","href":"/api-reference/paymentmethod/migrate-stripe-payment-methods"},{"openapi":"post /payment-methods/{id}/document","title":"Upload a document for a payment method","href":"/api-reference/paymentmethod/upload-a-document-for-a-payment-method"}]},{"group":"Transaction","pages":[{"openapi":"get /payment/transactions","title":"Get transactions","href":"/api-reference/payment-transaction/get-transactions"},{"openapi":"get /payment/transactions/{id}","title":"Get transaction","href":"/api-reference/payment-transaction/get-transaction"}]},{"group":"SEPA XML","pages":[{"openapi":"get /sepa-xml-files","title":"Get a list of SEPA XML files","href":"/api-reference/sepaxmlstatement/get-a-list-of-sepa-xml-files"},{"openapi":"post /sepa-xml-files/generate","title":"Generate a SEPA XML file","href":"/api-reference/sepaxmlstatement/generate-a-sepa-xml-file"},{"openapi":"get /sepa-xml-files/{id}","title":"Get a SEPA XML file","href":"/api-reference/sepaxmlstatement/get-a-sepa-xml-file"},{"openapi":"delete /sepa-xml-files/{id}","title":"Delete a SEPA XML file","href":"/api-reference/sepaxmlstatement/delete-a-sepa-xml-file"},{"openapi":"put /sepa-xml-files/{id}/uploaded","title":"Mark a SEPA XML file as uploaded","href":"/api-reference/sepaxmlstatement/mark-a-sepa-xml-file-as-uploaded"},{"openapi":"get /sepa-xml-payments/{id}","title":"Get a Sepa XML payment","href":"/api-reference/sepa-xml-payments/get-a-sepa-xml-payment"}]},{"group":"Open Banking","pages":[{"openapi":"post /klarna/connect","title":"Connect Klarna","href":"/api-reference/open-banking/connect-klarna"},{"openapi":"get /open-banking-accounts","title":"Get connected open banking accounts","href":"/api-reference/open-banking/get-connected-open-banking-accounts"},{"openapi":"get /open-banking-accounts/{id}","title":"Get open banking account","href":"/api-reference/open-banking/get-open-banking-account"},{"openapi":"put /open-banking-accounts/{id}/disconnect","title":"Disconnect open banking account","href":"/api-reference/open-banking/disconnect-open-banking-account"},{"openapi":"post /api/open-banking-accounts/{id}/fetch-transactions","title":"Trigger a transaction fetch for an open banking account","href":"/api-reference/open-banking/fetch-open-banking-account-transactions"}]},{"group":"Bank Transaction","pages":[{"openapi":"get /payment/bank-account-transactions","title":"Get bank account transactions","href":"/api-reference/bankaccounttransaction/get-bank-account-transactions"},{"openapi":"get /payment/bank-account-transactions/{id}","title":"Get bank account transaction details","href":"/api-reference/bankaccounttransaction/get-bank-account-transaction-details"},{"openapi":"get /payment/bank-account-transaction-assignments/{id}","title":"Get a bank account transaction assignment","href":"/api-reference/bankaccounttransaction/get-a-bank-account-transaction-assignment"},{"openapi":"put /payment/bank-account-transactions/{id}/assign-invoices","title":"Assign invoices to the bank account transaction.","href":"/api-reference/bankaccounttransaction/assign-invoices-to-the-bank-account-transaction"},{"title":"Assign Invoices and Book the Remainder","sidebarTitle":"Assign with Disposition","href":"/api-reference/bankaccounttransaction/assign-with-disposition"},{"openapi":"put /payment/bank-account-transactions/accept-suggestions","title":"Accept the suggestions","href":"/api-reference/bankaccounttransaction/accept-the-suggestions"},{"openapi":"put /payment/bank-account-transactions/ignore","title":"Ignore bank account transactions.","href":"/api-reference/bankaccounttransaction/ignore-bank-account-transactions"},{"openapi":"get /payment/bank-account-transactions/status-count","title":"Get the status count of the bank account transactions","href":"/api-reference/bankaccounttransaction/get-the-status-count-of-the-bank-account-transactions"}]}]},{"group":"Dunning","pages":[{"openapi":"get /dunning/documents","title":"Get dunning documents","href":"/api-reference/dunningdocument/get-dunning-documents"},{"openapi":"get /dunning/documents/{id}","title":"Get dunning document","href":"/api-reference/dunningdocument/get-dunning-document"},{"openapi":"put /dunning/documents/{id}/cancel","title":"Cancel dunning document","href":"/api-reference/dunningdocument/cancel-dunning-document"},{"group":"Rules","pages":[{"openapi":"get /dunning/overdue-rules","title":"Get overdue rules","href":"/api-reference/overduerule/get-overdue-rules"},{"openapi":"put /dunning/overdue-rules/{id}","title":"Update overdue rule","href":"/api-reference/overduerule/update-overdue-rule"}]}]},{"group":"Offer","pages":[{"openapi":"get /offers","title":"Get offers","href":"/api-reference/offer/get-offers"},{"openapi":"post /subscriptions/{id}/offers","title":"[Deprecated, removed 2026-08-01] Create an offer","href":"/api-reference/offer/create-an-offer"},{"openapi":"get /offers/{id}","title":"[Deprecated, removed 2026-08-01] Get an offer","href":"/api-reference/offer/get-an-offer"},{"openapi":"put /offers/{id}","title":"Update an offer","href":"/api-reference/offer/update-an-offer"},{"openapi":"get /offers/{id}/document","title":"[Deprecated, removed 2026-08-01] Get a offer document","href":"/api-reference/offer/get-a-offer-document"},{"openapi":"get /public/offers/{id}","title":"[Deprecated, removed 2026-08-01] Get a public offer","href":"/api-reference/offer/get-a-public-offer"},{"openapi":"get /public/offers/{id}/document","title":"[Deprecated, removed 2026-08-01] Get a public offer document","href":"/api-reference/offer/get-a-public-offer-document"},{"openapi":"post /offers/{id}/recipients","title":"Add a recipient to an offer","href":"/api-reference/offer/add-a-recipient-to-an-offer"},{"openapi":"get /public/offers/{id}/sign","title":"[Deprecated, removed 2026-08-01] Start signing an offer","href":"/api-reference/offer/start-signing-an-offer"},{"group":"Recipient","pages":[{"openapi":"delete /offer-recipients/{id}","title":"Remove an offer recipient","href":"/api-reference/offerrecipient/remove-an-offer-recipient"},{"openapi":"put /offer-recipients/{id}/role","title":"Change the role of an offer recipient","href":"/api-reference/offerrecipient/change-the-role-of-an-offer-recipient"}]},{"group":"Template","pages":[{"openapi":"get /offer-templates","title":"Get offer templates","href":"/api-reference/offertemplate/get-offer-templates"},{"openapi":"post /offer-templates","title":"Create an offer template","href":"/api-reference/offertemplate/create-an-offer-template"},{"openapi":"get /offer-templates/{id}","title":"Get an offer template","href":"/api-reference/offertemplate/get-an-offer-template"},{"openapi":"put /offer-templates/{id}","title":"Update an offer template","href":"/api-reference/offertemplate/update-an-offer-template"}]}]},{"group":"Checkout","pages":[{"group":"Checkout Link","pages":[{"openapi":"post /checkout-links","title":"Create a checkout link","href":"/api-reference/checkoutlink/create-a-checkout-link"},{"openapi":"get /checkout-links/{id}","title":"Get a checkout link","href":"/api-reference/checkoutlink/get-a-checkout-link"},{"openapi":"put /checkout-links/{id}","title":"Update a checkout link","href":"/api-reference/checkoutlink/update-a-checkout-link"},{"openapi":"get /checkout-link-items/{id}","title":"Get a checkout link item","href":"/api-reference/checkoutlinkitem/get-a-checkout-link-item"},{"openapi":"post /checkout-links/{id}/cart","title":"Create a cart from a checkout link","href":"/api-reference/checkoutlink/create-a-cart-from-a-checkout-link"}]},{"group":"Cart","pages":[{"openapi":"get /checkout/carts","title":"Retrieves completed carts of the current tenant.","href":"/api-reference/cart/retrieves-completed-carts-of-the-current-tenant"},{"openapi":"get /checkout/carts/{id}","title":"Retrieves a cart by its ID.","href":"/api-reference/cart/retrieves-a-cart-by-its-id"},{"openapi":"get /public/checkout/cart/{id}","title":"Retrieves a cart by its ID.","href":"/api-reference/cart/retrieves-a-cart-by-its-id-1"},{"openapi":"put /public/checkout/cart/{id}/change-quantity","title":"Changes the quantity of a cart item.","href":"/api-reference/cart/changes-the-quantity-of-a-cart-item"},{"openapi":"put /public/checkout/cart/{id}/confirm","title":"Confirms a cart.","href":"/api-reference/cart/confirms-a-cart"},{"openapi":"put /public/checkout/cart/{id}/confirm-otp","title":"Confirms the OTP of a cart.","href":"/api-reference/cart/confirms-the-otp-of-a-cart"},{"openapi":"get /public/checkout/cart/{id}/invoice-addresses","title":"Retrieves the invoice addresses of a cart.","href":"/api-reference/cart/retrieves-the-invoice-addresses-of-a-cart"},{"openapi":"get /public/checkout/cart/{id}/payment-methods","title":"Retrieves the payment methods of a cart.","href":"/api-reference/cart/retrieves-the-payment-methods-of-a-cart"},{"openapi":"put /public/checkout/cart/{id}/prepare-stripe","title":"Prepares a cart for stripe.","href":"/api-reference/cart/prepares-a-cart-for-stripe"}]}]},{"group":"Feature \u0026 Entitlement","pages":[{"openapi":"get /entitlement/features","title":"Get features","href":"/api-reference/feature/get-features"},{"openapi":"post /entitlement/features","title":"Create feature","href":"/api-reference/feature/create-feature"},{"openapi":"get /entitlement/features/{id}","title":"Get feature","href":"/api-reference/feature/get-feature"},{"openapi":"put /entitlement/features/{id}","title":"Update feature","href":"/api-reference/feature/update-feature"},{"openapi":"put /entitlement/features/{id}/status","title":"Update feature status","href":"/api-reference/feature/update-feature-status"},{"openapi":"post /entitlement/feature-assignments","title":"Assign feature","href":"/api-reference/feature/assign-feature"},{"openapi":"delete /entitlement/feature-assignments/{id}","title":"Unassign feature","href":"/api-reference/feature/unassign-feature"},{"openapi":"get /entitlement/feature-assignments","title":"Get feature assignments","href":"/api-reference/feature/get-feature-assignments"},{"group":"Entitlement","pages":[{"openapi":"get /subscriptions/{id}/available-features","title":"Get available features","href":"/api-reference/entitlement/get-available-features"},{"openapi":"post /subscriptions/{subscriptionId}/entitlements","title":"Add subscription entitlement","href":"/api-reference/entitlement/add-subscription-entitlement"},{"openapi":"get /subscriptions/{subscriptionId}/entitlements","title":"Get subscription entitlements","href":"/api-reference/entitlement/get-subscription-entitlements"},{"openapi":"post /subscription-items/{subscriptionItemId}/entitlements","title":"Add subscription item entitlement","href":"/api-reference/entitlement/add-subscription-item-entitlement"},{"openapi":"get /subscription-items/{subscriptionItemId}/entitlements","title":"Get subscription item entitlements","href":"/api-reference/entitlement/get-subscription-item-entitlements"},{"openapi":"put /entitlements/{id}/status","title":"Update entitlement status","href":"/api-reference/entitlement/update-entitlement-status"},{"openapi":"delete /entitlements/{id}","title":"Delete entitlement","href":"/api-reference/entitlement/delete-entitlement"}]}]},{"group":"Analytics","pages":[{"openapi":"get /analytics/series/{type}","title":"Get series data","href":"/api-reference/analytics/get-series-data"},{"openapi":"get /analytics/subscription-revenue","title":"Get series data for subscription","href":"/api-reference/analytics/get-series-data-for-subscription"}]},{"group":"Accounting","pages":[{"openapi":"get /accounting/accounts","title":"Get accounts","href":"/api-reference/accounting/get-accounts"},{"openapi":"put /accounting/accounts/{id}","title":"Update account","href":"/api-reference/accounting/update-account"},{"openapi":"get /accounting/postings","title":"Get postings","href":"/api-reference/accounting/get-postings"},{"group":"Cost Centre","pages":[{"openapi":"get /accounting/cost-centres","title":"Get all cost centres","href":"/api-reference/costcentre/get-all-cost-centres"},{"openapi":"post /accounting/cost-centres","title":"Add a cost centre","href":"/api-reference/costcentre/add-a-cost-centre"},{"openapi":"post /accounting/cost-centres/import","title":"Import cost centres","href":"/api-reference/costcentre/import-cost-centres"},{"openapi":"get /accounting/cost-centres/{id}","title":"Get a cost centre","href":"/api-reference/costcentre/get-a-cost-centre"},{"openapi":"patch /accounting/cost-centres/{id}","title":"Update a cost centre","href":"/api-reference/costcentre/update-a-cost-centre"}]},{"group":"Tax","pages":[{"openapi":"get /tax-groups","title":"Get tax groups","href":"/api-reference/tax/get-tax-groups"},{"openapi":"get /tax-groups/{id}","title":"Get tax group","href":"/api-reference/tax/get-tax-group"}]}]},{"group":"Settings","pages":[{"openapi":"get /settings/{context}","title":"Get settings","href":"/api-reference/settings/get-settings"},{"openapi":"patch /settings/{context}","title":"Update settings key","href":"/api-reference/settings/update-settings-key"},{"group":"User \u0026 Permissions","pages":[{"openapi":"get /tenant/accounts","title":"Get all accounts of the current tenant.","href":"/api-reference/account/get-all-accounts-of-the-current-tenant"},{"openapi":"put /accounts/{id}/deactivate","title":"Deactivate account","href":"/api-reference/account/deactivate-account"},{"openapi":"put /accounts/{id}/reactivate","title":"Reactivate account","href":"/api-reference/account/reactivate-account"},{"openapi":"put /accounts/{id}/role","title":"Update account role","href":"/api-reference/account/update-account-role"}]},{"group":"Media","pages":[{"openapi":"get /media","title":"Get all medias","href":"/api-reference/media/get-all-medias"},{"openapi":"post /media","title":"Upload a file","href":"/api-reference/media/upload-a-file"},{"openapi":"get /media-folders","title":"Get media folders","href":"/api-reference/media/get-media-folders"},{"openapi":"get /media/{id}","title":"Get a media","href":"/api-reference/media/get-a-media"},{"openapi":"post /media/{id}/download-token","title":"Create download token","href":"/api-reference/media/create-download-token"},{"openapi":"get /media/{id}/download/{token}","title":"Download by token","href":"/api-reference/media/download-by-token"}]},{"group":"Webhook","pages":[{"openapi":"get /available-webhook-events","title":"Get available webhook events","href":"/api-reference/webhook/get-available-webhook-events"},{"openapi":"get /webhooks","title":"Get webhooks","href":"/api-reference/webhook/get-webhooks"},{"openapi":"post /webhooks","title":"Add webhook","href":"/api-reference/webhook/add-webhook"},{"openapi":"get /webhooks/{id}","title":"Get webhook","href":"/api-reference/webhook/get-webhook"},{"openapi":"patch /webhooks/{id}","title":"Update webhook","href":"/api-reference/webhook/update-webhook"},{"openapi":"delete /webhooks/{id}","title":"Delete webhook","href":"/api-reference/webhook/delete-webhook"},{"openapi":"get /webhook-results","title":"Get webhook results","href":"/api-reference/webhook/get-webhook-results"},{"openapi":"get /webhook-results/{id}","title":"Get webhook result","href":"/api-reference/webhook/get-webhook-result"}]},{"group":"Notification","pages":[{"openapi":"get /notifications","title":"Get notifications","href":"/api-reference/sentnotification/get-notifications"},{"openapi":"get /notifications/{id}","title":"Get a notification","href":"/api-reference/sentnotification/get-a-notification"}]}]}]},{"tab":"API V2","pages":[{"title":"API V2","href":"/v2-plans-api/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/2026-07"}]}]},{"language":"en","pages":[{"title":"en","href":"/en/introduction"}]}]},"basePath":"","title":"Cancel subscription - Fynn Docs","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}