{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Dime Payments","colors":{"primary":"#31A449","light":"#4DC463","dark":"#227A34"},"logo":{"light":"https://mintcdn.com/dimepayments/Q8yVMCmJudUJMd5V/logo/dime-payments-logo-blk.png?fit=max\u0026auto=format\u0026n=Q8yVMCmJudUJMd5V\u0026q=85\u0026s=28ab42bc98549bb8ce6c84475f6b0986","dark":"https://mintcdn.com/dimepayments/heLQ-Gy9fIIqOCcJ/logo/dime-payments-logo-white.png?fit=max\u0026auto=format\u0026n=heLQ-Gy9fIIqOCcJ\u0026q=85\u0026s=f3ec611cac48c2e785ddc3a37e46ed97","href":"https://dimepayments.com"},"favicon":"https://mintlify.s3.us-west-1.amazonaws.com/dimepayments/favicon.ico","navbar":{"primary":{"type":"button","label":"Login","href":"https://app.dimepayments.com"}},"footer":{"socials":{}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dimepayments","hasAudioNarration":false,"actualSubdomain":"dimepayments","customDomains":["docs.dimepayments.com"],"gitSource":{"type":"github","owner":"dime-technology","repo":"mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af383a713a6f7b22050f6a8","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":87},{"language":"default","tag":"Help Center","count":31},{"language":"default","tag":"Invoice management","count":20},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Subscription Plans management","count":9},{"language":"default","tag":"Transaction management","count":9},{"language":"default","tag":"Account settings","count":8},{"language":"default","tag":"Recurring Payments management","count":8},{"language":"default","tag":"Payments and Deposits","count":7},{"language":"default","tag":"Churches and Nonprofits","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar img.nav-logo{height:3.25rem!important}"}],"page":{"pagePath":"api-reference/subscription-plans-management/archive-a-subscription-plan","slug":"/api-reference/subscription-plans-management/archive-a-subscription-plan","pageMetadata":{"title":"Archive a subscription plan","description":"Stops new subscriptions and hides it from the catalog. Existing subscribers\nkeep their subscription.","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/subscription-plan/archive","href":"/api-reference/subscription-plans-management/archive-a-subscription-plan","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: \"Stops new subscriptions and hides it from the catalog. Existing subscribers\\nkeep their subscription.\"\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":"Archive a subscription plan","description":"Stops new subscriptions and hides it from the catalog. Existing subscribers\nkeep their subscription.","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/subscription-plan/archive","href":"/api-reference/subscription-plans-management/archive-a-subscription-plan","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Archive a subscription plan","operationId":"archiveASubscriptionPlan","description":"Stops new subscriptions and hides it from the catalog. Existing subscribers\nkeep their subscription.","parameters":[],"responses":{"200":"25fbd413-2ef1-48dd-b698-51fa1de25c6f"},"tags":["Subscription Plans management"],"requestBody":"03a02771-ae68-48f6-af0f-433704a2f4fb","method":"patch","type":"path","servers":["035fef24-628a-4176-89f9-2e63f2522d10"],"security":["c1ca36fe-37b4-4f1c-b482-5ab120070823"],"path":"/api/subscription-plan/archive","baseUrlOptions":["https://app.dimepayments.com"],"title":"Archive a subscription plan","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"","example":{"sid":12345},"properties":{"sid":{"type":"integer","description":"The merchant SID.","example":12345,"isRequired":true,"uniqueKey":"data.sid","typeLabel":"integer"},"subscription_plan_id":{"type":"integer","description":"The plan id.","example":42,"isRequired":true,"uniqueKey":"data.subscription_plan_id","typeLabel":"integer"}},"required":["sid","subscription_plan_id"],"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"sid":12345}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"25fbd413-2ef1-48dd-b698-51fa1de25c6f":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"data":{"id":null,"name":"Monthly Membership 62492","description":"Iure odit et et modi ipsum nostrum omnis.","recurrence_schedule":"Monthly","status":"active","subtotal":"0.00","total":"0.00","token":"BExaLd8ZOtOtHle0JeCuY6z909sSddjryQ3xGmP7","public_url":"http://app.dimepayments.com/subscribe/BExaLd8ZOtOtHle0JeCuY6z909sSddjryQ3xGmP7","allow_public":true,"cover_fee_required":false,"created_at":null,"items":[]}},"properties":{"data":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","example":null,"uniqueKey":"data.id.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"data.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.id","typeLabel":"string | null"},"name":{"type":"string","example":"Monthly Membership 62492","uniqueKey":"data.name","typeLabel":"string"},"description":{"type":"string","example":"Iure odit et et modi ipsum nostrum omnis.","uniqueKey":"data.description","typeLabel":"string"},"recurrence_schedule":{"type":"string","example":"Monthly","uniqueKey":"data.recurrence_schedule","typeLabel":"string"},"status":{"type":"string","example":"active","uniqueKey":"data.status","typeLabel":"string"},"subtotal":{"type":"string","example":"0.00","uniqueKey":"data.subtotal","typeLabel":"string"},"total":{"type":"string","example":"0.00","uniqueKey":"data.total","typeLabel":"string"},"token":{"type":"string","example":"BExaLd8ZOtOtHle0JeCuY6z909sSddjryQ3xGmP7","uniqueKey":"data.token","typeLabel":"string"},"public_url":{"type":"string","example":"http://app.dimepayments.com/subscribe/BExaLd8ZOtOtHle0JeCuY6z909sSddjryQ3xGmP7","uniqueKey":"data.public_url","typeLabel":"string"},"allow_public":{"type":"boolean","example":true,"uniqueKey":"data.allow_public","typeLabel":"boolean"},"cover_fee_required":{"type":"boolean","example":false,"uniqueKey":"data.cover_fee_required","typeLabel":"boolean"},"created_at":{"oneOf":[{"type":"string","example":null,"uniqueKey":"data.created_at.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"data.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.created_at","typeLabel":"string | null"},"items":{"type":"array","example":[],"uniqueKey":"data.\\items","typeLabel":"array"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":null,"name":"Monthly Membership 62492","description":"Iure odit et et modi ipsum nostrum omnis.","recurrence_schedule":"Monthly","status":"active","subtotal":"0.00","total":"0.00","token":"BExaLd8ZOtOtHle0JeCuY6z909sSddjryQ3xGmP7","public_url":"http://app.dimepayments.com/subscribe/BExaLd8ZOtOtHle0JeCuY6z909sSddjryQ3xGmP7","allow_public":true,"cover_fee_required":false,"created_at":null,"items":[]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c1ca36fe-37b4-4f1c-b482-5ab120070823":{"default":{"type":"http","scheme":"bearer","description":"You can retrieve your token by visiting your dashboard and clicking \u003cb>Generate API token under your profile in top right\u003c/b>.","scopes":[],"schemeName":"default"}}},"servers":{"035fef24-628a-4176-89f9-2e63f2522d10":{"url":"https://app.dimepayments.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"You can retrieve your token by visiting your dashboard and clicking \u003cb>Generate API token under your profile in top right\u003c/b>.","scopes":[],"schemeName":"default"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"You can retrieve your token by visiting your dashboard and clicking \u003cb>Generate API token under your profile in top right\u003c/b>.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"default","name":"Authorization"}],"title":"default"}]},"originalFileLocation":"https://app.dimepayments.com/openapi.yaml"},"subdomain":"dimepayments","siteName":"Dime Payments","title":"Archive a subscription plan - Dime Payments","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T20:50:54.780Z","originalFileLocation":"api-reference/subscription-plans-management/archive-a-subscription-plan.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=\"Stops new subscriptions and hides it from the catalog. Existing subscribers keep their subscription.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Dime Payments\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/x-icon\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/dimepayments/favicon.ico\">\u003clink data-mint-head rel=\"icon\" type=\"image/x-icon\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/dimepayments/favicon.ico\">\u003clink data-mint-head rel=\"icon\" type=\"image/x-icon\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/dimepayments/favicon.ico\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/dimepayments/favicon.ico\">\u003cmeta data-mint-head property=\"og:title\" content=\"Archive a subscription plan - Dime Payments\">\u003cmeta data-mint-head property=\"og:description\" content=\"Stops new subscriptions and hides it from the catalog. Existing subscribers keep their subscription.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Dime Payments\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.dimepayments.com/api-reference/subscription-plans-management/archive-a-subscription-plan\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dimepayments.mintlify.site/_mintlify/api/og/v2?division=Subscription+Plans+management\u0026amp;title=Archive+a+subscription+plan\u0026amp;description=Stops+new+subscriptions+and+hides+it+from+the+catalog.+Existing+subscribers%0Akeep+their+subscription.\u0026amp;theme=67415b11e6adedf6fa8eb3dd\u0026amp;signature=524d5975f8856f82fda1d410f2cd1539f4051be3aaf40ba21f667d27a8ec6bf2\">\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=\"Archive a subscription plan - Dime Payments\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Stops new subscriptions and hides it from the catalog. Existing subscribers keep their subscription.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dimepayments.mintlify.site/_mintlify/api/og/v2?division=Subscription+Plans+management\u0026amp;title=Archive+a+subscription+plan\u0026amp;description=Stops+new+subscriptions+and+hides+it+from+the+catalog.+Existing+subscribers%0Akeep+their+subscription.\u0026amp;theme=67415b11e6adedf6fa8eb3dd\u0026amp;signature=524d5975f8856f82fda1d410f2cd1539f4051be3aaf40ba21f667d27a8ec6bf2\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/dimepayments/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Dime Payments\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#31A449\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.dimepayments.com/api-reference/subscription-plans-management/archive-a-subscription-plan\">\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-plans-management/archive-a-subscription-plan.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.dimepayments.com/#organization\",\"name\":\"Dime Payments\",\"url\":\"https://docs.dimepayments.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dimepayments/Q8yVMCmJudUJMd5V/logo/dime-payments-logo-blk.png?fit=max\u0026auto=format\u0026n=Q8yVMCmJudUJMd5V\u0026q=85\u0026s=28ab42bc98549bb8ce6c84475f6b0986\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.dimepayments.com#website\",\"name\":\"Dime Payments\",\"url\":\"https://docs.dimepayments.com\",\"publisher\":{\"@id\":\"https://docs.dimepayments.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.dimepayments.com/api-reference/subscription-plans-management/archive-a-subscription-plan#webpage\",\"url\":\"https://docs.dimepayments.com/api-reference/subscription-plans-management/archive-a-subscription-plan\",\"name\":\"Archive a subscription plan\",\"description\":\"Stops new subscriptions and hides it from the catalog. Existing subscribers keep their subscription.\",\"dateModified\":\"2026-11-10T20:50:54.780Z\",\"isPartOf\":{\"@id\":\"https://docs.dimepayments.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.dimepayments.com/api-reference/subscription-plans-management/archive-a-subscription-plan#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.dimepayments.com/api-reference/subscription-plans-management/archive-a-subscription-plan#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subscription Plans management\",\"item\":\"https://docs.dimepayments.com/api-reference/subscription-plans-management/list-subscription-plans\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Archive a subscription plan\",\"item\":\"https://docs.dimepayments.com/api-reference/subscription-plans-management/archive-a-subscription-plan\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.dimepayments.com/api-reference/subscription-plans-management/archive-a-subscription-plan#apireference\",\"headline\":\"Archive a subscription plan\",\"name\":\"Archive a subscription plan\",\"description\":\"Stops new subscriptions and hides it from the catalog. Existing subscribers keep their subscription.\",\"url\":\"https://docs.dimepayments.com/api-reference/subscription-plans-management/archive-a-subscription-plan\",\"mainEntityOfPage\":{\"@id\":\"https://docs.dimepayments.com/api-reference/subscription-plans-management/archive-a-subscription-plan#webpage\"},\"dateModified\":\"2026-11-10T20:50:54.780Z\",\"publisher\":{\"@id\":\"https://docs.dimepayments.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.dimepayments.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Dime Payments\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Dime Payments\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/subscription-plans-management/archive-a-subscription-plan.md","siteName":"Dime Payments","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/introduction"}]},{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help/shared/virtual-terminal"}]},{"tab":"API Reference","groups":[{"group":"Merchant management","pages":[{"title":"List Merchants","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/merchant/list","href":"/api-reference/merchant-management/list-merchants"},{"title":"Show a specific Merchant's Details","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/merchant/show","href":"/api-reference/merchant-management/show-a-specific-merchants-details"},{"title":"Create Merchant","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/merchant/create","href":"/api-reference/merchant-management/create-merchant"},{"title":"Update a specific Merchant's Details","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/merchant/update","href":"/api-reference/merchant-management/update-a-specific-merchants-details"},{"title":"Get a unique, secure link to the signup application for a Merchant.","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/merchant/get-form-link","href":"/api-reference/merchant-management/get-a-unique-secure-link-to-the-signup-application-for-a-merchant"},{"title":"Get a Merchant's onboarding status","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/merchant/application-status","href":"/api-reference/merchant-management/get-a-merchants-onboarding-status"}]},{"group":"Transaction management","pages":[{"title":"List Transactions","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/transactions","href":"/api-reference/transaction-management/list-transactions"},{"title":"Charge a Credit Card","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/transaction/charge-card","href":"/api-reference/transaction-management/charge-a-credit-card"},{"title":"Charge a Bank Account","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/transaction/charge-ach","href":"/api-reference/transaction-management/charge-a-bank-account"},{"title":"Tokenize a Credit Card","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/transaction/tokenize-card","href":"/api-reference/transaction-management/tokenize-a-credit-card"},{"title":"Show Transaction","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/transaction","href":"/api-reference/transaction-management/show-transaction"},{"title":"Authorize a Credit Card","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/transaction/authorize","href":"/api-reference/transaction-management/authorize-a-credit-card"},{"title":"Capture an Authorized Credit Card","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/transaction/capture","href":"/api-reference/transaction-management/capture-an-authorized-credit-card"},{"title":"Refund Transaction","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/transaction/refund","href":"/api-reference/transaction-management/refund-transaction"},{"title":"Void Transaction","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/transaction/void","href":"/api-reference/transaction-management/void-transaction"}]},{"group":"Chargeback management","pages":[{"title":"List Chargebacks","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/chargeback/list","href":"/api-reference/chargeback-management/list-chargebacks"},{"title":"Show Chargeback","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/chargeback/show","href":"/api-reference/chargeback-management/show-chargeback"}]},{"group":"Document management","pages":[{"title":"Upload Documents","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/document/upload","href":"/api-reference/document-management/upload-documents"},{"title":"List Documents","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/document/list","href":"/api-reference/document-management/list-documents"}]},{"group":"Addresses","pages":[{"title":"List Addresses","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/address/list","href":"/api-reference/addresses/list-addresses"},{"title":"Show Address","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/address/show","href":"/api-reference/addresses/show-address"},{"title":"Create Address","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/address/create","href":"/api-reference/addresses/create-address"},{"title":"Update Address","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/address/update","href":"/api-reference/addresses/update-address"},{"title":"Delete Address","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/address/delete","href":"/api-reference/addresses/delete-address"}]},{"group":"Customer management","pages":[{"title":"List Customers","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/customer/list","href":"/api-reference/customer-management/list-customers"},{"title":"Show Customer","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/customer/show","href":"/api-reference/customer-management/show-customer"},{"title":"Create Customer","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/customer/create","href":"/api-reference/customer-management/create-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/customer/update","href":"/api-reference/customer-management/update-customer"},{"title":"Delete Customer","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/customer/delete","href":"/api-reference/customer-management/delete-customer"}]},{"group":"Deposit management","pages":[{"title":"List Deposits","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/deposit/list","href":"/api-reference/deposit-management/list-deposits"},{"title":"List Deposits with Supporting Trans","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/deposit/list-with-trans","href":"/api-reference/deposit-management/list-deposits-with-supporting-trans"},{"title":"Show Deposit with Supporting Trans","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/deposit/show","href":"/api-reference/deposit-management/show-deposit-with-supporting-trans"}]},{"group":"Endpoints","pages":[{"title":"Tokenize a card typed on a phone keypad","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/telnyx/pay","href":"/api-reference/endpoints/tokenize-a-card-typed-on-a-phone-keypad"}]},{"group":"Held funds","pages":[{"title":"Get held balance","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/funds/balance","href":"/api-reference/held-funds/get-held-balance"},{"title":"List releasable transactions","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/funds/transactions","href":"/api-reference/held-funds/list-releasable-transactions"},{"title":"Release held funds","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/funds/release","href":"/api-reference/held-funds/release-held-funds"}]},{"group":"Invoice management","pages":[{"title":"List Invoices","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/invoices","href":"/api-reference/invoice-management/list-invoices"},{"title":"Show Invoice","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/invoice","href":"/api-reference/invoice-management/show-invoice"},{"title":"Create Invoice","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/invoice/create","href":"/api-reference/invoice-management/create-invoice"},{"title":"Update Invoice","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/invoice/update","href":"/api-reference/invoice-management/update-invoice"},{"title":"Delete Invoice","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/invoice/delete","href":"/api-reference/invoice-management/delete-invoice"},{"title":"Send Invoice","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/invoice/send","href":"/api-reference/invoice-management/send-invoice"},{"title":"Mark Invoice Sent","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/invoice/mark-sent","href":"/api-reference/invoice-management/mark-invoice-sent"},{"title":"Void Invoice","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/invoice/void","href":"/api-reference/invoice-management/void-invoice"},{"title":"Duplicate Invoice","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/invoice/duplicate","href":"/api-reference/invoice-management/duplicate-invoice"},{"title":"Pay Invoice","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/invoice/pay","href":"/api-reference/invoice-management/pay-invoice"},{"title":"Get Invoice Link","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/invoice/link","href":"/api-reference/invoice-management/get-invoice-link"},{"title":"Add Line Item","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/invoice/line-item/add","href":"/api-reference/invoice-management/add-line-item"},{"title":"Update Line Item","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/invoice/line-item/update","href":"/api-reference/invoice-management/update-line-item"},{"title":"Delete Line Item","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/invoice/line-item/delete","href":"/api-reference/invoice-management/delete-line-item"},{"title":"List Invoice Items","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/invoice/items","href":"/api-reference/invoice-management/list-invoice-items"},{"title":"Create Invoice Item","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/invoice/item/create","href":"/api-reference/invoice-management/create-invoice-item"},{"title":"List Recurring Invoices","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/recurring-invoices","href":"/api-reference/invoice-management/list-recurring-invoices"},{"title":"Show Recurring Invoice","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/recurring-invoice","href":"/api-reference/invoice-management/show-recurring-invoice"},{"title":"Create Recurring Invoice","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/recurring-invoice/create","href":"/api-reference/invoice-management/create-recurring-invoice"},{"title":"Cancel Recurring Invoice","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/recurring-invoice/cancel","href":"/api-reference/invoice-management/cancel-recurring-invoice"}]},{"group":"Payment Method management","pages":[{"title":"List payment methods for a customer","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/payment-method/list","href":"/api-reference/payment-method-management/list-payment-methods-for-a-customer"},{"title":"Show a Payment Method for a customer","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/payment-method/show","href":"/api-reference/payment-method-management/show-a-payment-method-for-a-customer"},{"title":"Create a Payment Method for a customer","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/payment-method/create","href":"/api-reference/payment-method-management/create-a-payment-method-for-a-customer"},{"title":"Update a Payment Method for a customer","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/payment-method/update","href":"/api-reference/payment-method-management/update-a-payment-method-for-a-customer"},{"title":"Delete a Payment Method for a customer","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/payment-method/delete","href":"/api-reference/payment-method-management/delete-a-payment-method-for-a-customer"}]},{"group":"Recurring Payments management","pages":[{"title":"List Recurring Payments","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/recurring-payment/list","href":"/api-reference/recurring-payments-management/list-recurring-payments"},{"title":"Pause Recurring Payment","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/recurring-payment/pause","href":"/api-reference/recurring-payments-management/pause-recurring-payment"},{"title":"Cancel Recurring Payment","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/recurring-payment/cancel","href":"/api-reference/recurring-payments-management/cancel-recurring-payment"},{"title":"Activate Recurring Payment","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/recurring-payment/activate","href":"/api-reference/recurring-payments-management/activate-recurring-payment"},{"title":"Edit Recurring Payment","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/recurring-payment/edit","href":"/api-reference/recurring-payments-management/edit-recurring-payment"},{"title":"Create Recurring Payment","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/recurring-payment/create","href":"/api-reference/recurring-payments-management/create-recurring-payment"},{"title":"Show Recurring Payment","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/recurring-payment/show","href":"/api-reference/recurring-payments-management/show-recurring-payment"},{"title":"Delete Recurring Payment","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/recurring-payment/delete","href":"/api-reference/recurring-payments-management/delete-recurring-payment"}]},{"group":"Subscription Plans management","pages":[{"title":"List subscription plans","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/subscription-plan/list","href":"/api-reference/subscription-plans-management/list-subscription-plans"},{"title":"Show a subscription plan","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/subscription-plan/show","href":"/api-reference/subscription-plans-management/show-a-subscription-plan"},{"title":"Create a subscription plan","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/subscription-plan/create","href":"/api-reference/subscription-plans-management/create-a-subscription-plan"},{"title":"Update a subscription plan","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/subscription-plan/edit","href":"/api-reference/subscription-plans-management/update-a-subscription-plan"},{"title":"Delete a subscription plan","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/subscription-plan/delete","href":"/api-reference/subscription-plans-management/delete-a-subscription-plan"},{"title":"Publish a subscription plan","description":"Moves a draft plan to active so customers can subscribe. The plan must be a\ndraft, carry at least one line item, and name no item the merchant has\ndeleted — deleting a fund archives the plans that carry it, and a plan\nreactivated afterwards has to have that line replaced before it can sell\nagain.","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/subscription-plan/publish","href":"/api-reference/subscription-plans-management/publish-a-subscription-plan"},{"title":"Archive a subscription plan","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/subscription-plan/archive","href":"/api-reference/subscription-plans-management/archive-a-subscription-plan"},{"title":"Reactivate a subscription plan","description":"Moves an archived plan back to draft so it can be reviewed and re-published.\n`allow_public` stays off until the merchant opts back into the catalog.","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/subscription-plan/unarchive","href":"/api-reference/subscription-plans-management/reactivate-a-subscription-plan"},{"title":"Subscribe a customer to a plan","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml post /api/subscription-plan/subscribe","href":"/api-reference/subscription-plans-management/subscribe-a-customer-to-a-plan"}]},{"group":"Subscriptions management","pages":[{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/subscription/list","href":"/api-reference/subscriptions-management/list-subscriptions"},{"title":"Show a subscription","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/subscription/show","href":"/api-reference/subscriptions-management/show-a-subscription"},{"title":"Pause a subscription","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/subscription/pause","href":"/api-reference/subscriptions-management/pause-a-subscription"},{"title":"Resume a subscription","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/subscription/resume","href":"/api-reference/subscriptions-management/resume-a-subscription"},{"title":"Cancel a subscription","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml patch /api/subscription/cancel","href":"/api-reference/subscriptions-management/cancel-a-subscription"}]},{"group":"Zapier","pages":[{"title":"Get New Customers","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/zapier/new-customers","href":"/api-reference/zapier/get-new-customers"},{"title":"Get Transactions","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/zapier/transactions","href":"/api-reference/zapier/get-transactions"},{"title":"Get Transactions by Customer","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/zapier/transactions/{phone}","href":"/api-reference/zapier/get-transactions-by-customer"},{"title":"Get Most Recent Transaction","deprecated":null,"version":null,"openapi":"https://app.dimepayments.com/openapi.yaml get /api/zapier/new-transactions","href":"/api-reference/zapier/get-most-recent-transaction"}]}]}]},"basePath":"","title":"Archive a subscription plan - Dime Payments","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}