The Pause Subscription API allows merchants to temporarily pause a customer subscription, halting any upcoming billing cycles until the subscription is resumed.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"DAS Gateway Documentation","description":"DAS Gateway Documentation – Payment Options","colors":{"primary":"#FFAB31","light":"#FFAB31","dark":"#F18A00"},"logo":{"light":"https://mintcdn.com/dasdoc/kfo25CLU3J6KbVVp/logo/logo_light.svg?fit=max\u0026auto=format\u0026n=kfo25CLU3J6KbVVp\u0026q=85\u0026s=1f64203e269639be1755143448350fbb","dark":"https://mintcdn.com/dasdoc/kfo25CLU3J6KbVVp/logo/logo_dark.svg?fit=max\u0026auto=format\u0026n=kfo25CLU3J6KbVVp\u0026q=85\u0026s=6fbde73fd21acab73c5c855d6ba4b797"},"favicon":"https://mintcdn.com/dasdoc/NIfdTDr2rgRx_fiM/favicon.svg?fit=max\u0026auto=format\u0026n=NIfdTDr2rgRx_fiM\u0026q=85\u0026s=f60dbe0773d392063369684cd1f7d184","appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://me.paymentoptions.com/onboarding/choose-account","label":"Create an Account"}],"primary":{"type":"button","label":"Sign in","href":"https://me.paymentoptions.com"}},"footer":{"socials":{"website":"https://www.paymentoptions.com","linkedin":"https://www.linkedin.com/company/payment-options"}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"documentation/overview"},{"language":"jp","href":"documentation-jp/overview"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dasdoc","hasAudioNarration":false,"actualSubdomain":"dasdoc","customDomains":["docs.paymentoptions.com"],"gitSource":{"type":"github","owner":"paymentoptions","repo":"das-docs-v2","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad97f54881c7e3d02873525","collectionId":"7274ccae-954e-4b28-a7ba-53c8aec8b874","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad97f54881c7e3d02873525"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad97f54881c7e3d02873525","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"en","tag":"API Reference","count":28},{"language":"jp","tag":"APIリファレンス","count":28},{"language":"en","tag":"API Endpoints","count":21},{"language":"en","tag":"Documentation","count":21},{"language":"jp","tag":"APIエンドポイント","count":21},{"language":"jp","tag":"ドキュメント","count":21},{"language":"en","tag":"Server To Server","count":9},{"language":"en","tag":"Support","count":9},{"language":"jp","tag":"サーバー間通信","count":9},{"language":"jp","tag":"サポート","count":9},{"language":"en","tag":"Payment Methods","count":7},{"language":"jp","tag":"決済方法","count":7},{"language":"en","tag":"Subscriptions","count":6},{"language":"en","tag":"Payments","count":6},{"language":"jp","tag":"サブスクリプション","count":6},{"language":"jp","tag":"決済","count":6},{"language":"en","tag":"Get Started","count":4},{"language":"jp","tag":"スタートガイド","count":4},{"language":"en","tag":"Getting Started","count":3},{"language":"jp","tag":"入門","count":3}]},"assistantConfig":{},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/en/subscription/pause-subscription","slug":"/api-reference/en/subscription/pause-subscription","pageMetadata":{"title":"Pause Subscription API","openapi":"api-reference/en/open-api-config/subscription/pause-subscription.json POST /api/v1/server-to-server-interface/subscription/{subscription_id}/pause","description":"The Pause Subscription API allows merchants to temporarily pause a customer subscription, halting any upcoming billing cycles until the subscription is resumed.","href":"/api-reference/en/subscription/pause-subscription"},"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: \"The Pause Subscription API allows merchants to temporarily pause a customer subscription, halting any upcoming billing cycles until the subscription is resumed.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Info,OptimizedImage}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`key-points`,children:`Key Points`}),`\n`,_jsxs(Info,{children:[_jsx(Heading,{level:`3`,id:`pause-a-subscription`,children:`Pause a Subscription`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:`Merchants can use this API to pause a subscription, which stops future billing for the customer until the subscription is resumed.`}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:`During the paused period, the subscription remains active but will not trigger billing or provide services unless resumed.`}),`\n`]}),`\n`]}),_jsx(Heading,{level:`3`,id:`subscription-status`,children:`Subscription Status`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:`The subscription will change to paused status in the system.`}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:`No billing cycles will be processed while the subscription is paused, but the merchant retains control over when to resume the subscription.`}),`\n`]}),`\n`]}),_jsx(Heading,{level:`3`,id:`required-parameters`,children:`Required Parameters`}),_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Subscription ID: The unique identifier of the subscription to be paused.`}),`\n`]})]}),`\n`,_jsx(Heading,{level:`2`,id:`flow-diagram`,children:`Flow diagram`}),`\n`,_jsx(OptimizedImage,{src:`https://mintcdn.com/dasdoc/kfo25CLU3J6KbVVp/images/timeline-diagram/flows-API-subs-pause.svg?fit=max\u0026auto=format\u0026n=kfo25CLU3J6KbVVp\u0026q=85\u0026s=d3f34d92a8f58e8120debe28fb6d2755`,alt:`Flow diagram image`,\"data-og-width\":`1997`,width:`1997`,\"data-og-height\":`868`,height:`868`,\"data-path\":`images/timeline-diagram/flows-API-subs-pause.svg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/dasdoc/kfo25CLU3J6KbVVp/images/timeline-diagram/flows-API-subs-pause.svg?w=280\u0026fit=max\u0026auto=format\u0026n=kfo25CLU3J6KbVVp\u0026q=85\u0026s=9bcc2fda8819ce45896aebd85c21e110 280w, https://mintcdn.com/dasdoc/kfo25CLU3J6KbVVp/images/timeline-diagram/flows-API-subs-pause.svg?w=560\u0026fit=max\u0026auto=format\u0026n=kfo25CLU3J6KbVVp\u0026q=85\u0026s=c9021389e10722a551d24d6b94b51002 560w, https://mintcdn.com/dasdoc/kfo25CLU3J6KbVVp/images/timeline-diagram/flows-API-subs-pause.svg?w=840\u0026fit=max\u0026auto=format\u0026n=kfo25CLU3J6KbVVp\u0026q=85\u0026s=f0c8ede977315f543b2b0f2c545782ae 840w, https://mintcdn.com/dasdoc/kfo25CLU3J6KbVVp/images/timeline-diagram/flows-API-subs-pause.svg?w=1100\u0026fit=max\u0026auto=format\u0026n=kfo25CLU3J6KbVVp\u0026q=85\u0026s=46bb5be8677d1ed53bc1b7c60bb31e78 1100w, https://mintcdn.com/dasdoc/kfo25CLU3J6KbVVp/images/timeline-diagram/flows-API-subs-pause.svg?w=1650\u0026fit=max\u0026auto=format\u0026n=kfo25CLU3J6KbVVp\u0026q=85\u0026s=42df1f05bd25eeefa111da720062de1e 1650w, https://mintcdn.com/dasdoc/kfo25CLU3J6KbVVp/images/timeline-diagram/flows-API-subs-pause.svg?w=2500\u0026fit=max\u0026auto=format\u0026n=kfo25CLU3J6KbVVp\u0026q=85\u0026s=d00546d236c0e2e2894a600289c44926 2500w`}),`\n`,_jsx(Heading,{level:`2`,id:`api-parameters`,children:`Api Parameters`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Pause Subscription API","openapi":"api-reference/en/open-api-config/subscription/pause-subscription.json POST /api/v1/server-to-server-interface/subscription/{subscription_id}/pause","description":"The Pause Subscription API allows merchants to temporarily pause a customer subscription, halting any upcoming billing cycles until the subscription is resumed.","href":"/api-reference/en/subscription/pause-subscription"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Key Points","slug":"key-points","depth":2,"children":[{"title":"Pause a Subscription","slug":"pause-a-subscription","depth":3,"children":[]},{"title":"Subscription Status","slug":"subscription-status","depth":3,"children":[]},{"title":"Required Parameters","slug":"required-parameters","depth":3,"children":[]}]},{"title":"Flow diagram","slug":"flow-diagram","depth":2,"children":[]},{"title":"Api Parameters","slug":"api-parameters","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Pause Subscription","description":"The Pause Subscription API allows merchants to temporarily pause a customer subscription, halting any upcoming billing cycles until the subscription is resumed.","operationId":"pauseSubscription","parameters":["0c7c2066-3f08-44a0-8886-290fba2650ba"],"responses":{"200":"56aafdb2-5929-46c5-8434-ec17b01b44fd"},"method":"post","type":"path","servers":["e51c6108-153b-4ff4-bc8d-eb622433ed40"],"security":["4dcbfb3f-77c6-4367-b48d-b654c47df104"],"path":"/api/v1/server-to-server-interface/subscription/{subscription_id}/pause","baseUrlOptions":["https://api-dev.paymentoptions.com"],"title":"Pause Subscription","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0c7c2066-3f08-44a0-8886-290fba2650ba":{"name":"subscription_id","in":"path","required":true,"schema":{"type":"string","maxLength":36,"description":"The Subscription ID of the subscription. Example: 664dc930-88bd-4696-8807-5e0f1fedba0b.\nThe unique Subscription ID of the subscription.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"The Subscription ID of the subscription. Example: 664dc930-88bd-4696-8807-5e0f1fedba0b."}},"responses":{"56aafdb2-5929-46c5-8434-ec17b01b44fd":{"description":"A successful response indicating the subscription has been paused.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the operation was successful.","example":true,"uniqueKey":"success","typeLabel":"boolean"},"status_code":{"type":"integer","description":"The HTTP status code of the response.","example":200,"uniqueKey":"status_code","typeLabel":"integer"},"is_live":{"type":"boolean","description":"Indicates if the transaction is live or a test transaction.","example":false,"uniqueKey":"is_live","typeLabel":"boolean"},"gateway_response":{"type":"object","description":"Response details from the gateway.","properties":{"version":{"type":"string","description":"The version of the gateway.","example":"1","uniqueKey":"gateway_response.version","typeLabel":"string"},"type":{"type":"string","description":"Type of response (e.g., INFO for informative response).","example":"INFO","uniqueKey":"gateway_response.type","typeLabel":"string"},"message":{"type":"string","description":"Message response from the gateway.","example":"Subscription Updated.","uniqueKey":"gateway_response.message","typeLabel":"string"},"code":{"type":"string","description":"Response code from the gateway.","example":"INFO3000","uniqueKey":"gateway_response.code","typeLabel":"string"}},"uniqueKey":"gateway_response","typeLabel":"object"},"subscription_details":{"type":"object","description":"Details of the subscription.","properties":{"id":{"type":"string","description":"The Subscription ID.","example":"664dc930-88bd-4696-8807-5e0f1fedba0b","uniqueKey":"subscription_details.id","typeLabel":"string"},"type":{"type":"string","description":"The type of subscription (e.g., CYCLE or Unlimited).","example":"CYCLE","uniqueKey":"subscription_details.type","typeLabel":"string"},"max_cycle_count":{"type":"integer","description":"The maximum number of billing cycles.","example":10,"uniqueKey":"subscription_details.max_cycle_count","typeLabel":"integer"},"status":{"type":"string","description":"The updated status of the subscription.","example":"PAUSED","uniqueKey":"subscription_details.status","typeLabel":"string"},"completed_payment_cycle":{"type":"integer","description":"The number of completed payment cycles.","example":1,"uniqueKey":"subscription_details.completed_payment_cycle","typeLabel":"integer"},"last_payment_status":{"type":"string","description":"The status of the last payment made under this subscription.","example":"SUCCESSFUL","uniqueKey":"subscription_details.last_payment_status","typeLabel":"string"},"next_payment_date":{"type":"string","format":"date-time","description":"The next payment date of the subscription.","example":"2024-11-28T01:31:29.154Z","uniqueKey":"subscription_details.next_payment_date","typeLabel":"string\u003cdate-time>"},"next_payment_cycle":{"type":"integer","description":"The next payment cycle number.","example":2,"uniqueKey":"subscription_details.next_payment_cycle","typeLabel":"integer"},"subscription_plan_details":{"type":"object","description":"Details of the subscription plan.","properties":{"name":{"type":"string","description":"The name of the subscription plan.","example":"Three weeks plan","uniqueKey":"subscription_details.subscription_plan_details.name","typeLabel":"string"},"desc":{"type":"string","description":"The description of the subscription plan.","example":"Billed every two days","uniqueKey":"subscription_details.subscription_plan_details.desc","typeLabel":"string"},"billing_cycle_type":{"type":"string","description":"The type of billing cycle (e.g., DAYS or MONTHS).","example":"DAYS","uniqueKey":"subscription_details.subscription_plan_details.billing_cycle_type","typeLabel":"string"},"billing_cycle_interval":{"type":"integer","description":"The interval between billing cycles.","example":2,"uniqueKey":"subscription_details.subscription_plan_details.billing_cycle_interval","typeLabel":"integer"},"amount":{"type":"integer","description":"The payment amount for the subscription plan.","example":1000,"uniqueKey":"subscription_details.subscription_plan_details.amount","typeLabel":"integer"},"ccy":{"type":"string","description":"The currency of the subscription transaction.","example":"JPY","uniqueKey":"subscription_details.subscription_plan_details.ccy","typeLabel":"string"},"trial_period_duration":{"type":"string","description":"The duration of the trial period (if applicable).","example":"","uniqueKey":"subscription_details.subscription_plan_details.trial_period_duration","typeLabel":"string"},"trial_period_duration_type":{"type":"string","description":"The type of trial period duration (e.g., DAYS or MONTHS).","example":"NONE","uniqueKey":"subscription_details.subscription_plan_details.trial_period_duration_type","typeLabel":"string"},"plan_discount_percentage":{"type":"number","description":"The discount percentage for the subscription plan.","example":10,"uniqueKey":"subscription_details.subscription_plan_details.plan_discount_percentage","typeLabel":"number"},"plan_discount_duration":{"type":"integer","description":"The duration of the discount in billing cycles.","example":2,"uniqueKey":"subscription_details.subscription_plan_details.plan_discount_duration","typeLabel":"integer"}},"uniqueKey":"subscription_details.subscription_plan_details","typeLabel":"object"},"subscription_transaction_details":{"type":"array","description":"A list of transaction details for the subscription.","items":{"type":"object","properties":{"id":{"type":"string","description":"The Transaction ID of this subscription transaction.","example":"359f39bd-673a-47b3-b9ec-cbd6cd313b8e","uniqueKey":"subscription_details.subscription_transaction_details.items.[INDEX].id","typeLabel":"string"},"ref":{"type":"integer","description":"The reference of the subscription transaction.","example":74860,"uniqueKey":"subscription_details.subscription_transaction_details.items.[INDEX].ref","typeLabel":"integer"},"cycle":{"type":"integer","description":"The payment cycle number of the transaction.","example":1,"uniqueKey":"subscription_details.subscription_transaction_details.items.[INDEX].cycle","typeLabel":"integer"},"status":{"type":"string","description":"The status of the subscription transaction.","example":"SUCCESSFUL","uniqueKey":"subscription_details.subscription_transaction_details.items.[INDEX].status","typeLabel":"string"},"transaction_date":{"type":"string","format":"date-time","description":"The date of the subscription transaction.","example":"2024-11-26T01:31:29.000Z","uniqueKey":"subscription_details.subscription_transaction_details.items.[INDEX].transaction_date","typeLabel":"string\u003cdate-time>"},"amount":{"type":"integer","description":"The payment amount of the transaction.","example":900,"uniqueKey":"subscription_details.subscription_transaction_details.items.[INDEX].amount","typeLabel":"integer"},"ccy":{"type":"string","description":"The currency of the transaction.","example":"JPY","uniqueKey":"subscription_details.subscription_transaction_details.items.[INDEX].ccy","typeLabel":"string"},"event":{"type":"string","description":"The event type for the transaction (e.g., CAPTURED).","example":"CAPTURED","uniqueKey":"subscription_details.subscription_transaction_details.items.[INDEX].event","typeLabel":"string"}},"uniqueKey":"subscription_details.subscription_transaction_details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"subscription_details.subscription_transaction_details","typeLabel":"object[]"}},"uniqueKey":"subscription_details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"status_code":200,"is_live":false,"gateway_response":{"version":"1","type":"INFO","message":"Subscription Updated.","code":"INFO3000"},"subscription_details":{"id":"664dc930-88bd-4696-8807-5e0f1fedba0b","type":"CYCLE","max_cycle_count":10,"status":"PAUSED","completed_payment_cycle":1,"last_payment_status":"SUCCESSFUL","next_payment_date":"2024-11-28T01:31:29.154Z","next_payment_cycle":2,"subscription_plan_details":{"name":"Three weeks plan","desc":"Billed every two days","billing_cycle_type":"DAYS","billing_cycle_interval":2,"amount":1000,"ccy":"JPY","trial_period_duration":"","trial_period_duration_type":"NONE","plan_discount_percentage":10,"plan_discount_duration":2},"subscription_transaction_details":[{"id":"359f39bd-673a-47b3-b9ec-cbd6cd313b8e","ref":74860,"cycle":1,"status":"SUCCESSFUL","transaction_date":"2024-11-26T01:31:29.000Z","amount":900,"ccy":"JPY","event":"CAPTURED"}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4dcbfb3f-77c6-4367-b48d-b654c47df104":{"apiKeyAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"API Key for Authorization. Format: 'Basic YOUR_API_KEY_HERE'","scopes":[]},"xApiKeyAuth":{"type":"apiKey","name":"x-api-key","in":"header","description":"API Key specific to x-api-key.","scopes":[]}}},"servers":{"e51c6108-153b-4ff4-bc8d-eb622433ed40":{"url":"https://api-dev.paymentoptions.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"Authorization","in":"header","description":"API Key for Authorization. Format: 'Basic YOUR_API_KEY_HERE'","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"API Key for Authorization. Format: 'Basic YOUR_API_KEY_HERE'","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"Authorization"},{"scheme":{"type":"apiKey","name":"x-api-key","in":"header","description":"API Key specific to x-api-key.","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"API Key specific to x-api-key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"xApiKeyAuth","name":"x-api-key"}],"title":"apiKeyAuth \u0026 xApiKeyAuth"}]},"originalFileLocation":"api-reference/en/open-api-config/subscription/pause-subscription.json"},"subdomain":"dasdoc","siteName":"DAS Gateway Documentation","title":"Pause Subscription API - DAS Gateway Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/en/subscription/pause-subscription","matchLevel":0},"jp":{"href":"/api-reference/jp/subscription/pause-subscription","matchLevel":1}}},"lastModified":"2026-03-20T06:00:56.735Z","originalFileLocation":"api-reference/en/subscription/pause-subscription.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"The Pause Subscription API allows merchants to temporarily pause a customer subscription, halting any upcoming billing cycles until the subscription is resumed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"DAS Gateway Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dasdoc/hSwsXoA5BQlwi3mM/_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/dasdoc/hSwsXoA5BQlwi3mM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dasdoc/hSwsXoA5BQlwi3mM/_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/dasdoc/hSwsXoA5BQlwi3mM/_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/dasdoc/hSwsXoA5BQlwi3mM/_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/dasdoc/hSwsXoA5BQlwi3mM/_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/dasdoc/hSwsXoA5BQlwi3mM/_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/dasdoc/hSwsXoA5BQlwi3mM/_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/dasdoc/hSwsXoA5BQlwi3mM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Pause Subscription API - DAS Gateway Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"The Pause Subscription API allows merchants to temporarily pause a customer subscription, halting any upcoming billing cycles until the subscription is resumed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"DAS Gateway Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paymentoptions.com/api-reference/en/subscription/pause-subscription\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dasdoc.mintlify.app/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Pause+Subscription+API\u0026amp;description=The+Pause+Subscription+API+allows+merchants+to+temporarily+pause+a+customer+subscription%2C+halting+any+upcoming+billing+cycles+until+the+subscription+is+resumed.\u0026amp;theme=bf7f232f7392ec92b8c12904\u0026amp;signature=049c52fddf48a72c07eac52fca7059dd8f819cbd38320875b1c97d64d28f896f\">\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=\"Pause Subscription API - DAS Gateway Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The Pause Subscription API allows merchants to temporarily pause a customer subscription, halting any upcoming billing cycles until the subscription is resumed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dasdoc.mintlify.app/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Pause+Subscription+API\u0026amp;description=The+Pause+Subscription+API+allows+merchants+to+temporarily+pause+a+customer+subscription%2C+halting+any+upcoming+billing+cycles+until+the+subscription+is+resumed.\u0026amp;theme=bf7f232f7392ec92b8c12904\u0026amp;signature=049c52fddf48a72c07eac52fca7059dd8f819cbd38320875b1c97d64d28f896f\">\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/dasdoc/hSwsXoA5BQlwi3mM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"DAS Gateway Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FFAB31\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paymentoptions.com/api-reference/en/subscription/pause-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/en/subscription/pause-subscription.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.paymentoptions.com/api-reference/en/subscription/pause-subscription\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.paymentoptions.com/api-reference/jp/subscription/pause-subscription\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.paymentoptions.com/api-reference/en/subscription/pause-subscription\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paymentoptions.com/#organization\",\"name\":\"DAS Gateway Documentation\",\"url\":\"https://docs.paymentoptions.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dasdoc/kfo25CLU3J6KbVVp/logo/logo_light.svg?fit=max\u0026auto=format\u0026n=kfo25CLU3J6KbVVp\u0026q=85\u0026s=1f64203e269639be1755143448350fbb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paymentoptions.com#website\",\"name\":\"DAS Gateway Documentation\",\"url\":\"https://docs.paymentoptions.com\",\"publisher\":{\"@id\":\"https://docs.paymentoptions.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paymentoptions.com/api-reference/en/subscription/pause-subscription#webpage\",\"url\":\"https://docs.paymentoptions.com/api-reference/en/subscription/pause-subscription\",\"name\":\"Pause Subscription API\",\"description\":\"The Pause Subscription API allows merchants to temporarily pause a customer subscription, halting any upcoming billing cycles until the subscription is resumed.\",\"dateModified\":\"2026-03-20T06:00:56.735Z\",\"isPartOf\":{\"@id\":\"https://docs.paymentoptions.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paymentoptions.com/api-reference/en/subscription/pause-subscription#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paymentoptions.com/api-reference/en/subscription/pause-subscription#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Endpoints\",\"item\":\"https://docs.paymentoptions.com/api-reference/en/server-to-server/purchase\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Subscriptions\",\"item\":\"https://docs.paymentoptions.com/api-reference/en/subscription/create-subscription\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Pause Subscription API\",\"item\":\"https://docs.paymentoptions.com/api-reference/en/subscription/pause-subscription\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paymentoptions.com/api-reference/en/subscription/pause-subscription#apireference\",\"headline\":\"Pause Subscription API\",\"name\":\"Pause Subscription API\",\"description\":\"The Pause Subscription API allows merchants to temporarily pause a customer subscription, halting any upcoming billing cycles until the subscription is resumed.\",\"url\":\"https://docs.paymentoptions.com/api-reference/en/subscription/pause-subscription\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paymentoptions.com/api-reference/en/subscription/pause-subscription#webpage\"},\"dateModified\":\"2026-03-20T06:00:56.735Z\",\"publisher\":{\"@id\":\"https://docs.paymentoptions.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paymentoptions.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"DAS Gateway Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"DAS Gateway Documentation","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/documentation/overview"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference/en/introduction"},{"title":"Authentication","href":"/api-reference/en/authentication"},{"title":"Merchant Details","href":"/api-reference/en/merchant-details"}]},{"group":"API Endpoints","pages":[{"group":"Server To Server","pages":[{"group":"Purchase","pages":[{"title":"Purchase API (v1)","openapi":"api-reference/en/open-api-config/server-to-server/purchase.json POST /api/v1/server-to-server-interface/payment","href":"/api-reference/en/server-to-server/purchase"},{"title":"Purchase API (v2)","openapi":"api-reference/en/open-api-config/server-to-server/purchasev2.json POST /api/v1/server-to-server-interface/paymentv2","href":"/api-reference/en/server-to-server/purchasev2"},{"title":"3D Secure Integration","openapi":"api-reference/en/open-api-config/server-to-server/purchase.json POST /api/v1/server-to-server-interface/paymentv2","href":"/api-reference/en/server-to-server/3dsecure"}]},{"group":"Authorisation","pages":[{"title":"Authorization API (v1)","openapi":"api-reference/en/open-api-config/server-to-server/authorization.json POST /api/v1/server-to-server-interface/authorization","href":"/api-reference/en/server-to-server/authorization"},{"title":"Authorization API (v2)","openapi":"api-reference/en/open-api-config/server-to-server/authorizationv2.json POST /api/v1/server-to-server-interface/authorizationv2","href":"/api-reference/en/server-to-server/authorizationv2"}]},{"title":"Capture API","openapi":"api-reference/en/open-api-config/server-to-server/capture.json POST /api/v1/server-to-server-interface/capture","href":"/api-reference/en/server-to-server/capture"},{"title":"Refund API","openapi":"api-reference/en/open-api-config/server-to-server/refund.json POST /api/v1/server-to-server-interface/refund","href":"/api-reference/en/server-to-server/refund"},{"title":"Void Authorization API","openapi":"api-reference/en/open-api-config/server-to-server/void-authorization.json POST /api/v1/server-to-server-interface/void","href":"/api-reference/en/server-to-server/void-authorization"},{"title":"Transaction Status API","openapi":"api-reference/en/open-api-config/server-to-server/transaction-status.json GET /api/v1/server-to-server-interface/transaction/status/{transactionId}","href":"/api-reference/en/server-to-server/transaction-status"}]},{"group":"Tokenization","pages":[{"title":"Generate Token API","openapi":"api-reference/en/open-api-config/tokenization/generate-token.json POST /api/v1/server-to-server-interface/payment","href":"/api-reference/en/tokenization/generate-token"},{"title":"Use Token API","openapi":"api-reference/en/open-api-config/tokenization/use-token.json POST /api/v1/server-to-server-interface/payment","href":"/api-reference/en/tokenization/use-token"}]},{"group":"Subscriptions","pages":[{"title":"Create Subscription API","openapi":"api-reference/en/open-api-config/subscription/create-subscription.json POST /api/v1/server-to-server-interface/subscription/payment","href":"/api-reference/en/subscription/create-subscription"},{"title":"Cancel Subscription API","openapi":"api-reference/en/open-api-config/subscription/cancel-subscription.json POST /api/v1/server-to-server-interface/subscription/{subscription_id}/cancel","description":"The Cancel Subscription API allows merchants to permanently stop a customers subscription, preventing any future billing cycles and services.","href":"/api-reference/en/subscription/cancel-subscription"},{"title":"Pause Subscription API","openapi":"api-reference/en/open-api-config/subscription/pause-subscription.json POST /api/v1/server-to-server-interface/subscription/{subscription_id}/pause","href":"/api-reference/en/subscription/pause-subscription"},{"title":"Resume Subscription API","openapi":"api-reference/en/open-api-config/subscription/resume-subscription.json POST /api/v1/server-to-server-interface/subscription/{subscription_id}/resume","description":"The Resume Subscription API allows merchants to reactivate a previously paused subscription, resuming the billing cycle and associated services for the customer.","href":"/api-reference/en/subscription/resume-subscription"},{"title":"Subscription List API","openapi":"api-reference/en/open-api-config/subscription/subscription-list.json GET /api/v1/server-to-server-interface/subscription/list","href":"/api-reference/en/subscription/subscription-list"},{"title":"Subscription Details API","openapi":"api-reference/en/open-api-config/subscription/subscription-details.json GET /api/v1/server-to-server-interface/subscription/{subscription_id}","href":"/api-reference/en/subscription/subscription-details"}]},{"group":"Wallet","pages":[{"title":"E-Wallet","openapi":"api-reference/en/open-api-config/wallet/e-wallet.json POST /api/v1/server-to-server-interface/payment","href":"/api-reference/en/wallet/wallet"},{"title":"QR Payment","openapi":"api-reference/en/open-api-config/wallet/qr-payment.json POST /api/v1/server-to-server-interface/payment","href":"/api-reference/en/wallet/wallet-2"}]},{"group":"Hosted Payment Page","pages":[{"title":"Hosted Payment Page","openapi":"api-reference/en/open-api-config/hpp/generate-link.json POST /api/v1/server-to-server-interface/hpp/generate/link","href":"/api-reference/en/hpp/generate-link"},{"title":"Tokenization","openapi":"api-reference/en/open-api-config/hpp/generate-link-token.json POST /api/v1/server-to-server-interface/hpp/generate/link","href":"/api-reference/en/hpp/generate-link-tokenization"}]}]},{"group":"Error and Response","pages":[{"title":"HTTP Response","href":"/api-reference/en/error-and-response/httpresponse"},{"title":"Response Codes","href":"/api-reference/en/error-and-response/responsecodes"},{"title":"Gateway Error Codes","href":"/api-reference/en/error-and-response/gatewayerrors"}]},{"group":"Webhook","pages":[{"title":"Webhook Handler","href":"/api-reference/en/webhook-handler"}]}]},{"tab":"Change Logs","pages":[{"title":"Change Logs","href":"/releases/revisions"}]},{"tab":"Support","pages":[{"title":"Support","href":"/support/plugins-woocommerce"}]}]},{"language":"jp","pages":[{"title":"jp","href":"/api-reference/jp/subscription/pause-subscription"}]}]},"title":"Pause Subscription API - DAS Gateway Documentation","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a74be98ba7","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","zoom-image-lightbox-CaUwvYH3.js","lightbox-handle-r17bVUz3.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}