Cancels an subscription.
You can provide a reason for cancellation in the request body. If no reason is provided, a default reason will be used: “User requested cancellation”.
If a subscription has been deleted or already canceled, a corresponding error will be returned. Supported PSPs: - Stripe - Paddle - Solidgate - Paypal - FunnelFox Payments
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FunnelFox","colors":{"primary":"#e18535","light":"#e18535","dark":"#e18535"},"logo":{"light":"https://mintcdn.com/funnelfox/j1sUFlbSAuzPUvc1/logo2.png?fit=max\u0026auto=format\u0026n=j1sUFlbSAuzPUvc1\u0026q=85\u0026s=96e66e531e885dda9f0f968608e3d80a","dark":"https://mintcdn.com/funnelfox/j1sUFlbSAuzPUvc1/logo2.png?fit=max\u0026auto=format\u0026n=j1sUFlbSAuzPUvc1\u0026q=85\u0026s=96e66e531e885dda9f0f968608e3d80a"},"favicon":"https://mintcdn.com/funnelfox/j1sUFlbSAuzPUvc1/logo2.png?fit=max\u0026auto=format\u0026n=j1sUFlbSAuzPUvc1\u0026q=85\u0026s=96e66e531e885dda9f0f968608e3d80a","navbar":{"links":[],"primary":{"type":"button","label":"Dashboard","href":"https://app.funnelfox.com"}},"footer":{"socials":{"x":"https://x.com/Funnelfoxhq","linkedin":"https://linkedin.com/company/funnelfoxhq"}},"integrations":{"ga4":{"measurementId":"G-P77PNGGTRP"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"funnelfox","hasAudioNarration":false,"actualSubdomain":"funnelfox","customDomains":["funnelfox.com"],"gitSource":{"type":"github","owner":"adaptyteam","repo":"funnelfox-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae3550686c7ae22426db31e","collectionId":"2407e5a7-f4be-4b12-b595-25285a1d76a5","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae3550686c7ae22426db31e"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae3550686c7ae22426db31e","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"FunnelFox","count":127},{"language":"default","tag":"Developer Docs","count":87},{"language":"default","tag":"FunnelFox Payments","count":81},{"language":"default","tag":"API reference","count":48},{"language":"default","tag":"Release Notes","count":47},{"language":"default","tag":"Changelog","count":47},{"language":"default","tag":"Integrations","count":43},{"language":"default","tag":"Webhook reference","count":42},{"language":"default","tag":"2025","count":34},{"language":"default","tag":"Editor","count":33}],"searchSettings":{"maxResults":6}},"assistantConfig":{"enableStarterQuestions":false},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".psp-compare table td:nth-child(n+2),.psp-compare table th:nth-child(n+2){text-align:center;vertical-align:middle}.psp-compare table td:first-child,.psp-compare table th:first-child{text-align:left;white-space:nowrap}"}],"page":{"pagePath":"api-reference/cancel-subscription","slug":"/api-reference/cancel-subscription","pageMetadata":{"title":"Cancel subscription","description":"Cancels an subscription.\nYou can provide a reason for cancellation in the request body. If no reason is provided, a default reason will be used: \"User requested cancellation\".\nIf a subscription has been deleted or already canceled, a corresponding error will be returned. Supported PSPs: - Stripe - Paddle - Solidgate - Paypal - FunnelFox Payments\n","deprecated":null,"version":null,"openapi":"/swagger/openapi.json post /subscriptions/{id}/cancel","href":"/api-reference/cancel-subscription","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Cancels an subscription.\\nYou can provide a reason for cancellation in the request body. If no reason is provided, a default reason will be used: “User requested cancellation”.\\nIf a subscription has been deleted or already canceled, a corresponding error will be returned. Supported PSPs: - Stripe - Paddle - Solidgate - Paypal - FunnelFox Payments\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Cancel subscription","description":"Cancels an subscription.\nYou can provide a reason for cancellation in the request body. If no reason is provided, a default reason will be used: \"User requested cancellation\".\nIf a subscription has been deleted or already canceled, a corresponding error will be returned. Supported PSPs: - Stripe - Paddle - Solidgate - Paypal - FunnelFox Payments\n","deprecated":null,"version":null,"openapi":"/swagger/openapi.json post /subscriptions/{id}/cancel","href":"/api-reference/cancel-subscription","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"SubscriptionCancel","summary":"Cancel subscription","description":"Cancels an subscription.\nYou can provide a reason for cancellation in the request body. If no reason is provided, a default reason will be used: \"User requested cancellation\".\nIf a subscription has been deleted or already canceled, a corresponding error will be returned. Supported PSPs: - Stripe - Paddle - Solidgate - Paypal - FunnelFox Payments\n","parameters":["bcbbd3c4-5408-4f21-a2bd-aff782b0bfa5","80087ea3-688c-49b3-a05d-42055c62a4a9"],"requestBody":"31d00700-e8f8-4c3c-b30c-e3b32f21a3ea","responses":{"200":"8560e088-9a6e-4fad-be7e-79e1b8116677","400":"1812e331-98fe-4121-b8e7-c288d7756a74","401":"75a5e04a-9c46-4458-876e-8b01ff90adef","404":"1ce86bd8-8e4a-4b29-8ef9-4fc7bdfc6ebf"},"method":"post","type":"path","servers":["dbe613c0-735a-481b-b939-95c7ab2d9464"],"security":[],"path":"/subscriptions/{id}/cancel","baseUrlOptions":["https://api.funnelfox.io/public/v1"],"title":"Cancel subscription","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"bcbbd3c4-5408-4f21-a2bd-aff782b0bfa5":{"in":"header","name":"Fox-Secret","required":true,"description":"Project Secret Key","schema":{"type":"string","example":"secret_","isRequired":true,"description":"Project Secret Key","uniqueKey":"","typeLabel":"string"}},"80087ea3-688c-49b3-a05d-42055c62a4a9":{"in":"path","name":"id","required":true,"description":"Subscription ID","schema":{"type":"string","isRequired":true,"description":"Subscription ID","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","description":"Cancellation reason","uniqueKey":"reason","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8560e088-9a6e-4fad-be7e-79e1b8116677":{"description":"subscription cancelled successfully","content":{"application/json":{"schema":{"type":"object","required":["id","psp_id","status","profile","funnel","funnel_version","billing_interval","billing_interval_count","price","currency","price_usd","payment_provider","created_at","updated_at","period_starts_at","renews","sandbox","session","cancel_scheduled"],"properties":{"id":{"type":"string","x-go-name":"ID","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"psp_id":{"type":"string","x-go-name":"PSPID","isRequired":true,"uniqueKey":"psp_id","typeLabel":"string"},"status":{"type":"string","enum":["created","trialing","active","paused","cancelled","expired","unpaid"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"profile":{"type":"object","required":["id","created_at"],"properties":{"id":{"type":"string","x-go-name":"ID","isRequired":true,"uniqueKey":"profile.id","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"profile.created_at","typeLabel":"string\u003cdate-time>"},"email":{"type":"string","uniqueKey":"profile.email","typeLabel":"string"},"preview":{"type":"boolean","uniqueKey":"profile.preview","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"profile","typeLabel":"object"},"funnel":{"type":"object","required":["id","title","alias","type"],"properties":{"id":{"type":"string","x-go-name":"ID","isRequired":true,"uniqueKey":"funnel.id","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"funnel.title","typeLabel":"string"},"alias":{"type":"string","description":"Alias/slug for the funnel","isRequired":true,"uniqueKey":"funnel.alias","typeLabel":"string"},"type":{"type":"string","enum":["default","cancellation","retargeting"],"isRequired":true,"uniqueKey":"funnel.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"funnel","typeLabel":"object"},"funnel_version":{"type":"integer","isRequired":true,"uniqueKey":"funnel_version","typeLabel":"integer"},"session":{"type":"object","required":["id","created_at"],"properties":{"id":{"type":"string","x-go-name":"ID","isRequired":true,"uniqueKey":"session.id","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"session.created_at","typeLabel":"string\u003cdate-time>"},"locale":{"type":"string","uniqueKey":"session.locale","typeLabel":"string"},"user_agent":{"type":"string","uniqueKey":"session.user_agent","typeLabel":"string"}},"isRequired":true,"uniqueKey":"session","typeLabel":"object"},"price":{"type":"integer","description":"Monetary amount in cents (e.g., $1.00 = 100 cents)","example":100,"isRequired":true,"uniqueKey":"price","typeLabel":"integer"},"currency":{"type":"string","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"price_usd":{"x-go-name":"PriceUSD","type":"integer","description":"Monetary amount in cents (e.g., $1.00 = 100 cents)","example":100,"isRequired":true,"uniqueKey":"price_usd","typeLabel":"integer"},"billing_interval":{"type":"string","enum":["day","week","month","year"],"isRequired":true,"uniqueKey":"billing_interval","typeLabel":"enum\u003cstring>"},"billing_interval_count":{"type":"integer","isRequired":true,"uniqueKey":"billing_interval_count","typeLabel":"integer"},"payment_provider":{"type":"string","enum":["stripe","paddle","paypal","braintree","solidgate"],"isRequired":true,"uniqueKey":"payment_provider","typeLabel":"enum\u003cstring>"},"renews":{"type":"boolean","isRequired":true,"uniqueKey":"renews","typeLabel":"boolean"},"sandbox":{"type":"boolean","isRequired":true,"uniqueKey":"sandbox","typeLabel":"boolean"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"period_starts_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"period_starts_at","typeLabel":"string\u003cdate-time>"},"cancel_scheduled":{"type":"boolean","description":"True when status is active or trialing and renews is false; access ends at period_ends_at.","isRequired":true,"uniqueKey":"cancel_scheduled","typeLabel":"boolean"},"funnel_locale":{"type":"string","uniqueKey":"funnel_locale","typeLabel":"string"},"experiment":{"type":"object","required":["id","title","alias","enabled"],"properties":{"id":{"type":"string","x-go-name":"ID","isRequired":true,"uniqueKey":"experiment.id","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"experiment.title","typeLabel":"string"},"alias":{"type":"string","isRequired":true,"uniqueKey":"experiment.alias","typeLabel":"string"},"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"experiment.enabled","typeLabel":"boolean"}},"uniqueKey":"experiment","typeLabel":"object"},"product_id":{"type":"string","x-go-name":"ProductID","uniqueKey":"product_id","typeLabel":"string"},"product":{"type":"object","required":["id","name","status"],"properties":{"id":{"type":"string","x-go-name":"ID","isRequired":true,"uniqueKey":"product.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"product.name","typeLabel":"string"},"status":{"type":"string","enum":["active","archived"],"isRequired":true,"uniqueKey":"product.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"product","typeLabel":"object"},"trial_offer":{"type":"string","enum":["free","paid"],"uniqueKey":"trial_offer","typeLabel":"enum\u003cstring>"},"trial_transaction_id":{"type":"string","x-go-name":"TrialTransactionID","uniqueKey":"trial_transaction_id","typeLabel":"string"},"period_ends_at":{"type":"string","format":"date-time","description":"End of the current period. When status is trialing, this is the trial end; when cancel_scheduled is true, this is when access ends.","uniqueKey":"period_ends_at","typeLabel":"string\u003cdate-time>"},"paused_at":{"type":"string","format":"date-time","uniqueKey":"paused_at","typeLabel":"string\u003cdate-time>"},"cancelled_at":{"type":"string","format":"date-time","uniqueKey":"cancelled_at","typeLabel":"string\u003cdate-time>"},"cancellation_reason":{"type":"string","uniqueKey":"cancellation_reason","typeLabel":"string"},"renewed_at":{"type":"string","format":"date-time","uniqueKey":"renewed_at","typeLabel":"string\u003cdate-time>"},"upgrades_to":{"type":"string","uniqueKey":"upgrades_to","typeLabel":"string"},"custom_entitlement":{"type":"string","uniqueKey":"custom_entitlement","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","psp_id":"\u003cstring>","status":"created","profile":{"id":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","email":"\u003cstring>","preview":true},"funnel":{"id":"\u003cstring>","title":"\u003cstring>","alias":"\u003cstring>","type":"default"},"funnel_version":123,"session":{"id":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","locale":"\u003cstring>","user_agent":"\u003cstring>"},"price":100,"currency":"\u003cstring>","price_usd":100,"billing_interval":"day","billing_interval_count":123,"payment_provider":"stripe","renews":true,"sandbox":true,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","period_starts_at":"2023-11-07T05:31:56Z","cancel_scheduled":true,"funnel_locale":"\u003cstring>","experiment":{"id":"\u003cstring>","title":"\u003cstring>","alias":"\u003cstring>","enabled":true},"product_id":"\u003cstring>","product":{"id":"\u003cstring>","name":"\u003cstring>","status":"active"},"trial_offer":"free","trial_transaction_id":"\u003cstring>","period_ends_at":"2023-11-07T05:31:56Z","paused_at":"2023-11-07T05:31:56Z","cancelled_at":"2023-11-07T05:31:56Z","cancellation_reason":"\u003cstring>","renewed_at":"2023-11-07T05:31:56Z","upgrades_to":"\u003cstring>","custom_entitlement":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1812e331-98fe-4121-b8e7-c288d7756a74":{"description":"Request error","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"75a5e04a-9c46-4458-876e-8b01ff90adef":{"description":"Authentication error","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"1ce86bd8-8e4a-4b29-8ef9-4fc7bdfc6ebf":{"description":"Subscription not found","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"dbe613c0-735a-481b-b939-95c7ab2d9464":{"url":"https://api.funnelfox.io/public/v1"}}},"originalFileLocation":"swagger/openapi.json"},"subdomain":"funnelfox","siteName":"FunnelFox","title":"Cancel subscription - FunnelFox","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-06T17:41:10.880Z","originalFileLocation":"api-reference/cancel-subscription.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Cancels an subscription. You can provide a reason for cancellation in the request body. If no reason is provided, a default reason will be used: \u0026quot;User requested cancellation\u0026quot;. If a subscription has been deleted or already canceled, a corresponding error will be returned. Supported PSPs: - Stripe - Paddle - Solidgate - Paypal - FunnelFox Payments\">\u003cmeta data-mint-head name=\"application-name\" content=\"FunnelFox\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/funnelfox/WR6O_i08dMvZ1LJb/_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=\"/docs/mintlify-assets/_mintlify/favicons/funnelfox/WR6O_i08dMvZ1LJb/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/funnelfox/WR6O_i08dMvZ1LJb/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/funnelfox/WR6O_i08dMvZ1LJb/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/funnelfox/WR6O_i08dMvZ1LJb/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/funnelfox/WR6O_i08dMvZ1LJb/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/funnelfox/WR6O_i08dMvZ1LJb/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/funnelfox/WR6O_i08dMvZ1LJb/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/funnelfox/WR6O_i08dMvZ1LJb/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel subscription - FunnelFox\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cancels an subscription. You can provide a reason for cancellation in the request body. If no reason is provided, a default reason will be used: \u0026quot;User requested cancellation\u0026quot;. If a subscription has been deleted or already canceled, a corresponding error will be returned. Supported PSPs: - Stripe - Paddle - Solidgate - Paypal - FunnelFox Payments\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FunnelFox\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://funnelfox.com/docs/api-reference/cancel-subscription\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://funnelfox.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Cancel+subscription\u0026amp;description=Cancels+an+subscription.%0AYou+can+provide+a+reason+for+cancellation+in+the+request+body.+If+no+reason+is+provided%2C+a+default+reason+will+be+used%3A+%22User+requested\u0026amp;theme=255e85bca02bae65bbe41ad3\u0026amp;signature=76060c349cbe39867bd1b6fdd991e8b8d65d0ff13140f8a91639ed530fd1b309\">\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 - FunnelFox\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cancels an subscription. You can provide a reason for cancellation in the request body. If no reason is provided, a default reason will be used: \u0026quot;User requested cancellation\u0026quot;. If a subscription has been deleted or already canceled, a corresponding error will be returned. Supported PSPs: - Stripe - Paddle - Solidgate - Paypal - FunnelFox Payments\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://funnelfox.mintlify.app/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Cancel+subscription\u0026amp;description=Cancels+an+subscription.%0AYou+can+provide+a+reason+for+cancellation+in+the+request+body.+If+no+reason+is+provided%2C+a+default+reason+will+be+used%3A+%22User+requested\u0026amp;theme=255e85bca02bae65bbe41ad3\u0026amp;signature=76060c349cbe39867bd1b6fdd991e8b8d65d0ff13140f8a91639ed530fd1b309\">\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=\"/docs/mintlify-assets/_mintlify/favicons/funnelfox/WR6O_i08dMvZ1LJb/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FunnelFox\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#e18535\">\u003clink data-mint-head rel=\"canonical\" href=\"https://funnelfox.com/docs/api-reference/cancel-subscription\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/cancel-subscription.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://funnelfox.com/#organization\",\"name\":\"FunnelFox\",\"url\":\"https://funnelfox.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/funnelfox/j1sUFlbSAuzPUvc1/logo2.png?fit=max\u0026auto=format\u0026n=j1sUFlbSAuzPUvc1\u0026q=85\u0026s=96e66e531e885dda9f0f968608e3d80a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://funnelfox.com/docs#website\",\"name\":\"FunnelFox\",\"url\":\"https://funnelfox.com/docs\",\"publisher\":{\"@id\":\"https://funnelfox.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://funnelfox.com/docs/api-reference/cancel-subscription#webpage\",\"url\":\"https://funnelfox.com/docs/api-reference/cancel-subscription\",\"name\":\"Cancel subscription\",\"description\":\"Cancels an subscription. You can provide a reason for cancellation in the request body. If no reason is provided, a default reason will be used: \\\"User requested cancellation\\\". If a subscription has been deleted or already canceled, a corresponding error will be returned. Supported PSPs: - Stripe - Paddle - Solidgate - Paypal - FunnelFox Payments\",\"dateModified\":\"2026-10-06T17:41:10.880Z\",\"isPartOf\":{\"@id\":\"https://funnelfox.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://funnelfox.com/docs/api-reference/cancel-subscription#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://funnelfox.com/docs/api-reference/cancel-subscription#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://funnelfox.com/docs/develop/api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://funnelfox.com/docs/api-reference/list-funnels\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Cancel subscription\",\"item\":\"https://funnelfox.com/docs/api-reference/cancel-subscription\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://funnelfox.com/docs/api-reference/cancel-subscription#apireference\",\"headline\":\"Cancel subscription\",\"name\":\"Cancel subscription\",\"description\":\"Cancels an subscription. You can provide a reason for cancellation in the request body. If no reason is provided, a default reason will be used: \\\"User requested cancellation\\\". If a subscription has been deleted or already canceled, a corresponding error will be returned. Supported PSPs: - Stripe - Paddle - Solidgate - Paypal - FunnelFox Payments\",\"url\":\"https://funnelfox.com/docs/api-reference/cancel-subscription\",\"mainEntityOfPage\":{\"@id\":\"https://funnelfox.com/docs/api-reference/cancel-subscription#webpage\"},\"dateModified\":\"2026-10-06T17:41:10.880Z\",\"publisher\":{\"@id\":\"https://funnelfox.com/#organization\"},\"isPartOf\":{\"@id\":\"https://funnelfox.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FunnelFox\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"FunnelFox","nav":{"global":null,"tabs":[{"tab":"FunnelFox","pages":[{"title":"FunnelFox","href":"/getting-started"}]},{"tab":"FunnelFox Payments","pages":[{"title":"FunnelFox Payments","href":"/billing"}]},{"tab":"Market Radar","pages":[{"title":"Market Radar","href":"/radar/overview"}]},{"tab":"Developer Docs","anchors":[{"anchor":"FunnelFox","icon":"square-chevron-up","groups":[{"group":"API reference","pages":[{"title":"FunnelFox API reference","sidebarTitle":"FunnelFox API","href":"/develop/api"},{"title":"Replies in API","sidebarTitle":"Replies in API","href":"/develop/replies-in-api"},{"group":"API Reference","pages":[{"title":"List funnels","deprecated":null,"version":null,"openapi":"/swagger/openapi.json get /funnels","href":"/api-reference/list-funnels"},{"title":"Get funnel details","deprecated":null,"version":null,"openapi":"/swagger/openapi.json get /funnels/{id}","href":"/api-reference/get-funnel-details"},{"title":"List products","deprecated":null,"version":null,"openapi":"/swagger/openapi.json get /products","href":"/api-reference/list-products"},{"title":"Get product details","deprecated":null,"version":null,"openapi":"/swagger/openapi.json get /products/{id}","href":"/api-reference/get-product-details"},{"title":"List profiles","deprecated":null,"version":null,"openapi":"/swagger/openapi.json get /profiles","href":"/api-reference/list-profiles"},{"title":"Get Profile","deprecated":null,"version":null,"openapi":"/swagger/openapi.json get /profiles/{profile_id}","href":"/api-reference/get-profile"},{"title":"Anonymize profiles","deprecated":null,"version":null,"openapi":"/swagger/openapi.json post /profiles/anonymize","href":"/api-reference/anonymize-profiles"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/swagger/openapi.json get /sessions","href":"/api-reference/list-sessions"},{"title":"Get Session","deprecated":null,"version":null,"openapi":"/swagger/openapi.json get /sessions/{session_id}","href":"/api-reference/get-session"},{"title":"Get Session Replies","deprecated":null,"version":null,"openapi":"/swagger/openapi.json get /sessions/{session_id}/replies","href":"/api-reference/get-session-replies"},{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/swagger/openapi.json get /subscriptions","href":"/api-reference/list-subscriptions"},{"title":"Get subscription details","description":null,"deprecated":null,"version":null,"openapi":"/swagger/openapi.json get /subscriptions/{id}","href":"/api-reference/get-subscription-details"},{"title":"Cancel subscription","deprecated":null,"version":null,"openapi":"/swagger/openapi.json post /subscriptions/{id}/cancel","href":"/api-reference/cancel-subscription"},{"title":"List transactions","description":null,"deprecated":null,"version":null,"openapi":"/swagger/openapi.json get /transactions","href":"/api-reference/list-transactions"},{"title":"Refund a transaction","deprecated":null,"version":null,"openapi":"/swagger/openapi.json post /transactions/{id}/refund","href":"/api-reference/refund-a-transaction"}]}]},{"group":"Webhook reference","pages":[{"title":"Webhooks setup \u0026 configuration","sidebarTitle":"FunnelFox webhooks","href":"/develop/webhooks"},{"title":"Replies in webhooks","sidebarTitle":"Replies in webhooks","href":"/develop/replies-in-webhooks"},{"title":"Password hashes in profile.updated","sidebarTitle":"Password hashes","href":"/develop/password-hashes"},{"group":"Webhook reference","pages":[{"title":"Onboardingstarted","version":null,"deprecated":null,"openapi":"/swagger/webhooks.json webhook onboarding.started","href":"/api-reference/webhook-reference/onboardingstarted"},{"title":"Onboardingcompleted","version":null,"deprecated":null,"openapi":"/swagger/webhooks.json webhook onboarding.completed","href":"/api-reference/webhook-reference/onboardingcompleted"},{"title":"Profileupdated","version":null,"deprecated":null,"openapi":"/swagger/webhooks.json webhook profile.updated","href":"/api-reference/webhook-reference/profileupdated"},{"title":"Purchasecompleted","version":null,"deprecated":null,"openapi":"/swagger/webhooks.json webhook purchase.completed","href":"/api-reference/webhook-reference/purchasecompleted"},{"title":"Subscriptioncreated","version":null,"deprecated":null,"openapi":"/swagger/webhooks.json webhook subscription.created","href":"/api-reference/webhook-reference/subscriptioncreated"},{"title":"Subscriptiontrialing","version":null,"deprecated":null,"openapi":"/swagger/webhooks.json webhook subscription.trialing","href":"/api-reference/webhook-reference/subscriptiontrialing"},{"title":"Subscriptionactive","version":null,"deprecated":null,"openapi":"/swagger/webhooks.json webhook subscription.active","href":"/api-reference/webhook-reference/subscriptionactive"},{"title":"Subscriptioncycle","version":null,"deprecated":null,"openapi":"/swagger/webhooks.json webhook subscription.cycle","href":"/api-reference/webhook-reference/subscriptioncycle"},{"title":"Subscriptionpaused","version":null,"deprecated":null,"openapi":"/swagger/webhooks.json webhook subscription.paused","href":"/api-reference/webhook-reference/subscriptionpaused"},{"title":"Subscriptionresumed","version":null,"deprecated":null,"openapi":"/swagger/webhooks.json webhook subscription.resumed","href":"/api-reference/webhook-reference/subscriptionresumed"},{"title":"Subscriptioncancelled","version":null,"deprecated":null,"openapi":"/swagger/webhooks.json webhook subscription.cancelled","href":"/api-reference/webhook-reference/subscriptioncancelled"},{"title":"Subscriptionauto renew off","version":null,"deprecated":null,"openapi":"/swagger/webhooks.json webhook subscription.auto_renew_off","href":"/api-reference/webhook-reference/subscriptionauto_renew_off"},{"title":"Subscriptionunpaid","version":null,"deprecated":null,"openapi":"/swagger/webhooks.json webhook subscription.unpaid","href":"/api-reference/webhook-reference/subscriptionunpaid"}]}]}]},{"anchor":"FunnelFox Payments","icon":"square-chevron-down","pages":[{"title":"FunnelFox Payments","href":"/develop/api-billing"}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/changelog"}]}]},"basePath":"","title":"Cancel subscription - FunnelFox","buildId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","deploymentId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D_4Sesi0.js","utils-DRHeK26p.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6d-DUc2.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dex7slho.js","snippetPresets-BcCEBp0Z.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CufowNTX.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-A4lJSCIe.js","shallow-DqoHP7zn.js","getApiPlaygroundDisplay-Cku8AmtL.js","CodeSnippet-CtHQbNqc.js","CodeSnippets-CGo5Cslf.js","Page-BoJxk0m8.js","getPastedJson-M-bKdue4.js","icon-DEqCU4st.js","MethodPill-DnfSSXiJ.js","DuplicateIcon-BHu2PE8M.js","createIcon-BPsE5X7c.js","DynamicMarkdown-Dnt6YhtR.js","SectionHeading-6CtFWqMQ.js","axios-vUo_bRtp.js","Markdown-BoKe_1fI.js","clsx-DM5-sUNJ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CkIdkovK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-B3e6Nh_r.js"]}