{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"TagadaPay Documentation","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/tagadapay/dAEln3JcPtxwff8y/logo/tagadalogo.png?fit=max\u0026auto=format\u0026n=dAEln3JcPtxwff8y\u0026q=85\u0026s=4dc2eb4eff0b0ba948b28de0226b7c95","dark":"https://mintcdn.com/tagadapay/dAEln3JcPtxwff8y/logo/tagadalogo.png?fit=max\u0026auto=format\u0026n=dAEln3JcPtxwff8y\u0026q=85\u0026s=4dc2eb4eff0b0ba948b28de0226b7c95"},"favicon":"https://mintcdn.com/tagadapay/Ps9CiAHh3vY6Nvlu/favicon.svg?fit=max\u0026auto=format\u0026n=Ps9CiAHh3vY6Nvlu\u0026q=85\u0026s=efbc04eeaada7549e650570bcfc8ce6d","api":{"playground":{}},"navbar":{"links":[{"href":"https://help.tagada.io","label":"Help Center"},{"href":"https://feedback.tagada.io/roadmap","label":"Roadmap"},{"href":"https://feedback.tagada.io/changelog","label":"Changelog"},{"href":"mailto:api-support@tagadapay.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://crm.tagadapay.com"}},"footer":{"socials":{"website":"https://tagadapay.com","github":"https://github.com/tagadapay"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Help Center","icon":"book-open","href":"https://help.tagada.io"},{"anchor":"Roadmap","icon":"map","href":"https://feedback.tagada.io/roadmap"},{"anchor":"Changelog","icon":"list","href":"https://feedback.tagada.io/changelog"},{"anchor":"Dashboard","icon":"chart-line","href":"https://crm.tagadapay.com"},{"anchor":"Support","icon":"life-ring","href":"mailto:api-support@tagadapay.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tagadapay","hasAudioNarration":false,"actualSubdomain":"tagadapay","customDomains":["docs.tagada.io"],"gitSource":{"type":"gitlab","owner":"tagadapay","repo":"tagadapay-app","deployBranch":"main","contentDirectory":"mintlify","isPrivate":true,"projectId":61148103,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad14dd4ea0cc68b75afac77","collectionId":"e427d11d-be31-4146-98c1-2411f9694656","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad14dd4ea0cc68b75afac77"},"entitlements":{},"buildId":"6ae0a8dab558859ea6ffe276","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":191},{"language":"default","tag":"Developer Tools","count":95},{"language":"default","tag":"plugins-v2","count":31},{"language":"default","tag":"portal","count":22},{"language":"default","tag":"Node SDK","count":18},{"language":"default","tag":"Headless SDK","count":14},{"language":"default","tag":"Tagada Rx","count":14},{"language":"default","tag":"Plugin SDK","count":12},{"language":"default","tag":"plugins","count":11},{"language":"default","tag":"payments","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"payments-api/reference/renewal_cycles/cancel-a-renewal-cycle","slug":"/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle","pageMetadata":{"title":"Cancel a renewal cycle","description":"Waits for a running try; a paid try wins.","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/renewal-cycles/{id}/cancel","href":"/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle","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: \"Waits for a running try; a paid try wins.\"\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 a renewal cycle","description":"Waits for a running try; a paid try wins.","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/renewal-cycles/{id}/cancel","href":"/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/tagadapay/81c11c0e163f81a7/utm-forward.js","/_mintlify/custom/tagadapay/d423b707fd32127b/x-pixel.js"],"openApiReferenceData":{"operation":{"description":"Waits for a running try; a paid try wins.","operationId":"renewalCycles.cancel","parameters":["daf4d7e0-e8b3-44d3-b3ec-22a06754b82a","462f9e9b-240c-4e07-82d5-7563a5f5a976","83ae016c-ad9b-4adb-87de-e50da338e4ae","24bb6c8e-c039-4678-b419-9f7840962bc4"],"requestBody":"141375ff-00cd-43ef-ab34-add4c20de7cc","responses":{"200":"3710edc6-4891-4015-8464-ae99df65a5c2","400":"4048b4c4-38e7-47b3-b691-a0214909d582","401":"db7dc728-e178-443f-8d90-ec2813b16dcc","403":"f8357ec3-b081-4a07-bd31-5d78992add2b","404":"4e6f78d3-7b82-490a-88a5-0325ea15e8cc","409":"ac781a8f-b05f-4036-8145-46fc31e8d471","429":"8c246d86-15ff-49c7-b63d-818bad6d2536","500":"e9400fe8-54b3-415e-b439-b4a3376c44b9","501":"c3462777-a63f-47c2-82e0-304537061e08"},"security":["21420715-cd3f-4d58-9d25-91f667a25ca8"],"summary":"Cancel a renewal cycle","tags":["renewal_cycles"],"x-scopes":["renewal_cycles:write"],"method":"post","type":"path","servers":["86626e06-dc75-436b-8631-aa208488503a"],"path":"/v1/renewal-cycles/{id}/cancel","baseUrlOptions":["https://api.tagada.io"],"title":"Cancel a renewal cycle","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"daf4d7e0-e8b3-44d3-b3ec-22a06754b82a":{"in":"path","name":"id","required":true,"schema":{"pattern":"^rcy_[0-9a-hjkmnp-tv-z]{26}$","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"462f9e9b-240c-4e07-82d5-7563a5f5a976":{"description":"Required for platform keys; refused for secret/publishable keys.","in":"header","name":"payments-account","required":false,"schema":{"description":"Required for platform keys; refused for secret/publishable keys.","type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"83ae016c-ad9b-4adb-87de-e50da338e4ae":{"in":"header","name":"payments-version","required":false,"schema":{"enum":["2026-11-01"],"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"24bb6c8e-c039-4678-b419-9f7840962bc4":{"in":"header","name":"idempotency-key","required":true,"schema":{"maxLength":255,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"3710edc6-4891-4015-8464-ae99df65a5c2":{"content":{"application/json":{"schema":{"properties":{"amount":{"description":"Integer amount in the currency minor unit.","maximum":2147483647,"minimum":0,"type":"integer","isRequired":true,"uniqueKey":"amount","typeLabel":"integer"},"card_update_until":{"oneOf":[{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"card_update_until.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","isRequired":true,"uniqueKey":"card_update_until.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"card_update_until","typeLabel":"string\u003cdate-time> | null"},"concluded_at":{"oneOf":[{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"concluded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","isRequired":true,"uniqueKey":"concluded_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"concluded_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"currency":{"type":"string","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"customer":{"type":"string","isRequired":true,"uniqueKey":"customer","typeLabel":"string"},"due_at":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"due_at","typeLabel":"string\u003cdate-time>"},"ending":{"oneOf":[{"enum":["cancel","pause",null],"type":"string","isRequired":true,"uniqueKey":"ending.oneOf.0","typeLabel":"enum\u003cstring>"},{"enum":["cancel","pause",null],"type":"null","isRequired":true,"uniqueKey":"ending.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ending","typeLabel":"enum\u003cstring> | null"},"id":{"pattern":"^rcy_[0-9a-hjkmnp-tv-z]{26}$","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"mode":{"enum":["live","test"],"type":"string","isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"next_try_at":{"oneOf":[{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"next_try_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","isRequired":true,"uniqueKey":"next_try_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_try_at","typeLabel":"string\u003cdate-time> | null"},"notice_sent_at":{"oneOf":[{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"notice_sent_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","isRequired":true,"uniqueKey":"notice_sent_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"notice_sent_at","typeLabel":"string\u003cdate-time> | null"},"object":{"enum":["renewal_cycle"],"type":"string","isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"outcome_reason":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"outcome_reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"outcome_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"outcome_reason","typeLabel":"string | null"},"payment_method":{"type":"string","isRequired":true,"uniqueKey":"payment_method","typeLabel":"string"},"period_ref":{"type":"string","isRequired":true,"uniqueKey":"period_ref","typeLabel":"string"},"policy_version":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"policy_version.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"policy_version.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"policy_version","typeLabel":"string | null"},"status":{"enum":["scheduled","trying","waiting_retry","waiting_card_update","waiting_customer","waiting_merchant","succeeded","failed","canceled"],"type":"string","x-extensible-enum":["scheduled","trying","waiting_retry","waiting_card_update","waiting_customer","waiting_merchant","succeeded","failed","canceled"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"store":{"type":"string","isRequired":true,"uniqueKey":"store","typeLabel":"string"},"subscription_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"subscription_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"subscription_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subscription_group_id","typeLabel":"string | null"},"subscription_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"subscription_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"subscription_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subscription_id","typeLabel":"string | null"},"test_clock":{"oneOf":[{"pattern":"^clk_[0-9a-hjkmnp-tv-z]{26}$","type":"string","isRequired":true,"uniqueKey":"test_clock.oneOf.0","typeLabel":"string"},{"pattern":"^clk_[0-9a-hjkmnp-tv-z]{26}$","type":"null","isRequired":true,"uniqueKey":"test_clock.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"test_clock","typeLabel":"string | null"},"tries":{"items":{"properties":{"amount":{"description":"Integer amount in the currency minor unit.","maximum":2147483647,"minimum":0,"type":"integer","isRequired":true,"uniqueKey":"tries.items.[INDEX].amount","typeLabel":"integer"},"payment":{"type":"string","isRequired":true,"uniqueKey":"tries.items.[INDEX].payment","typeLabel":"string"},"priced":{"type":"boolean","isRequired":true,"uniqueKey":"tries.items.[INDEX].priced","typeLabel":"boolean"},"processor":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"tries.items.[INDEX].processor.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"tries.items.[INDEX].processor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"tries.items.[INDEX].processor","typeLabel":"string | null"},"retry":{"minimum":0,"type":"integer","isRequired":true,"uniqueKey":"tries.items.[INDEX].retry","typeLabel":"integer"},"state":{"enum":["trying","paid","declined","skipped"],"type":"string","isRequired":true,"uniqueKey":"tries.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"switched":{"type":"boolean","isRequired":true,"uniqueKey":"tries.items.[INDEX].switched","typeLabel":"boolean"}},"required":["payment","processor","amount","retry","switched","priced","state"],"type":"object","uniqueKey":"tries.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"tries","typeLabel":"object[]"}},"required":["id","object","mode","store","customer","subscription_id","subscription_group_id","period_ref","amount","currency","payment_method","status","due_at","next_try_at","card_update_until","notice_sent_at","ending","outcome_reason","tries","policy_version","test_clock","created_at","concluded_at"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":1073741823,"card_update_until":"2023-11-07T05:31:56Z","concluded_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","currency":"\u003cstring>","customer":"\u003cstring>","due_at":"2023-11-07T05:31:56Z","ending":"cancel","id":"\u003cstring>","mode":"live","next_try_at":"2023-11-07T05:31:56Z","notice_sent_at":"2023-11-07T05:31:56Z","object":"renewal_cycle","outcome_reason":"\u003cstring>","payment_method":"\u003cstring>","period_ref":"\u003cstring>","policy_version":"\u003cstring>","status":"scheduled","store":"\u003cstring>","subscription_group_id":"\u003cstring>","subscription_id":"\u003cstring>","test_clock":"\u003cstring>","tries":[{"amount":1073741823,"payment":"\u003cstring>","priced":true,"processor":"\u003cstring>","retry":1,"state":"trying","switched":true}]}}},"exampleType":"generated"}},"description":"Renewal cycle with its tries.","exampleType":"generated"},"4048b4c4-38e7-47b3-b691-a0214909d582":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"type":"string","x-extensible-enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"type":{"enum":["invalid_request_error","authentication_error","permission_error","conflict_error","rate_limit_error","api_error","unavailable_error"],"type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"details":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"properties":{"credential_reason":{"oneOf":[{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"string","uniqueKey":"error.details.credential_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"null","uniqueKey":"error.details.credential_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.credential_reason","typeLabel":"enum\u003cstring> | null"},"cycle_id":{"pattern":"^rcy_[0-9a-hjkmnp-tv-z]{26}$","type":"string","uniqueKey":"error.details.cycle_id","typeLabel":"string"},"earliest_at":{"oneOf":[{"format":"date-time","type":"string","uniqueKey":"error.details.earliest_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","uniqueKey":"error.details.earliest_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.earliest_at","typeLabel":"string\u003cdate-time> | null"},"first_seen":{"description":"True only for the first refused offer of this subject and period.","type":"boolean","uniqueKey":"error.details.first_seen","typeLabel":"boolean"},"reason":{"enum":["store_not_on_payments_api","period_claimed_by_v2","billed_by_integration","period_in_v2_dunning","credential_v2_only","inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","not_a_card","wallet_without_processor_token","not_routable","law","minimum_wait","advice_code","card_budget","tombstone","payments_api_disabled"],"type":"string","uniqueKey":"error.details.reason","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["type","code","message","param","request_id"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"amount_out_of_range","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"invalid_request_error","details":{"credential_reason":"inactive_instrument","cycle_id":"\u003cstring>","earliest_at":"2023-11-07T05:31:56Z","first_seen":true,"reason":"store_not_on_payments_api"}}}}},"exampleType":"generated"}},"description":"parameter_invalid, parameter_missing, amount_out_of_range, payment_method_not_usable","exampleType":"generated"},"db7dc728-e178-443f-8d90-ec2813b16dcc":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"type":"string","x-extensible-enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"type":{"enum":["invalid_request_error","authentication_error","permission_error","conflict_error","rate_limit_error","api_error","unavailable_error"],"type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"details":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"properties":{"credential_reason":{"oneOf":[{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"string","uniqueKey":"error.details.credential_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"null","uniqueKey":"error.details.credential_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.credential_reason","typeLabel":"enum\u003cstring> | null"},"cycle_id":{"pattern":"^rcy_[0-9a-hjkmnp-tv-z]{26}$","type":"string","uniqueKey":"error.details.cycle_id","typeLabel":"string"},"earliest_at":{"oneOf":[{"format":"date-time","type":"string","uniqueKey":"error.details.earliest_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","uniqueKey":"error.details.earliest_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.earliest_at","typeLabel":"string\u003cdate-time> | null"},"first_seen":{"description":"True only for the first refused offer of this subject and period.","type":"boolean","uniqueKey":"error.details.first_seen","typeLabel":"boolean"},"reason":{"enum":["store_not_on_payments_api","period_claimed_by_v2","billed_by_integration","period_in_v2_dunning","credential_v2_only","inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","not_a_card","wallet_without_processor_token","not_routable","law","minimum_wait","advice_code","card_budget","tombstone","payments_api_disabled"],"type":"string","uniqueKey":"error.details.reason","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["type","code","message","param","request_id"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"amount_out_of_range","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"invalid_request_error","details":{"credential_reason":"inactive_instrument","cycle_id":"\u003cstring>","earliest_at":"2023-11-07T05:31:56Z","first_seen":true,"reason":"store_not_on_payments_api"}}}}},"exampleType":"generated"}},"description":"authentication_required","exampleType":"generated"},"f8357ec3-b081-4a07-bd31-5d78992add2b":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"type":"string","x-extensible-enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"type":{"enum":["invalid_request_error","authentication_error","permission_error","conflict_error","rate_limit_error","api_error","unavailable_error"],"type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"details":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"properties":{"credential_reason":{"oneOf":[{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"string","uniqueKey":"error.details.credential_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"null","uniqueKey":"error.details.credential_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.credential_reason","typeLabel":"enum\u003cstring> | null"},"cycle_id":{"pattern":"^rcy_[0-9a-hjkmnp-tv-z]{26}$","type":"string","uniqueKey":"error.details.cycle_id","typeLabel":"string"},"earliest_at":{"oneOf":[{"format":"date-time","type":"string","uniqueKey":"error.details.earliest_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","uniqueKey":"error.details.earliest_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.earliest_at","typeLabel":"string\u003cdate-time> | null"},"first_seen":{"description":"True only for the first refused offer of this subject and period.","type":"boolean","uniqueKey":"error.details.first_seen","typeLabel":"boolean"},"reason":{"enum":["store_not_on_payments_api","period_claimed_by_v2","billed_by_integration","period_in_v2_dunning","credential_v2_only","inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","not_a_card","wallet_without_processor_token","not_routable","law","minimum_wait","advice_code","card_budget","tombstone","payments_api_disabled"],"type":"string","uniqueKey":"error.details.reason","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["type","code","message","param","request_id"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"amount_out_of_range","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"invalid_request_error","details":{"credential_reason":"inactive_instrument","cycle_id":"\u003cstring>","earliest_at":"2023-11-07T05:31:56Z","first_seen":true,"reason":"store_not_on_payments_api"}}}}},"exampleType":"generated"}},"description":"permission_denied","exampleType":"generated"},"4e6f78d3-7b82-490a-88a5-0325ea15e8cc":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"type":"string","x-extensible-enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"type":{"enum":["invalid_request_error","authentication_error","permission_error","conflict_error","rate_limit_error","api_error","unavailable_error"],"type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"details":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"properties":{"credential_reason":{"oneOf":[{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"string","uniqueKey":"error.details.credential_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"null","uniqueKey":"error.details.credential_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.credential_reason","typeLabel":"enum\u003cstring> | null"},"cycle_id":{"pattern":"^rcy_[0-9a-hjkmnp-tv-z]{26}$","type":"string","uniqueKey":"error.details.cycle_id","typeLabel":"string"},"earliest_at":{"oneOf":[{"format":"date-time","type":"string","uniqueKey":"error.details.earliest_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","uniqueKey":"error.details.earliest_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.earliest_at","typeLabel":"string\u003cdate-time> | null"},"first_seen":{"description":"True only for the first refused offer of this subject and period.","type":"boolean","uniqueKey":"error.details.first_seen","typeLabel":"boolean"},"reason":{"enum":["store_not_on_payments_api","period_claimed_by_v2","billed_by_integration","period_in_v2_dunning","credential_v2_only","inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","not_a_card","wallet_without_processor_token","not_routable","law","minimum_wait","advice_code","card_budget","tombstone","payments_api_disabled"],"type":"string","uniqueKey":"error.details.reason","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["type","code","message","param","request_id"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"amount_out_of_range","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"invalid_request_error","details":{"credential_reason":"inactive_instrument","cycle_id":"\u003cstring>","earliest_at":"2023-11-07T05:31:56Z","first_seen":true,"reason":"store_not_on_payments_api"}}}}},"exampleType":"generated"}},"description":"resource_not_found","exampleType":"generated"},"ac781a8f-b05f-4036-8145-46fc31e8d471":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"type":"string","x-extensible-enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"type":{"enum":["invalid_request_error","authentication_error","permission_error","conflict_error","rate_limit_error","api_error","unavailable_error"],"type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"details":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"properties":{"credential_reason":{"oneOf":[{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"string","uniqueKey":"error.details.credential_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"null","uniqueKey":"error.details.credential_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.credential_reason","typeLabel":"enum\u003cstring> | null"},"cycle_id":{"pattern":"^rcy_[0-9a-hjkmnp-tv-z]{26}$","type":"string","uniqueKey":"error.details.cycle_id","typeLabel":"string"},"earliest_at":{"oneOf":[{"format":"date-time","type":"string","uniqueKey":"error.details.earliest_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","uniqueKey":"error.details.earliest_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.earliest_at","typeLabel":"string\u003cdate-time> | null"},"first_seen":{"description":"True only for the first refused offer of this subject and period.","type":"boolean","uniqueKey":"error.details.first_seen","typeLabel":"boolean"},"reason":{"enum":["store_not_on_payments_api","period_claimed_by_v2","billed_by_integration","period_in_v2_dunning","credential_v2_only","inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","not_a_card","wallet_without_processor_token","not_routable","law","minimum_wait","advice_code","card_budget","tombstone","payments_api_disabled"],"type":"string","uniqueKey":"error.details.reason","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["type","code","message","param","request_id"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"amount_out_of_range","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"invalid_request_error","details":{"credential_reason":"inactive_instrument","cycle_id":"\u003cstring>","earliest_at":"2023-11-07T05:31:56Z","first_seen":true,"reason":"store_not_on_payments_api"}}}}},"exampleType":"generated"}},"description":"idempotency_key_reused, idempotency_key_in_progress, cycle_not_open, notice_not_due, try_refused_by_law","exampleType":"generated"},"8c246d86-15ff-49c7-b63d-818bad6d2536":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"type":"string","x-extensible-enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"type":{"enum":["invalid_request_error","authentication_error","permission_error","conflict_error","rate_limit_error","api_error","unavailable_error"],"type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"details":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"properties":{"credential_reason":{"oneOf":[{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"string","uniqueKey":"error.details.credential_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"null","uniqueKey":"error.details.credential_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.credential_reason","typeLabel":"enum\u003cstring> | null"},"cycle_id":{"pattern":"^rcy_[0-9a-hjkmnp-tv-z]{26}$","type":"string","uniqueKey":"error.details.cycle_id","typeLabel":"string"},"earliest_at":{"oneOf":[{"format":"date-time","type":"string","uniqueKey":"error.details.earliest_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","uniqueKey":"error.details.earliest_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.earliest_at","typeLabel":"string\u003cdate-time> | null"},"first_seen":{"description":"True only for the first refused offer of this subject and period.","type":"boolean","uniqueKey":"error.details.first_seen","typeLabel":"boolean"},"reason":{"enum":["store_not_on_payments_api","period_claimed_by_v2","billed_by_integration","period_in_v2_dunning","credential_v2_only","inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","not_a_card","wallet_without_processor_token","not_routable","law","minimum_wait","advice_code","card_budget","tombstone","payments_api_disabled"],"type":"string","uniqueKey":"error.details.reason","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["type","code","message","param","request_id"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"amount_out_of_range","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"invalid_request_error","details":{"credential_reason":"inactive_instrument","cycle_id":"\u003cstring>","earliest_at":"2023-11-07T05:31:56Z","first_seen":true,"reason":"store_not_on_payments_api"}}}}},"exampleType":"generated"}},"description":"rate_limited","exampleType":"generated"},"e9400fe8-54b3-415e-b439-b4a3376c44b9":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"type":"string","x-extensible-enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"type":{"enum":["invalid_request_error","authentication_error","permission_error","conflict_error","rate_limit_error","api_error","unavailable_error"],"type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"details":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"properties":{"credential_reason":{"oneOf":[{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"string","uniqueKey":"error.details.credential_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"null","uniqueKey":"error.details.credential_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.credential_reason","typeLabel":"enum\u003cstring> | null"},"cycle_id":{"pattern":"^rcy_[0-9a-hjkmnp-tv-z]{26}$","type":"string","uniqueKey":"error.details.cycle_id","typeLabel":"string"},"earliest_at":{"oneOf":[{"format":"date-time","type":"string","uniqueKey":"error.details.earliest_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","uniqueKey":"error.details.earliest_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.earliest_at","typeLabel":"string\u003cdate-time> | null"},"first_seen":{"description":"True only for the first refused offer of this subject and period.","type":"boolean","uniqueKey":"error.details.first_seen","typeLabel":"boolean"},"reason":{"enum":["store_not_on_payments_api","period_claimed_by_v2","billed_by_integration","period_in_v2_dunning","credential_v2_only","inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","not_a_card","wallet_without_processor_token","not_routable","law","minimum_wait","advice_code","card_budget","tombstone","payments_api_disabled"],"type":"string","uniqueKey":"error.details.reason","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["type","code","message","param","request_id"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"amount_out_of_range","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"invalid_request_error","details":{"credential_reason":"inactive_instrument","cycle_id":"\u003cstring>","earliest_at":"2023-11-07T05:31:56Z","first_seen":true,"reason":"store_not_on_payments_api"}}}}},"exampleType":"generated"}},"description":"internal_error","exampleType":"generated"},"c3462777-a63f-47c2-82e0-304537061e08":{"content":{"application/json":{"schema":{"properties":{"error":{"properties":{"code":{"enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"type":"string","x-extensible-enum":["amount_out_of_range","authentication_required","cycle_exists_for_period","cycle_not_open","cycle_open_for_subject","idempotency_key_in_progress","idempotency_key_reused","internal_error","no_active_policy","not_implemented","notice_not_due","parameter_invalid","parameter_missing","payment_method_not_usable","payments_api_disabled","period_claimed_by_v2","period_left_to_v2","period_refused","permission_denied","rate_limited","resource_not_found","store_not_on_payments_api","stored_credential_missing","try_refused_by_law"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"type":{"enum":["invalid_request_error","authentication_error","permission_error","conflict_error","rate_limit_error","api_error","unavailable_error"],"type":"string","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"details":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"properties":{"credential_reason":{"oneOf":[{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"string","uniqueKey":"error.details.credential_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"enum":["inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","billed_by_integration","not_a_card","wallet_without_processor_token","not_routable",null],"type":"null","uniqueKey":"error.details.credential_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.credential_reason","typeLabel":"enum\u003cstring> | null"},"cycle_id":{"pattern":"^rcy_[0-9a-hjkmnp-tv-z]{26}$","type":"string","uniqueKey":"error.details.cycle_id","typeLabel":"string"},"earliest_at":{"oneOf":[{"format":"date-time","type":"string","uniqueKey":"error.details.earliest_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"format":"date-time","type":"null","uniqueKey":"error.details.earliest_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details.earliest_at","typeLabel":"string\u003cdate-time> | null"},"first_seen":{"description":"True only for the first refused offer of this subject and period.","type":"boolean","uniqueKey":"error.details.first_seen","typeLabel":"boolean"},"reason":{"enum":["store_not_on_payments_api","period_claimed_by_v2","billed_by_integration","period_in_v2_dunning","credential_v2_only","inactive_instrument","customer_mismatch","credential_revoked","no_off_session_agreement","no_network_transaction_id","no_chargeable_token","not_a_card","wallet_without_processor_token","not_routable","law","minimum_wait","advice_code","card_budget","tombstone","payments_api_disabled"],"type":"string","uniqueKey":"error.details.reason","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"error.details","typeLabel":"object"}},"required":["type","code","message","param","request_id"],"type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"amount_out_of_range","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>","type":"invalid_request_error","details":{"credential_reason":"inactive_instrument","cycle_id":"\u003cstring>","earliest_at":"2023-11-07T05:31:56Z","first_seen":true,"reason":"store_not_on_payments_api"}}}}},"exampleType":"generated"}},"description":"not_implemented","exampleType":"generated"}},"security":{"21420715-cd3f-4d58-9d25-91f667a25ca8":{"bearerAuth":{"description":"Secret, platform or publishable API key. Platform keys require Payments-Account.","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"86626e06-dc75-436b-8631-aa208488503a":{"url":"https://api.tagada.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Secret, platform or publishable API key. Platform keys require Payments-Account.","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Secret, platform or publishable API key. Platform keys require Payments-Account.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"payments-api/openapi.json"},"subdomain":"tagadapay","siteName":"TagadaPay Documentation","title":"Cancel a renewal cycle - TagadaPay Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T13:36:42.165Z","originalFileLocation":"payments-api/reference/renewal_cycles/cancel-a-renewal-cycle.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=\"Waits for a running try; a paid try wins.\">\u003cmeta data-mint-head name=\"application-name\" content=\"TagadaPay 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/tagadapay/0wRzSlWnlFmgp7vD/_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/tagadapay/0wRzSlWnlFmgp7vD/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tagadapay/0wRzSlWnlFmgp7vD/_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/tagadapay/0wRzSlWnlFmgp7vD/_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/tagadapay/0wRzSlWnlFmgp7vD/_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/tagadapay/0wRzSlWnlFmgp7vD/_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/tagadapay/0wRzSlWnlFmgp7vD/_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/tagadapay/0wRzSlWnlFmgp7vD/_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/tagadapay/0wRzSlWnlFmgp7vD/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel a renewal cycle - TagadaPay Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Waits for a running try; a paid try wins.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"TagadaPay Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tagada.io/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tagadapay.mintlify.app/_mintlify/api/og/v2?division=Renewal+cycles\u0026amp;title=Cancel+a+renewal+cycle\u0026amp;description=Waits+for+a+running+try%3B+a+paid+try+wins.\u0026amp;theme=4a795dedb4e93ebd54a8d8c9\u0026amp;signature=b75f8bce818a700b98b95003f2434b3026c4ee98b81afc2887845ece85a9cece\">\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 a renewal cycle - TagadaPay Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Waits for a running try; a paid try wins.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tagadapay.mintlify.app/_mintlify/api/og/v2?division=Renewal+cycles\u0026amp;title=Cancel+a+renewal+cycle\u0026amp;description=Waits+for+a+running+try%3B+a+paid+try+wins.\u0026amp;theme=4a795dedb4e93ebd54a8d8c9\u0026amp;signature=b75f8bce818a700b98b95003f2434b3026c4ee98b81afc2887845ece85a9cece\">\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/tagadapay/0wRzSlWnlFmgp7vD/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"TagadaPay Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tagada.io/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tagada.io/#organization\",\"name\":\"TagadaPay Documentation\",\"url\":\"https://docs.tagada.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tagadapay/dAEln3JcPtxwff8y/logo/tagadalogo.png?fit=max\u0026auto=format\u0026n=dAEln3JcPtxwff8y\u0026q=85\u0026s=4dc2eb4eff0b0ba948b28de0226b7c95\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tagada.io#website\",\"name\":\"TagadaPay Documentation\",\"url\":\"https://docs.tagada.io\",\"publisher\":{\"@id\":\"https://docs.tagada.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tagada.io/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle#webpage\",\"url\":\"https://docs.tagada.io/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle\",\"name\":\"Cancel a renewal cycle\",\"description\":\"Waits for a running try; a paid try wins.\",\"dateModified\":\"2026-10-27T13:36:42.165Z\",\"isPartOf\":{\"@id\":\"https://docs.tagada.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tagada.io/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tagada.io/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Renewal cycles\",\"item\":\"https://docs.tagada.io/payments-api/reference/renewal_cycles/create-a-renewal-cycle\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cancel a renewal cycle\",\"item\":\"https://docs.tagada.io/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tagada.io/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle#apireference\",\"headline\":\"Cancel a renewal cycle\",\"name\":\"Cancel a renewal cycle\",\"description\":\"Waits for a running try; a paid try wins.\",\"url\":\"https://docs.tagada.io/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tagada.io/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle#webpage\"},\"dateModified\":\"2026-10-27T13:36:42.165Z\",\"publisher\":{\"@id\":\"https://docs.tagada.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tagada.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"TagadaPay Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"TagadaPay Documentation","nav":{"global":{"anchors":[{"anchor":"Help Center","icon":"book-open","href":"https://help.tagada.io"},{"anchor":"Roadmap","icon":"map","href":"https://feedback.tagada.io/roadmap"},{"anchor":"Changelog","icon":"list","href":"https://feedback.tagada.io/changelog"},{"anchor":"Dashboard","icon":"chart-line","href":"https://crm.tagadapay.com"},{"anchor":"Support","icon":"life-ring","href":"mailto:api-support@tagadapay.com"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Developer Tools","pages":[{"title":"Developer Tools","href":"/developer-tools"}]},{"tab":"Partners","hidden":true,"pages":[{"title":"Partners","href":"/developer-tools/partners/introduction"}]},{"tab":"Tagada Rx","pages":[{"title":"Tagada Rx","href":"/developer-tools/rx/introduction"}]},{"tab":"Payments API (V3)","groups":[{"group":"Get started","pages":[{"title":"Payments API overview","sidebarTitle":"Overview","icon":"bolt","tag":"Preview","href":"/payments-api/overview"},{"title":"V2 or V3: which one should I use?","sidebarTitle":"V2 or V3?","icon":"code-compare","href":"/payments-api/v2-or-v3"},{"title":"Migrate from V2 to the Payments API","sidebarTitle":"Migrate from V2","icon":"route","tag":"Preview","href":"/payments-api/migrate-from-v2"}]},{"group":"Core concepts","pages":[{"title":"Authentication and keys","sidebarTitle":"Authentication","icon":"key","tag":"Preview","href":"/payments-api/authentication"},{"title":"API versions","sidebarTitle":"Versioning","icon":"code-branch","tag":"Preview","href":"/payments-api/versioning"},{"title":"Idempotent requests","sidebarTitle":"Idempotency","icon":"repeat","tag":"Preview","href":"/payments-api/idempotency"},{"title":"Errors","icon":"triangle-exclamation","tag":"Preview","href":"/payments-api/errors"},{"title":"Payment lifecycle","icon":"arrows-spin","tag":"Preview","href":"/payments-api/payment-lifecycle"},{"title":"3D Secure","icon":"shield-check","tag":"Preview","href":"/payments-api/three-d-secure"},{"title":"Webhooks","icon":"webhook","tag":"Coming soon","href":"/payments-api/webhooks"}]},{"group":"Guides","pages":[{"title":"Accept a payment in the browser","sidebarTitle":"Browser client","icon":"window-maximize","tag":"Preview","href":"/payments-api/browser-client"}]},{"group":"API reference","pages":[{"title":"Payments API reference","sidebarTitle":"Introduction","icon":"book","tag":"Preview","href":"/payments-api/reference/introduction"}]},{"group":"Payments","pages":[{"title":"Create a payment","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/payments","href":"/payments-api/reference/payments/create-a-payment"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/payments/{id}","href":"/payments-api/reference/payments/retrieve-a-payment"},{"title":"List payments","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/payments","href":"/payments-api/reference/payments/list-payments"},{"title":"Confirm a payment","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/payments/{id}/confirm","href":"/payments-api/reference/payments/confirm-a-payment"},{"title":"Capture an authorized payment","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/payments/{id}/capture","href":"/payments-api/reference/payments/capture-an-authorized-payment"},{"title":"Cancel a payment","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/payments/{id}/cancel","href":"/payments-api/reference/payments/cancel-a-payment"},{"title":"Retry a failed customer payment","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/payments/{id}/retry","href":"/payments-api/reference/payments/retry-a-failed-customer-payment"},{"title":"Report a finished 3DS step","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/payments/{id}/authentication","href":"/payments-api/reference/payments/report-a-finished-3ds-step"},{"title":"Read payment timeline","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/payments/{id}/timeline","href":"/payments-api/reference/payments/read-payment-timeline"}]},{"group":"Refunds","pages":[{"title":"Refund a payment","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/refunds","href":"/payments-api/reference/refunds/refund-a-payment"},{"title":"Retrieve a refund","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/refunds/{id}","href":"/payments-api/reference/refunds/retrieve-a-refund"},{"title":"List refunds","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/refunds","href":"/payments-api/reference/refunds/list-refunds"}]},{"group":"Disputes","pages":[{"title":"Retrieve a dispute on a payment","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/disputes/{id}","href":"/payments-api/reference/disputes/retrieve-a-dispute-on-a-payment"},{"title":"List disputes on payments","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/disputes","href":"/payments-api/reference/disputes/list-disputes-on-payments"}]},{"group":"Customers","pages":[{"title":"Create a customer of a store","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/customers","href":"/payments-api/reference/customers/create-a-customer-of-a-store"},{"title":"Retrieve a customer","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/customers/{id}","href":"/payments-api/reference/customers/retrieve-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json patch /v1/customers/{id}","href":"/payments-api/reference/customers/update-a-customer"},{"title":"List customers","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/customers","href":"/payments-api/reference/customers/list-customers"}]},{"group":"Payment methods","pages":[{"title":"Create a payment method from a vault token","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/payment-methods","href":"/payments-api/reference/payment_methods/create-a-payment-method-from-a-vault-token"},{"title":"Retrieve a payment method","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/payment-methods/{id}","href":"/payments-api/reference/payment_methods/retrieve-a-payment-method"},{"title":"List a customer's payment methods","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/payment-methods","href":"/payments-api/reference/payment_methods/list-a-customers-payment-methods"},{"title":"Detach a payment method","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/payment-methods/{id}/detach","href":"/payments-api/reference/payment_methods/detach-a-payment-method"}]},{"group":"Renewal cycles","pages":[{"title":"Create a renewal cycle","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/renewal-cycles","href":"/payments-api/reference/renewal_cycles/create-a-renewal-cycle"},{"title":"Retrieve a renewal cycle","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/renewal-cycles/{id}","href":"/payments-api/reference/renewal_cycles/retrieve-a-renewal-cycle"},{"title":"List renewal cycles","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/renewal-cycles","href":"/payments-api/reference/renewal_cycles/list-renewal-cycles"},{"title":"Ask for a try now","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/renewal-cycles/{id}/try-now","href":"/payments-api/reference/renewal_cycles/ask-for-a-try-now"},{"title":"Replace the card of an open renewal cycle","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/renewal-cycles/{id}/payment-method","href":"/payments-api/reference/renewal_cycles/replace-the-card-of-an-open-renewal-cycle"},{"title":"Confirm the cardholder notice was sent","description":"Platform keys only. Starts the card-update window after renewal_cycle.notice_due; a repeat is a success.","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/renewal-cycles/{id}/notice-sent","href":"/payments-api/reference/renewal_cycles/confirm-the-cardholder-notice-was-sent"},{"title":"Cancel a renewal cycle","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/renewal-cycles/{id}/cancel","href":"/payments-api/reference/renewal_cycles/cancel-a-renewal-cycle"}]},{"group":"Browser","pages":[{"title":"Get a store's publishable key, made on the first call","description":"The browser key of the caller's mode for one store, with the store's storefront origins as allowed_origins. Every call answers the same key and replaces its allowed_origins with the ones sent.","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/publishable-keys","href":"/payments-api/reference/publishable-keys/get-a-stores-publishable-key-made-on-the-first-call"},{"title":"Read the browser SDK configuration","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/client-config","href":"/payments-api/reference/eligibility/read-the-browser-sdk-configuration"},{"title":"List the payment methods to show","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/eligible-methods","href":"/payments-api/reference/eligibility/list-the-payment-methods-to-show"}]},{"group":"Payment policies","pages":[{"title":"Create a payment policy draft","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/payment-policies","href":"/payments-api/reference/policies/create-a-payment-policy-draft"},{"title":"Retrieve a payment policy","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/payment-policies/{id}","href":"/payments-api/reference/policies/retrieve-a-payment-policy"},{"title":"Replace a payment policy draft","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json patch /v1/payment-policies/{id}","href":"/payments-api/reference/policies/replace-a-payment-policy-draft"},{"title":"List payment policies","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/payment-policies","href":"/payments-api/reference/policies/list-payment-policies"},{"title":"Publish a payment policy version","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/payment-policies/{id}/publish","href":"/payments-api/reference/policies/publish-a-payment-policy-version"},{"title":"Assign a policy to a checkout or store default","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/payment-policies/{id}/assign","href":"/payments-api/reference/policies/assign-a-policy-to-a-checkout-or-store-default"},{"title":"List the published versions of a payment policy","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/payment-policies/{id}/versions","href":"/payments-api/reference/policies/list-the-published-versions-of-a-payment-policy"},{"title":"Build policy drafts from a store's V2 payment flows","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/payment-policies/import-v2","href":"/payments-api/reference/policies/build-policy-drafts-from-a-stores-v2-payment-flows"},{"title":"Publish a saved V2 flow import after reading its losses","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/payment-policies/import-v2/{id}/publish","href":"/payments-api/reference/policies/publish-a-saved-v2-flow-import-after-reading-its-losses"},{"title":"Retrieve the policy facts","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/policy-facts","href":"/payments-api/reference/policies/retrieve-the-policy-facts"}]},{"group":"Processors","pages":[{"title":"List processors","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/processors","href":"/payments-api/reference/processors/list-processors"},{"title":"Retrieve a processor","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/processors/{id}","href":"/payments-api/reference/processors/retrieve-a-processor"},{"title":"Refresh a processor profile","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/processors/{id}/sync","href":"/payments-api/reference/processors/refresh-a-processor-profile"},{"title":"Resume a processor","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/processors/{id}/resume","href":"/payments-api/reference/processors/resume-a-processor"},{"title":"Request a payment method","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/processors/{id}/method-requests","href":"/payments-api/reference/processors/request-a-payment-method"}]},{"group":"Block list","pages":[{"title":"Block an email, IP address or range, card or card range","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/block-list","href":"/payments-api/reference/block_list/block-an-email-ip-address-or-range-card-or-card-range"},{"title":"List block list entries","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json get /v1/block-list","href":"/payments-api/reference/block_list/list-block-list-entries"},{"title":"Lift a block","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/block-list/{id}/lift","href":"/payments-api/reference/block_list/lift-a-block"}]},{"group":"Test helpers","pages":[{"title":"Create a frozen test clock","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/test-helpers/clocks","href":"/payments-api/reference/test_helpers/create-a-frozen-test-clock"},{"title":"Advance a test clock","deprecated":null,"version":null,"openapi":"/payments-api/openapi.json post /v1/test-helpers/clocks/{id}/advance","href":"/payments-api/reference/test_helpers/advance-a-test-clock"}]}]},{"tab":"Commerce API (V2)","pages":[{"title":"Commerce API (V2)","href":"/api-reference/introduction"}]}]},"title":"Cancel a renewal cycle - TagadaPay Documentation","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}