Responses are generated using AI and may contain mistakes.
Nova release: Agenda de recebíveis no Dashboard — Veja no Dashboard quanto você tem a receber em cada dia dos próximos 90 dias, com a nova Agenda de recebíveis em Financeiro e no detalhe do recebedor. Ver release notes
Atualiza só os campos enviados. Os demais ficam como estão.
recurrence aceita só cycles e startAt. O intervalo não pode ser alterado: recurrence.interval é ignorado sem erro e a resposta mantém o intervalo antigo. Para trocar o intervalo, cancele a assinatura e crie outra.
referenceKey não pode ser alterado. O campo é ignorado sem erro e a resposta mantém o valor original.
trial não pode ser alterado. Enviar trial devolve 400.
splitRules aceita só percentage. Regra com amount devolve 400.
startAt só muda antes do primeiro ciclo. Depois dele, devolve 400. Se a nova data for hoje ou ontem (UTC), o primeiro ciclo é cobrado na mesma chamada.
Cancelamento agendado. Com cancelAtPeriodEnd: true, a assinatura precisa estar active, paused, unpaid, trialing ou created; em canceled ou expired, devolve 409.
Atenção:cycles precisa ser maior que a quantidade de ciclos já executados, e items e splitRules não podem ser listas vazias. Valide os valores antes de enviar.
true agenda o cancelamento; false remove o agendamento. Ao agendar com recurrence.cycles definido, cycles passa a ser o ciclo atual mais um; ao remover, volta ao valor anterior. Agendar em assinatura canceled ou expired devolve 409
Data do cancelamento agendado (YYYY-MM-DD). Exige cancelAtPeriodEnd igual a true, enviado agora ou já salvo, e não pode ser anterior a ontem (UTC). Sem esta data, o cancelamento acontece em trial.endDate ou, sem trial, em recurrence.nextDueDate
Indica se a assinatura tem cancelamento agendado. Enquanto for true, recurrence.cycles mostra o ciclo atual mais um, e o valor anterior volta quando o agendamento é removido
Data efetiva do cancelamento agendado (YYYY-MM-DD). Só vem quando cancelAtPeriodEnd é true. Sem data enviada, é trial.endDate ou, sem trial, recurrence.nextDueDate
Motivo do cancelamento agendado. Só vem quando foi informado
Example:
"Cliente solicitou cancelamento"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Malga","description":"Documentação da Malga: API REST, SDKs, métodos de pagamento, provedores e referência OpenAPI para orquestração de pagamentos.","colors":{"primary":"#2FAC9B","light":"#39BFAD","dark":"#257C70"},"logo":{"light":"https://mintcdn.com/malga/vYWnjE_PEfqgCqeH/logo/light.svg?fit=max\u0026auto=format\u0026n=vYWnjE_PEfqgCqeH\u0026q=85\u0026s=60c63b525307d9a355741f58c18f3420","dark":"https://mintcdn.com/malga/Hsm6lJPRMWAJPkG-/logo/wordmark-white.svg?fit=max\u0026auto=format\u0026n=Hsm6lJPRMWAJPkG-\u0026q=85\u0026s=ea50ce46c10489c67470715f235e1bf0","href":"https://docs.malga.io"},"favicon":"https://mintcdn.com/malga/vYWnjE_PEfqgCqeH/logo/malga.svg?fit=max\u0026auto=format\u0026n=vYWnjE_PEfqgCqeH\u0026q=85\u0026s=d532b4d127383a206703b91b519fd67a","api":{"openapi":["api-reference/api-spec.yaml"],"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","go"],"prefill":true}},"navbar":{"primary":{"type":"button","label":"Quero testar","href":"https://malga.io/contato"}},"footer":{"socials":{"youtube":"https://www.youtube.com/@gomalga","linkedin":"https://www.linkedin.com/company/gomalga","instagram":"https://www.instagram.com/gomalga"},"links":[{"header":"Produto","items":[{"label":"Dashboard","href":"https://dashboard.malga.io/"},{"label":"Status","href":"https://status.malga.io/"}]},{"header":"Documentação","items":[{"label":"Introdução","href":"/documentations/welcome/introduction"},{"label":"Primeiros passos","href":"/documentations/welcome/primeiros-passos"},{"label":"Referência da API","href":"/api-reference/about-apis"},{"label":"SDKs","href":"/sdks/intro-sdk"},{"label":"Release Notes","href":"/release-notes/releases"}]},{"header":"Empresa","items":[{"label":"Site Malga","href":"https://malga.io"},{"label":"Contato","href":"https://malga.io/contato"}]}]},"search":{"prompt":"Pesquise ou pergunte algo..."},"seo":{"metatags":{"og:site_name":"Malga Docs","og:locale":"pt_BR"},"organization":{"name":"Malga","url":"https://malga.io","logo":"https://docs.malga.io/logo/light.svg","sameAs":["https://www.youtube.com/@gomalga","https://www.linkedin.com/company/gomalga/","https://www.instagram.com/gomalga"]},"indexing":"navigable"},"fonts":{"family":"Inter"},"integrations":{"amplitude":{"apiKey":"f26848c73ccd2e9606c95dac0cf0e765"},"ga4":{"measurementId":"G-RBZL7T96QN"},"hotjar":{"hjid":"2305294","hjsv":"6"}},"banner":{"content":"Nova release: **Agenda de recebíveis no Dashboard** — Veja no Dashboard quanto você tem a receber em cada dia dos próximos 90 dias, com a nova Agenda de recebíveis em Financeiro e no detalhe do recebedor. [Ver release notes](/release-notes/2026-10-29-Release-Notes)","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/malga/Hsm6lJPRMWAJPkG-/images/og-background.png?fit=max\u0026auto=format\u0026n=Hsm6lJPRMWAJPkG-\u0026q=85\u0026s=0acfaa17c5dd44e8c7d07b15292eed66","fonts":{"family":"Inter"}},"markdown":{"instructions":["Responda em português brasileiro, na segunda pessoa (\"você\"), com base na documentação Malga.","Não invente endpoints, parâmetros, status codes ou comportamentos de API. Se não estiver na docs, diga que não encontrou e indique a página mais próxima.","Use os headers X-Client-Id e X-Api-Key nos exemplos de autenticação.","Motor de Assinaturas refere-se a /v1/subscriptions* (cycles, trial, retentativas, webhooks subscription.*). Não chame de \"motor de recorrência\".","Recorrência (provedor) é paymentMethod.recurrence em POST /v1/charges (initial / subsequent / unscheduled), distinto do Motor de Assinaturas.","Sandbox é ambiente de testes e não afeta produção."]},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","icon":"table-layout","href":"https://dashboard.malga.io/"},{"anchor":"YouTube","icon":"youtube","href":"https://www.youtube.com/@gomalga"},{"anchor":"Status Page","icon":"signal-strong","href":"https://status.malga.io/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"malga","hasAudioNarration":false,"actualSubdomain":"malga","customDomains":["docs.malga.io"],"gitSource":{"type":"github","owner":"plughacker","repo":"malga-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af475f8e61bbc4648ba162b","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Documentação","count":190},{"language":"default","tag":"Release Notes","count":176},{"language":"default","tag":"Referência da API","count":107},{"language":"default","tag":"SDKs","count":67},{"language":"default","tag":"Conexões","count":53},{"language":"default","tag":"Guias","count":47},{"language":"default","tag":"API SDKs","count":46},{"language":"default","tag":"Analytics","count":39},{"language":"default","tag":"Analytics API","count":39},{"language":"default","tag":"Serviços adicionais","count":38}]},"assistantConfig":{"enableStarterQuestions":false},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":".card a:not(.card){border-bottom:1.5px solid #C3F4EF;;font-weight:600}.card a:not(.card):hover{border-bottom:2px solid #C3F4EF;;}html:not(.dark) .card a:not(.card){color:var(--tw-prose-links);min-width:1em!important}:root{--malgreen-200: #BAE7C9;--malgreen-300: #38BFAD;--malgreen-400: #2FAC9B;--malblack-100: #666666;--malblack-200: #4D4D4D;--malblack-300: #333333;--malblack-400: #1A1A1A;--malwhite-100: #FFFFFF;--malwhite-200: #F9F9F9;--malwhite-300: #F1F1F1;--malwhite-500: #CBCBCB;--malred-200: #FFA4B3;--malinfo-100: #E1EEF4;--malinfo-300: #3C8DDD;--malinfo-400: #1e61b6;--malsuccess-100: #e4f2e8;--malsuccess-200: #bae7c9;--malsuccess-300: #00ae42;--malsuccess-400: #009033;--malsuccess-500: #00601B;--malwarning-100: #FFF8E6;--malwarning-200: #F9DF8D;--malwarning-300: #FFA400;--malwarning-400: #F0941A;--malwarning-500: #D47129;--malerror-100: #ffd2dc;--post-bg: #3C8DDD;--get-bg: #009033;--patch-bg: #F0941B;--delete-bg: #D12E2d}html:not(.dark) .text-gray-900,html:not(.dark) .text-gray-800,html:not(.dark) .text-gray-700{color:var(--malblack-400)}.text-primary{color:var(--malgreen-400)}.prose :where(h1,h2,h3,h4,h5,h6):not(:where([class~=not-prose] *)){color:var(--malblack-400)}.prose :where(h1,h2,h3,h4,h5,h6):where([class=dark] *):not(:where([class~=not-prose] *)){color:var(--malwhite-200)}.prose :where(thead th):not(:where([class~=not-prose] *)){color:var(--malblack-100)}:is(.dark .prose :where(thead th):not(:where([class~=not-prose] *))){color:var(--malwhite-500)}:is(.dark .prose :is(h1,h2,h3,h4,h5,h6)){color:var(--malwhite-200)}html:not(.dark) .text-gray-600{color:var(--malblack-200)}html:not(.dark) .text-gray-500{color:var(--malblack-100)}.text-gray-200{color:var(--malwhite-200)}.text-gray-400{color:var(--malwhite-500)}.z-10{color:var(--malgreen-300)}.prose{color:var(--malblack-100)}:is(.dark .prose){color:var(--malwhite-500)}:is(.dark .dark\\:text-gray-200){color:var(--malwhite-200)}:is(.dark .dark\\:text-gray-400){color:var(--malwhite-500)}:is(.dark .dark\\:text-primary-light){--tw-text-opacity: 1;color:var(--malgreen-300)}:is(.dark #topbar-cta-button .dark\\:bg-primary-light\\/10){background-color:var(--malgreen-400)}#navbar .text-gray-600{color:var(--malblack-100)}#sidebar li .text-gray-600{color:var(--malblack-100)}#sidebar li .text-gray-700{color:var(--malblack-100)}#sidebar li .bg-primary\\/10{background-color:rgba(47, 172, 155, 0.1);color:var(--malgreen-400)}:is(.dark #sidebar li .text-gray-600){color:var(--malwhite-500)!important}:is(.dark #sidebar .dark\\:text-gray-200){color:var(--malwhite-300)}:is(.dark #sidebar li .text-gray-700){color:var(--malwhite-500)!important}:is(.dark #navbar .dark\\:text-gray-400){color:var(--malwhite-500)!important}:is(.dark #navbar .dark\\:text-primary-light){color:var(--malwhite-100)}:is(.dark #table-of-contents .text-primary){color:var(--malgreen-400)}.card .text-gray-600{color:var(--malblack-100)}:is(.dark .card .dark\\:text-gray-400){color:var(--malwhite-500)}:is(.dark .card h2){color:var(--malwhite-200)}.method-nav-pill{width:2.5rem;flex-shrink:0;display:inline-flex;align-items:center;justify-content:center}.method-nav-pill>span{display:inline-flex;align-items:center;justify-content:center;width:100%;box-sizing:border-box;text-align:center}.bg-\\[\\#3064E3\\]{background-color:var(--malinfo-400);color:var(--malwhite-100)}:is(.dark .bg-\\[\\#3064E3\\]){background-color:var(--malinfo-300)}.text-white{color:var(--malwhite-100)}:is(.dark .dark\\:bg-blue-400\\/20){color:var(--malinfo-300)}html:not(.dark) .bg-blue-400\\/20{background-color:var(--malinfo-100);color:var(--malinfo-400)}html:not(.dark) .bg-green-400\\/20{background-color:var(--malsuccess-100);color:var(--get-bg)}:is(.dark .dark\\:text-green-400){color:var(--malsuccess-300)}html:not(.dark) .bg-orange-400\\/20{background-color:var(--malwarning-100);color:var(--patch-bg)}:is(.dark .dark\\:text-orange-400){color:var(--malwarning-300)}html:not(.dark) .bg-red-400\\/20{background-color:var(--malerror-100);color:var(--delete-bg)}:is(.dark .dark\\:text-red-400){color:var(--malred-200)}:is(.dark .dark\\:bg-primary-light){background-color:var(--malgreen-400)}.stroke-gray-400{stroke:var(--malgreen-400)}:is(.dark svg.text-emerald-600){color:var(--malsuccess-200)}:is(.dark .dark\\:text-emerald-200){color:var(--malsuccess-200)}:is(.dark .dark\\:text-amber-200){color:var(--malwarning-200)}:is(.dark svg.text-amber-400){stroke:var(--malwarning-300)}.malga-icon-box .malga-icon[id=\"sodexo\"],.malga-icon-box .malga-icon[id=\"visa\"],.malga-icon-box .malga-icon[id=\"master\"],.malga-icon-box .malga-icon[id=\"amex\"],.malga-icon-box .malga-icon[id=\"dinners\"],.malga-icon-box .malga-icon[id=\"discover\"],.malga-icon-box .malga-icon[id=\"jcb\"],.malga-icon-box .malga-icon[id=\"vr\"],.malga-icon-box .malga-icon[id=\"elo\"]{width:55px!important;height:55px!important}.prose tbody tr:nth-child(odd){background-color:var(--malwhite-200)}:is(.dark .prose tbody tr:nth-child(odd)){background-color:var(--malblack-400)}td:is(:first-child){padding-left:8px}td:is(:last-child){padding-right:8px}td{vertical-align:middle!important}td[align=\"center\"]{text-align:center;vertical-align:middle!important}td[align=\"left\"]{text-align:left;vertical-align:middle!important}td[align=\"right\"]{text-align:right;vertical-align:middle!important}td>span{height:36px!important}th{white-space:nowrap}:is(.dark .prose :where(.malga-check-badge):not(:where([class~=not-prose] *))){background-color:var(--malblack-300)}.malga-check-badge{height:fit-content;white-space:nowrap}.check-icon>p{margin:0!important}.table-legend>p{font-size:12px;margin:0}.mx-1{margin:0 1em}.prose :where(img.table-flow-view){margin-top:0em;margin-bottom:0em;margin-inline:auto}.providers-matrix{--providers-matrix-sticky-bg: rgb(var(--background-light, 255 255 255));--providers-matrix-fade: rgb(var(--background-light, 255 255 255));--providers-matrix-sticky-shadow: rgb(0 0 0 / 0.06);margin-bottom:1.5rem;max-width:100%;min-width:0;box-sizing:border-box}:is(.dark .providers-matrix){--providers-matrix-sticky-bg: rgb(var(--background-dark, 10 13 14));--providers-matrix-fade: rgb(var(--background-dark, 10 13 14));--providers-matrix-sticky-shadow: rgb(0 0 0 / 0.45)}.providers-matrix-top-scroll{position:sticky;top:7.5rem;z-index:5;overflow-x:auto;overflow-y:hidden;width:100%;max-width:100%;min-width:0;box-sizing:border-box;margin-top:0.25rem;margin-bottom:1rem;min-height:12px;background:transparent;border:0;border-radius:0;scrollbar-width:thin;scrollbar-color:var(--malblack-100) transparent}.providers-matrix-top-scroll[data-overflow-x=\"false\"]{display:none}:is(.dark .providers-matrix-top-scroll){scrollbar-color:var(--malblack-100) transparent}.providers-matrix-top-scroll-inner{height:1px;pointer-events:none}.providers-matrix-viewport{position:relative;width:100%;max-width:100%;min-width:0}.providers-matrix-viewport::after{content:\"\";position:absolute;top:0;bottom:8px;right:0;width:1.25rem;z-index:4;pointer-events:none;opacity:0;transition:opacity 120ms ease;background:linear-gradient(to left, var(--providers-matrix-fade), transparent)}.providers-matrix-viewport[data-overflow-right=\"true\"]::after{opacity:1}.providers-matrix-scroll{overflow-x:auto;overflow-y:hidden;width:100%;max-width:100%;min-width:0;box-sizing:border-box;border:0;border-radius:0;background:transparent;scrollbar-width:thin;scrollbar-color:var(--malblack-100) transparent}.providers-matrix-top-scroll::-webkit-scrollbar,.providers-matrix-scroll::-webkit-scrollbar{height:8px}.providers-matrix-top-scroll::-webkit-scrollbar-track,.providers-matrix-scroll::-webkit-scrollbar-track{background:transparent}.providers-matrix-top-scroll::-webkit-scrollbar-thumb,.providers-matrix-scroll::-webkit-scrollbar-thumb{background:var(--malblack-100);border-radius:999px}.providers-matrix-top-scroll::-webkit-scrollbar-thumb:hover,.providers-matrix-scroll::-webkit-scrollbar-thumb:hover{background:var(--malgreen-300)}.providers-matrix-scroll table{margin-top:0!important;margin-bottom:0!important;width:max-content!important;min-width:0!important;max-width:none!important;background:transparent;display:table!important;overflow:visible!important}.providers-matrix-scroll th,.providers-matrix-scroll td{min-width:0!important}.providers-matrix-scroll[data-overflow-x=\"true\"]{overflow-x:scroll}.providers-matrix-scroll th:first-child,.providers-matrix-scroll td:first-child{position:sticky;left:0;z-index:2;min-width:11rem!important;background-color:var(--providers-matrix-sticky-bg);box-shadow:4px 0 8px -6px var(--providers-matrix-sticky-shadow)}.providers-matrix-scroll tbody tr:nth-child(odd) td:first-child{background-color:var(--malwhite-200)}:is(.dark .providers-matrix-scroll tbody tr:nth-child(odd) td:first-child){background-color:var(--malblack-400)}.providers-matrix-scroll thead th:first-child{z-index:3}"}],"page":{"pagePath":"api-reference/subscriptions/atualizar-assinatura","slug":"/api-reference/subscriptions/atualizar-assinatura","pageMetadata":{"openapi":"put /v1/subscriptions/{id}","title":"Atualizar assinatura","description":"Atualiza só os campos enviados. Os demais ficam como estão.\n\n- **`recurrence` aceita só `cycles` e `startAt`.** O intervalo não pode ser alterado: `recurrence.interval` é ignorado sem erro e a resposta mantém o intervalo antigo. Para trocar o intervalo, cancele a assinatura e crie outra.\n- **`referenceKey` não pode ser alterado.** O campo é ignorado sem erro e a resposta mantém o valor original.\n- **`trial` não pode ser alterado.** Enviar `trial` devolve `400`.\n- **`splitRules` aceita só `percentage`.** Regra com `amount` devolve `400`.\n- **`startAt` só muda antes do primeiro ciclo.** Depois dele, devolve `400`. Se a nova data for hoje ou ontem (UTC), o primeiro ciclo é cobrado na mesma chamada.\n- **Cancelamento agendado.** Com `cancelAtPeriodEnd: true`, a assinatura precisa estar `active`, `paused`, `unpaid`, `trialing` ou `created`; em `canceled` ou `expired`, devolve `409`.\n\n**Atenção:** `cycles` precisa ser maior que a quantidade de ciclos já executados, e `items` e `splitRules` não podem ser listas vazias. Valide os valores antes de enviar.\n","href":"/api-reference/subscriptions/atualizar-assinatura"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Atualiza só os campos enviados. Os demais ficam como estão.\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsxs(_components.strong, {\n children: [_jsx(_components.code, {\n children: \"recurrence\"\n }), \" aceita só \", _jsx(_components.code, {\n children: \"cycles\"\n }), \" e \", _jsx(_components.code, {\n children: \"startAt\"\n }), \".\"]\n }), \" O intervalo não pode ser alterado: \", _jsx(_components.code, {\n children: \"recurrence.interval\"\n }), \" é ignorado sem erro e a resposta mantém o intervalo antigo. Para trocar o intervalo, cancele a assinatura e crie outra.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsxs(_components.strong, {\n children: [_jsx(_components.code, {\n children: \"referenceKey\"\n }), \" não pode ser alterado.\"]\n }), \" O campo é ignorado sem erro e a resposta mantém o valor original.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsxs(_components.strong, {\n children: [_jsx(_components.code, {\n children: \"trial\"\n }), \" não pode ser alterado.\"]\n }), \" Enviar \", _jsx(_components.code, {\n children: \"trial\"\n }), \" devolve \", _jsx(_components.code, {\n children: \"400\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsxs(_components.strong, {\n children: [_jsx(_components.code, {\n children: \"splitRules\"\n }), \" aceita só \", _jsx(_components.code, {\n children: \"percentage\"\n }), \".\"]\n }), \" Regra com \", _jsx(_components.code, {\n children: \"amount\"\n }), \" devolve \", _jsx(_components.code, {\n children: \"400\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsxs(_components.strong, {\n children: [_jsx(_components.code, {\n children: \"startAt\"\n }), \" só muda antes do primeiro ciclo.\"]\n }), \" Depois dele, devolve \", _jsx(_components.code, {\n children: \"400\"\n }), \". Se a nova data for hoje ou ontem (UTC), o primeiro ciclo é cobrado na mesma chamada.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.strong, {\n children: \"Cancelamento agendado.\"\n }), \" Com \", _jsx(_components.code, {\n children: \"cancelAtPeriodEnd: true\"\n }), \", a assinatura precisa estar \", _jsx(_components.code, {\n children: \"active\"\n }), \", \", _jsx(_components.code, {\n children: \"paused\"\n }), \", \", _jsx(_components.code, {\n children: \"unpaid\"\n }), \", \", _jsx(_components.code, {\n children: \"trialing\"\n }), \" ou \", _jsx(_components.code, {\n children: \"created\"\n }), \"; em \", _jsx(_components.code, {\n children: \"canceled\"\n }), \" ou \", _jsx(_components.code, {\n children: \"expired\"\n }), \", devolve \", _jsx(_components.code, {\n children: \"409\"\n }), \".\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Atenção:\"\n }), \" \", _jsx(_components.code, {\n children: \"cycles\"\n }), \" precisa ser maior que a quantidade de ciclos já executados, e \", _jsx(_components.code, {\n children: \"items\"\n }), \" e \", _jsx(_components.code, {\n children: \"splitRules\"\n }), \" não podem ser listas vazias. Valide os valores antes de enviar.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"put /v1/subscriptions/{id}","title":"Atualizar assinatura","description":"Atualiza só os campos enviados. Os demais ficam como estão.\n\n- **`recurrence` aceita só `cycles` e `startAt`.** O intervalo não pode ser alterado: `recurrence.interval` é ignorado sem erro e a resposta mantém o intervalo antigo. Para trocar o intervalo, cancele a assinatura e crie outra.\n- **`referenceKey` não pode ser alterado.** O campo é ignorado sem erro e a resposta mantém o valor original.\n- **`trial` não pode ser alterado.** Enviar `trial` devolve `400`.\n- **`splitRules` aceita só `percentage`.** Regra com `amount` devolve `400`.\n- **`startAt` só muda antes do primeiro ciclo.** Depois dele, devolve `400`. Se a nova data for hoje ou ontem (UTC), o primeiro ciclo é cobrado na mesma chamada.\n- **Cancelamento agendado.** Com `cancelAtPeriodEnd: true`, a assinatura precisa estar `active`, `paused`, `unpaid`, `trialing` ou `created`; em `canceled` ou `expired`, devolve `409`.\n\n**Atenção:** `cycles` precisa ser maior que a quantidade de ciclos já executados, e `items` e `splitRules` não podem ser listas vazias. Valide os valores antes de enviar.\n","href":"/api-reference/subscriptions/atualizar-assinatura"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/malga/e062f6bdf470a4a7/scripts/generate-providers/generate-providers-docs.js","/_mintlify/custom/malga/1d6eb6c3defb1781/scripts/generate-providers/generate-providers-table.js","/_mintlify/custom/malga/511878d47a4717b9/scripts/generate-providers/index.js","/_mintlify/custom/malga/07cc1cd1c4f6158b/scripts/generate-providers/update-mint-file.js","/_mintlify/custom/malga/4789795b14062ad2/scripts/generate-providers/utils.js","/_mintlify/custom/malga/f193bde54c02ce17/script.js"],"openApiReferenceData":{"operation":{"summary":"Atualizar assinatura","description":"Atualiza só os campos enviados. Os demais ficam como estão.\n\n- **`recurrence` aceita só `cycles` e `startAt`.** O intervalo não pode ser alterado: `recurrence.interval` é ignorado sem erro e a resposta mantém o intervalo antigo. Para trocar o intervalo, cancele a assinatura e crie outra.\n- **`referenceKey` não pode ser alterado.** O campo é ignorado sem erro e a resposta mantém o valor original.\n- **`trial` não pode ser alterado.** Enviar `trial` devolve `400`.\n- **`splitRules` aceita só `percentage`.** Regra com `amount` devolve `400`.\n- **`startAt` só muda antes do primeiro ciclo.** Depois dele, devolve `400`. Se a nova data for hoje ou ontem (UTC), o primeiro ciclo é cobrado na mesma chamada.\n- **Cancelamento agendado.** Com `cancelAtPeriodEnd: true`, a assinatura precisa estar `active`, `paused`, `unpaid`, `trialing` ou `created`; em `canceled` ou `expired`, devolve `409`.\n\n**Atenção:** `cycles` precisa ser maior que a quantidade de ciclos já executados, e `items` e `splitRules` não podem ser listas vazias. Valide os valores antes de enviar.\n","operationId":"updateSubscription","parameters":["8bf800d8-f586-46ea-bcec-5ed0c70c0fac"],"requestBody":"293edc73-7020-46ee-a370-5c6eca37fc26","responses":{"200":"bd898da8-ff85-4a5b-872c-d6bdf8a612e7","400":"2e25b7f3-2c17-4117-a7c9-04f44d89928c","401":"fc8a2944-80e1-4b0c-86d1-2844f95cd416","404":"df40f083-9d32-441b-b2d8-7f5f273466de","409":"ce3079bc-e580-40f4-a77d-94818bf616ad"},"tags":["Subscriptions"],"method":"put","type":"path","servers":["0676cd94-979e-48df-aa0c-bd30e3ec97a0"],"security":["7dd845ab-8a55-4088-a4c9-7ec907c7e310"],"path":"/v1/subscriptions/{id}","baseUrlOptions":["https://api.malga.io"],"title":"Atualizar assinatura","codeSamples":[],"requestExampleLanguages":["bash","javascript","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.name":"\u003cstring>","body.merchantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","body.\\items.items.0.name":"\u003cstring>","body.\\items.items.0.amount":2,"body.\\items.items.0.quantity":2,"body.\\items.items.0.description":"\u003cstring>","body.\\items.items.0.sku":"\u003cstring>","body.\\items.items.0.categoryId":"\u003cstring>","body.\\items.items.0.locality":"\u003cstring>","body.\\items.items.0.date":"2023-12-25","body.\\items.items.0.type":123,"body.\\items.items.0.genre":"\u003cstring>","body.\\items.items.0.tickets.quantityTicketSale":123,"body.\\items.items.0.tickets.quantityEventHouse":123,"body.\\items.items.0.tickets.convenienceFeeValue":123,"body.\\items.items.0.tickets.quantityFull":123,"body.\\items.items.0.tickets.quantityHalf":123,"body.\\items.items.0.tickets.batch":123,"body.\\items.items.0.location.street":"\u003cstring>","body.\\items.items.0.location.number":"\u003cstring>","body.\\items.items.0.location.complement":"\u003cstring>","body.\\items.items.0.location.zipCode":"\u003cstring>","body.\\items.items.0.location.city":"\u003cstring>","body.\\items.items.0.location.state":"\u003cstring>","body.\\items.items.0.location.country":"\u003cstring>","body.\\items.items.0.location.district":"\u003cstring>","body.\\items.items.0.location.reference":"\u003cstring>","body.recurrence.cycles":2,"body.recurrence.startAt":"2023-12-25","body.splitRules.items.0.sellerId":"d98106e8-568a-44c3-94d0-0e0bbd8b7e08","body.splitRules.items.0.percentage":70,"body.splitRules.items.0.processingFee":false,"body.splitRules.items.0.chargeEntireFee":false,"body.splitRules.items.0.chargeRemainderFee":false,"body.splitRules.items.0.liable":true,"body.splitRules.items.0.fares.mdr":2.5,"body.splitRules.items.0.fares.fee":0.3,"body.cancelAtPeriodEnd":true,"body.scheduledCancellationAt":"2025-12-31","body.scheduledCancellationReason":"Cliente solicitou cancelamento"}]},"dependencies":{"parameters":{"8bf800d8-f586-46ea-bcec-5ed0c70c0fac":{"name":"id","required":true,"in":"path","description":"Id da assinatura que deseja atualizar","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Id da assinatura que deseja atualizar","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Envie só os campos que quer alterar. `referenceKey`, `recurrence.interval` e `trial` não podem ser alterados","properties":{"name":{"type":"string","description":"Nome da assinatura","minLength":1,"maxLength":100,"uniqueKey":"name","typeLabel":"string"},"merchantId":{"type":"string","format":"uuid","description":"Identificador do merchant","uniqueKey":"merchantId","typeLabel":"string\u003cuuid>"},"items":{"type":"array","minItems":1,"description":"Nova lista de itens, que substitui a atual. Não pode ser vazia","items":{"type":"object","properties":{"name":{"type":"string","description":"Nome do item","isRequired":true,"uniqueKey":"\\items.items.[INDEX].name","typeLabel":"string"},"amount":{"type":"integer","description":"Valor em centavos","minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].amount","typeLabel":"integer"},"quantity":{"type":"integer","description":"Quantidade de itens","minimum":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"integer"},"description":{"type":"string","description":"Descrição do item","uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string"},"sku":{"type":"string","uniqueKey":"\\items.items.[INDEX].sku","typeLabel":"string"},"risk":{"type":"string","enum":["Low","High"],"uniqueKey":"\\items.items.[INDEX].risk","typeLabel":"enum\u003cstring>"},"categoryId":{"type":"string","uniqueKey":"\\items.items.[INDEX].categoryId","typeLabel":"string"},"locality":{"type":"string","uniqueKey":"\\items.items.[INDEX].locality","typeLabel":"string"},"date":{"type":"string","format":"date","uniqueKey":"\\items.items.[INDEX].date","typeLabel":"string\u003cdate>"},"type":{"type":"integer","uniqueKey":"\\items.items.[INDEX].type","typeLabel":"integer"},"genre":{"type":"string","uniqueKey":"\\items.items.[INDEX].genre","typeLabel":"string"},"tickets":{"type":"object","properties":{"quantityTicketSale":{"type":"integer","uniqueKey":"\\items.items.[INDEX].tickets.quantityTicketSale","typeLabel":"integer"},"quantityEventHouse":{"type":"integer","uniqueKey":"\\items.items.[INDEX].tickets.quantityEventHouse","typeLabel":"integer"},"convenienceFeeValue":{"type":"number","format":"float","uniqueKey":"\\items.items.[INDEX].tickets.convenienceFeeValue","typeLabel":"number\u003cfloat>"},"quantityFull":{"type":"integer","uniqueKey":"\\items.items.[INDEX].tickets.quantityFull","typeLabel":"integer"},"quantityHalf":{"type":"integer","uniqueKey":"\\items.items.[INDEX].tickets.quantityHalf","typeLabel":"integer"},"batch":{"type":"integer","uniqueKey":"\\items.items.[INDEX].tickets.batch","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX].tickets","typeLabel":"object"},"location":{"type":"object","properties":{"street":{"type":"string","uniqueKey":"\\items.items.[INDEX].location.street","typeLabel":"string"},"number":{"type":"string","uniqueKey":"\\items.items.[INDEX].location.number","typeLabel":"string"},"complement":{"type":"string","uniqueKey":"\\items.items.[INDEX].location.complement","typeLabel":"string"},"zipCode":{"type":"string","uniqueKey":"\\items.items.[INDEX].location.zipCode","typeLabel":"string"},"city":{"type":"string","uniqueKey":"\\items.items.[INDEX].location.city","typeLabel":"string"},"state":{"type":"string","uniqueKey":"\\items.items.[INDEX].location.state","typeLabel":"string"},"country":{"type":"string","uniqueKey":"\\items.items.[INDEX].location.country","typeLabel":"string"},"district":{"type":"string","uniqueKey":"\\items.items.[INDEX].location.district","typeLabel":"string"},"reference":{"type":"string","uniqueKey":"\\items.items.[INDEX].location.reference","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].location","typeLabel":"object"}},"required":["name","amount","quantity"],"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items","typeLabel":"object[]"},"recurrence":{"type":"object","description":"Aceita só `cycles` e `startAt`. O intervalo não pode ser alterado; `interval` enviado aqui é ignorado sem erro","properties":{"cycles":{"type":"integer","minimum":1,"description":"Nova quantidade total de ciclos. Precisa ser maior que a quantidade de ciclos já executados","uniqueKey":"recurrence.cycles","typeLabel":"integer"},"startAt":{"type":"string","format":"date","description":"Nova data do primeiro ciclo (YYYY-MM-DD, UTC). Só pode ser alterada antes do primeiro ciclo e aceita a partir de ontem. Hoje ou ontem cobram o primeiro ciclo na mesma chamada","uniqueKey":"recurrence.startAt","typeLabel":"string\u003cdate>"}},"uniqueKey":"recurrence","typeLabel":"object"},"splitRules":{"type":"array","minItems":1,"items":{"type":"object","description":"Regra de split de uma assinatura. Assinaturas aceitam split só por percentual; uma regra com `amount` devolve `400` com `subscription_split_requires_percentage` em `details`","properties":{"sellerId":{"type":"string","format":"uuid","description":"Identificador do recebedor já cadastrado na API de [sellers](/api-reference/sellers/criacao-de-um-novo-recebedor).","example":"d98106e8-568a-44c3-94d0-0e0bbd8b7e08","isRequired":true,"uniqueKey":"splitRules.items.[INDEX].sellerId","typeLabel":"string\u003cuuid>"},"percentage":{"type":"integer","minimum":1,"maximum":100,"description":"Percentual do valor de cada ciclo que será enviado ao recebedor.","example":70,"isRequired":true,"uniqueKey":"splitRules.items.[INDEX].percentage","typeLabel":"integer"},"processingFee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação.","example":false,"uniqueKey":"splitRules.items.[INDEX].processingFee","typeLabel":"boolean"},"chargeEntireFee":{"type":"boolean","description":"Indica se o recebedor será cobrado pela taxa inteira da transação. Não pode ser verdadeiro junto com `chargeRemainderFee`.","example":false,"uniqueKey":"splitRules.items.[INDEX].chargeEntireFee","typeLabel":"boolean"},"chargeRemainderFee":{"type":"boolean","description":"Indica se o recebedor será cobrado pela taxa restante da transação.","example":false,"uniqueKey":"splitRules.items.[INDEX].chargeRemainderFee","typeLabel":"boolean"},"liable":{"type":"boolean","description":"Indica se o recebedor atrelado assumirá os riscos de chargeback da transação.","example":true,"uniqueKey":"splitRules.items.[INDEX].liable","typeLabel":"boolean"},"fares":{"type":"object","description":"Informações sobre as taxas que serão cobradas do recebedor.","properties":{"mdr":{"type":"number","minimum":0,"description":"Percentual de MDR que será aplicado ao recebedor.","example":2.5,"uniqueKey":"splitRules.items.[INDEX].fares.mdr","typeLabel":"number"},"fee":{"type":"number","minimum":0,"description":"Taxa fixa que será aplicada ao recebedor.","example":0.3,"uniqueKey":"splitRules.items.[INDEX].fares.fee","typeLabel":"number"}},"uniqueKey":"splitRules.items.[INDEX].fares","typeLabel":"object"}},"required":["sellerId","percentage"],"uniqueKey":"splitRules.items.[INDEX]","typeLabel":"object"},"description":"Nova lista de regras de split, que substitui a atual. Aceita só `percentage`. Não pode ser vazia","uniqueKey":"splitRules","typeLabel":"object[]"},"paymentMethod":{"type":"object","required":["type","card"],"properties":{"type":{"type":"string","enum":["credit"],"description":"Tipo de método de pagamento","isRequired":true,"uniqueKey":"paymentMethod.type","typeLabel":"enum\u003cstring>"},"card":{"type":"object","required":["cardId"],"properties":{"cardId":{"type":"string","format":"uuid","description":"Identificador do cartão","isRequired":true,"uniqueKey":"paymentMethod.card.cardId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"paymentMethod.card","typeLabel":"object"},"installments":{"type":"integer","description":"Número de parcelas","uniqueKey":"paymentMethod.installments","typeLabel":"integer"}},"uniqueKey":"paymentMethod","typeLabel":"object"},"cancelAtPeriodEnd":{"type":"boolean","description":"`true` agenda o cancelamento; `false` remove o agendamento. Ao agendar com `recurrence.cycles` definido, `cycles` passa a ser o ciclo atual mais um; ao remover, volta ao valor anterior. Agendar em assinatura `canceled` ou `expired` devolve `409`","example":true,"uniqueKey":"cancelAtPeriodEnd","typeLabel":"boolean"},"scheduledCancellationAt":{"type":"string","format":"date","description":"Data do cancelamento agendado (YYYY-MM-DD). Exige `cancelAtPeriodEnd` igual a `true`, enviado agora ou já salvo, e não pode ser anterior a ontem (UTC). Sem esta data, o cancelamento acontece em `trial.endDate` ou, sem trial, em `recurrence.nextDueDate`","example":"2025-12-31","uniqueKey":"scheduledCancellationAt","typeLabel":"string\u003cdate>"},"scheduledCancellationReason":{"type":"string","description":"Motivo do cancelamento agendado (opcional)","example":"Cliente solicitou cancelamento","uniqueKey":"scheduledCancellationReason","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","merchantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","items":[{"name":"\u003cstring>","amount":2,"quantity":2,"description":"\u003cstring>","sku":"\u003cstring>","categoryId":"\u003cstring>","locality":"\u003cstring>","date":"2023-12-25","type":123,"genre":"\u003cstring>","tickets":{"quantityTicketSale":123,"quantityEventHouse":123,"convenienceFeeValue":123,"quantityFull":123,"quantityHalf":123,"batch":123},"location":{"street":"\u003cstring>","number":"\u003cstring>","complement":"\u003cstring>","zipCode":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","country":"\u003cstring>","district":"\u003cstring>","reference":"\u003cstring>"}}],"recurrence":{"cycles":2,"startAt":"2023-12-25"},"splitRules":[{"sellerId":"d98106e8-568a-44c3-94d0-0e0bbd8b7e08","percentage":70,"processingFee":false,"chargeEntireFee":false,"chargeRemainderFee":false,"liable":true,"fares":{"mdr":2.5,"fee":0.3}}],"cancelAtPeriodEnd":true,"scheduledCancellationAt":"2025-12-31","scheduledCancellationReason":"Cliente solicitou cancelamento"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"bd898da8-ff85-4a5b-872c-d6bdf8a612e7":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identificador da assinatura","example":"abecf6d6-153e-4fc9-8222-8be5441de581","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Nome da assinatura","example":"Assinatura Premium com Eventos","uniqueKey":"name","typeLabel":"string"},"clientId":{"type":"string","format":"uuid","description":"Identificador do client","example":"567265cb-fa7f-419f-9c1c-8e878dd2faf7","uniqueKey":"clientId","typeLabel":"string\u003cuuid>"},"merchantId":{"type":"string","format":"uuid","description":"Identificador do merchant","example":"90d64a51-d442-426c-bbf9-b66e000e5576","uniqueKey":"merchantId","typeLabel":"string\u003cuuid>"},"customerId":{"type":"string","format":"uuid","description":"Identificador do cliente","example":"b99e159e-27d5-4927-b46e-ae7348f20131","uniqueKey":"customerId","typeLabel":"string\u003cuuid>"},"referenceKey":{"type":"string","description":"Chave de referência da assinatura","example":"SUB-PREMIUM-001","uniqueKey":"referenceKey","typeLabel":"string"},"currency":{"type":"string","description":"Moeda da assinatura","example":"BRL","uniqueKey":"currency","typeLabel":"string"},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Nome do item","example":"Ingresso VIP Mensal","isRequired":true,"uniqueKey":"\\items.items.[INDEX].name","typeLabel":"string"},"amount":{"type":"integer","minimum":1,"description":"Valor do item em centavos","example":29900,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].amount","typeLabel":"integer"},"quantity":{"type":"integer","minimum":1,"description":"Quantidade do item","example":1,"isRequired":true,"uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"integer"},"description":{"type":"string","description":"Descrição do item","example":"Acesso VIP premium a eventos mensais","uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string"},"sku":{"type":"string","description":"Código de identificação do item","example":"VIP-EVENT-001","uniqueKey":"\\items.items.[INDEX].sku","typeLabel":"string"},"risk":{"type":"string","enum":["Low","High"],"description":"Nível de risco da transação","example":"Low","uniqueKey":"\\items.items.[INDEX].risk","typeLabel":"enum\u003cstring>"},"categoryId":{"type":"string","description":"Categoria do item","example":"entertainment","uniqueKey":"\\items.items.[INDEX].categoryId","typeLabel":"string"},"locality":{"type":"string","description":"Localidade do evento","example":"São Paulo","uniqueKey":"\\items.items.[INDEX].locality","typeLabel":"string"},"date":{"type":"string","format":"date","description":"Data do evento","example":"2025-12-01","uniqueKey":"\\items.items.[INDEX].date","typeLabel":"string\u003cdate>"},"type":{"type":"integer","description":"Tipo de item","example":1,"uniqueKey":"\\items.items.[INDEX].type","typeLabel":"integer"},"genre":{"type":"string","description":"Gênero do evento","example":"Shows e Eventos","uniqueKey":"\\items.items.[INDEX].genre","typeLabel":"string"},"tickets":{"type":"object","properties":{"quantityTicketSale":{"type":"integer","description":"Quantidade de ingressos à venda","example":1,"uniqueKey":"\\items.items.[INDEX].tickets.quantityTicketSale","typeLabel":"integer"},"quantityEventHouse":{"oneOf":[{"type":"integer","description":"Quantidade de ingressos da casa de eventos","example":0,"uniqueKey":"\\items.items.[INDEX].tickets.quantityEventHouse.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Quantidade de ingressos da casa de eventos","example":0,"uniqueKey":"\\items.items.[INDEX].tickets.quantityEventHouse.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].tickets.quantityEventHouse","typeLabel":"integer | null"},"convenienceFeeValue":{"type":"number","format":"float","description":"Valor da taxa de conveniência","example":15.5,"uniqueKey":"\\items.items.[INDEX].tickets.convenienceFeeValue","typeLabel":"number\u003cfloat>"},"quantityFull":{"type":"integer","description":"Quantidade de ingressos inteiros","example":1,"uniqueKey":"\\items.items.[INDEX].tickets.quantityFull","typeLabel":"integer"},"quantityHalf":{"type":"integer","description":"Quantidade de ingressos meia-entrada","example":0,"uniqueKey":"\\items.items.[INDEX].tickets.quantityHalf","typeLabel":"integer"},"batch":{"type":"integer","description":"Lote do ingresso","example":1,"uniqueKey":"\\items.items.[INDEX].tickets.batch","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX].tickets","typeLabel":"object"},"location":{"type":"object","properties":{"street":{"type":"string","description":"Nome da rua","example":"Av. Paulista","uniqueKey":"\\items.items.[INDEX].location.street","typeLabel":"string"},"number":{"type":"string","description":"Número do endereço","example":"1000","uniqueKey":"\\items.items.[INDEX].location.number","typeLabel":"string"},"complement":{"type":"string","description":"Complemento do endereço","example":"Centro de Convenções","uniqueKey":"\\items.items.[INDEX].location.complement","typeLabel":"string"},"zipCode":{"type":"string","description":"CEP","example":"01310-100","uniqueKey":"\\items.items.[INDEX].location.zipCode","typeLabel":"string"},"city":{"type":"string","description":"Cidade","example":"São Paulo","uniqueKey":"\\items.items.[INDEX].location.city","typeLabel":"string"},"state":{"type":"string","description":"Estado","example":"SP","uniqueKey":"\\items.items.[INDEX].location.state","typeLabel":"string"},"country":{"type":"string","description":"País","example":"Brasil","uniqueKey":"\\items.items.[INDEX].location.country","typeLabel":"string"},"district":{"type":"string","description":"Bairro","example":"Bela Vista","uniqueKey":"\\items.items.[INDEX].location.district","typeLabel":"string"},"reference":{"type":"string","description":"Ponto de referência","example":"Próximo ao MASP","uniqueKey":"\\items.items.[INDEX].location.reference","typeLabel":"string"}},"uniqueKey":"\\items.items.[INDEX].location","typeLabel":"object"}},"required":["amount","name","quantity"],"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items","typeLabel":"object[]"},"recurrence":{"type":"object","properties":{"interval":{"type":"string","enum":["weekly","monthly","quarterly","yearly","biennial","triennial"],"example":"monthly","uniqueKey":"recurrence.interval","typeLabel":"enum\u003cstring>"},"cycles":{"type":"integer","description":"Quantidade total de ciclos. Não vem quando a assinatura não tem data de fim","example":12,"uniqueKey":"recurrence.cycles","typeLabel":"integer"},"startAt":{"type":"string","format":"date","description":"Data de início da assinatura (UTC)","example":"2025-08-10","uniqueKey":"recurrence.startAt","typeLabel":"string\u003cdate>"},"endAt":{"type":"string","format":"date","description":"Data de fim da assinatura. Só vem quando `cycles` está definido","example":"2026-08-10","uniqueKey":"recurrence.endAt","typeLabel":"string\u003cdate>"},"nextDueDate":{"type":"string","format":"date","description":"Próxima data de vencimento da assinatura","example":"2025-07-30","uniqueKey":"recurrence.nextDueDate","typeLabel":"string\u003cdate>"}},"uniqueKey":"recurrence","typeLabel":"object"},"paymentMethod":{"type":"object","required":["type","card"],"properties":{"type":{"type":"string","enum":["credit"],"description":"Tipo de método de pagamento","example":"credit","isRequired":true,"uniqueKey":"paymentMethod.type","typeLabel":"enum\u003cstring>"},"card":{"type":"object","required":["cardId"],"properties":{"cardId":{"type":"string","format":"uuid","description":"Identificador do cartão","example":"bfb60d16-108c-440b-bdb8-bbe67140f936","isRequired":true,"uniqueKey":"paymentMethod.card.cardId","typeLabel":"string\u003cuuid>"}},"isRequired":true,"uniqueKey":"paymentMethod.card","typeLabel":"object"},"installments":{"type":"integer","description":"Número de parcelas","example":1,"uniqueKey":"paymentMethod.installments","typeLabel":"integer"}},"uniqueKey":"paymentMethod","typeLabel":"object"},"trial":{"type":"object","properties":{"endDate":{"type":"string","format":"date","description":"Último dia do trial (YYYY-MM-DD)","example":"2025-08-15","uniqueKey":"trial.endDate","typeLabel":"string\u003cdate>"}},"description":"Período de trial. Só vem quando a assinatura foi criada com trial","uniqueKey":"trial","typeLabel":"object"},"splitRules":{"type":"array","items":{"type":"object","description":"Regra de split de uma assinatura. Assinaturas aceitam split só por percentual; uma regra com `amount` devolve `400` com `subscription_split_requires_percentage` em `details`","properties":{"sellerId":{"type":"string","format":"uuid","description":"Identificador do recebedor já cadastrado na API de [sellers](/api-reference/sellers/criacao-de-um-novo-recebedor).","example":"d98106e8-568a-44c3-94d0-0e0bbd8b7e08","isRequired":true,"uniqueKey":"splitRules.items.[INDEX].sellerId","typeLabel":"string\u003cuuid>"},"percentage":{"type":"integer","minimum":1,"maximum":100,"description":"Percentual do valor de cada ciclo que será enviado ao recebedor.","example":70,"isRequired":true,"uniqueKey":"splitRules.items.[INDEX].percentage","typeLabel":"integer"},"processingFee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação.","example":false,"uniqueKey":"splitRules.items.[INDEX].processingFee","typeLabel":"boolean"},"chargeEntireFee":{"type":"boolean","description":"Indica se o recebedor será cobrado pela taxa inteira da transação. Não pode ser verdadeiro junto com `chargeRemainderFee`.","example":false,"uniqueKey":"splitRules.items.[INDEX].chargeEntireFee","typeLabel":"boolean"},"chargeRemainderFee":{"type":"boolean","description":"Indica se o recebedor será cobrado pela taxa restante da transação.","example":false,"uniqueKey":"splitRules.items.[INDEX].chargeRemainderFee","typeLabel":"boolean"},"liable":{"type":"boolean","description":"Indica se o recebedor atrelado assumirá os riscos de chargeback da transação.","example":true,"uniqueKey":"splitRules.items.[INDEX].liable","typeLabel":"boolean"},"fares":{"type":"object","description":"Informações sobre as taxas que serão cobradas do recebedor.","properties":{"mdr":{"type":"number","minimum":0,"description":"Percentual de MDR que será aplicado ao recebedor.","example":2.5,"uniqueKey":"splitRules.items.[INDEX].fares.mdr","typeLabel":"number"},"fee":{"type":"number","minimum":0,"description":"Taxa fixa que será aplicada ao recebedor.","example":0.3,"uniqueKey":"splitRules.items.[INDEX].fares.fee","typeLabel":"number"}},"uniqueKey":"splitRules.items.[INDEX].fares","typeLabel":"object"}},"required":["sellerId","percentage"],"uniqueKey":"splitRules.items.[INDEX]","typeLabel":"object"},"description":"Regras de divisão de valores entre recebedores. Só vem quando a assinatura tem split","uniqueKey":"splitRules","typeLabel":"object[]"},"status":{"type":"string","enum":["created","active","paused","canceled","unpaid","expired","trialing"],"description":"Status da assinatura","example":"created","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","description":"Valor de cada ciclo em centavos, a soma de `amount` vezes `quantity` dos itens","example":29900,"uniqueKey":"amount","typeLabel":"integer"},"liveMode":{"type":"boolean","description":"Indica se a assinatura está em modo de produção","example":true,"uniqueKey":"liveMode","typeLabel":"boolean"},"lastCycle":{"oneOf":[{"type":"object","description":"Último ciclo da assinatura. Sempre presente nas respostas individuais (GET, CREATE, UPDATE), pode ser null se não houver ciclos. Não traz `items`.","properties":{"id":{"type":"string","format":"uuid","description":"Identificador do ciclo","example":"ae765755-c909-4d97-813c-9c71add4b182","uniqueKey":"lastCycle.oneOf.0.id","typeLabel":"string\u003cuuid>"},"customerId":{"type":"string","format":"uuid","description":"Identificador do cliente","example":"b99e159e-27d5-4927-b46e-ae7348f20131","uniqueKey":"lastCycle.oneOf.0.customerId","typeLabel":"string\u003cuuid>"},"merchantId":{"type":"string","format":"uuid","description":"Identificador do merchant","example":"90d64a51-d442-426c-bbf9-b66e000e5576","uniqueKey":"lastCycle.oneOf.0.merchantId","typeLabel":"string\u003cuuid>"},"cycle":{"type":"integer","description":"Número do ciclo","example":1,"uniqueKey":"lastCycle.oneOf.0.cycle","typeLabel":"integer"},"attempts":{"type":"integer","description":"Quantidade de tentativas de cobrança já feitas no ciclo. Não vem antes da primeira tentativa","example":1,"uniqueKey":"lastCycle.oneOf.0.attempts","typeLabel":"integer"},"status":{"type":"string","enum":["scheduled","pending","authorized","failed","retrying","canceled"],"description":"Status do ciclo","example":"authorized","uniqueKey":"lastCycle.oneOf.0.status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","description":"Valor do ciclo em centavos","example":29900,"uniqueKey":"lastCycle.oneOf.0.amount","typeLabel":"integer"},"items":{"type":"array","description":"Itens cobrados no ciclo, no formato de `items` da assinatura. Campos opcionais sem valor vêm como `null`. Só vem na consulta do ciclo, não em `lastCycle`","items":{"type":"object","properties":{"name":{"type":"string","description":"Nome do item","example":"Ingresso VIP Mensal","isRequired":true,"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].name","typeLabel":"string"},"amount":{"type":"integer","minimum":1,"description":"Valor do item em centavos","example":29900,"isRequired":true,"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].amount","typeLabel":"integer"},"quantity":{"type":"integer","minimum":1,"description":"Quantidade do item","example":1,"isRequired":true,"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].quantity","typeLabel":"integer"},"description":{"type":"string","description":"Descrição do item","example":"Acesso VIP premium a eventos mensais","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].description","typeLabel":"string"},"sku":{"type":"string","description":"Código de identificação do item","example":"VIP-EVENT-001","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].sku","typeLabel":"string"},"risk":{"type":"string","enum":["Low","High"],"description":"Nível de risco da transação","example":"Low","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].risk","typeLabel":"enum\u003cstring>"},"categoryId":{"type":"string","description":"Categoria do item","example":"entertainment","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].categoryId","typeLabel":"string"},"locality":{"type":"string","description":"Localidade do evento","example":"São Paulo","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].locality","typeLabel":"string"},"date":{"type":"string","format":"date","description":"Data do evento","example":"2025-12-01","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].date","typeLabel":"string\u003cdate>"},"type":{"type":"integer","description":"Tipo de item","example":1,"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].type","typeLabel":"integer"},"genre":{"type":"string","description":"Gênero do evento","example":"Shows e Eventos","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].genre","typeLabel":"string"},"tickets":{"type":"object","properties":{"quantityTicketSale":{"type":"integer","description":"Quantidade de ingressos à venda","example":1,"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].tickets.quantityTicketSale","typeLabel":"integer"},"quantityEventHouse":{"oneOf":[{"type":"integer","description":"Quantidade de ingressos da casa de eventos","example":0,"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].tickets.quantityEventHouse.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Quantidade de ingressos da casa de eventos","example":0,"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].tickets.quantityEventHouse.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].tickets.quantityEventHouse","typeLabel":"integer | null"},"convenienceFeeValue":{"type":"number","format":"float","description":"Valor da taxa de conveniência","example":15.5,"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].tickets.convenienceFeeValue","typeLabel":"number\u003cfloat>"},"quantityFull":{"type":"integer","description":"Quantidade de ingressos inteiros","example":1,"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].tickets.quantityFull","typeLabel":"integer"},"quantityHalf":{"type":"integer","description":"Quantidade de ingressos meia-entrada","example":0,"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].tickets.quantityHalf","typeLabel":"integer"},"batch":{"type":"integer","description":"Lote do ingresso","example":1,"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].tickets.batch","typeLabel":"integer"}},"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].tickets","typeLabel":"object"},"location":{"type":"object","properties":{"street":{"type":"string","description":"Nome da rua","example":"Av. Paulista","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].location.street","typeLabel":"string"},"number":{"type":"string","description":"Número do endereço","example":"1000","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].location.number","typeLabel":"string"},"complement":{"type":"string","description":"Complemento do endereço","example":"Centro de Convenções","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].location.complement","typeLabel":"string"},"zipCode":{"type":"string","description":"CEP","example":"01310-100","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].location.zipCode","typeLabel":"string"},"city":{"type":"string","description":"Cidade","example":"São Paulo","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].location.city","typeLabel":"string"},"state":{"type":"string","description":"Estado","example":"SP","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].location.state","typeLabel":"string"},"country":{"type":"string","description":"País","example":"Brasil","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].location.country","typeLabel":"string"},"district":{"type":"string","description":"Bairro","example":"Bela Vista","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].location.district","typeLabel":"string"},"reference":{"type":"string","description":"Ponto de referência","example":"Próximo ao MASP","uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].location.reference","typeLabel":"string"}},"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX].location","typeLabel":"object"}},"required":["amount","name","quantity"],"uniqueKey":"lastCycle.oneOf.0.\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"lastCycle.oneOf.0.\\items","typeLabel":"object[]"},"scheduledAt":{"type":"string","format":"date","description":"Data prevista da cobrança (YYYY-MM-DD, sem hora)","example":"2025-07-30","uniqueKey":"lastCycle.oneOf.0.scheduledAt","typeLabel":"string\u003cdate>"},"executedAt":{"type":"string","format":"date","description":"Data da última tentativa de cobrança (YYYY-MM-DD, sem hora). Não vem antes da primeira tentativa","example":"2025-07-30","uniqueKey":"lastCycle.oneOf.0.executedAt","typeLabel":"string\u003cdate>"},"nextAttemptAt":{"type":"string","format":"date","description":"Data da próxima retentativa (YYYY-MM-DD, sem hora). Só vem quando há retentativa agendada","example":"2025-07-31","uniqueKey":"lastCycle.oneOf.0.nextAttemptAt","typeLabel":"string\u003cdate>"},"isEmulated":{"type":"boolean","description":"Indica se o ciclo foi gerado por emulação em testes no sandbox. Em produção é sempre `false`","example":false,"uniqueKey":"lastCycle.oneOf.0.isEmulated","typeLabel":"boolean"},"emulatedAt":{"type":"string","format":"date-time","description":"Data da emulação, quando houver","uniqueKey":"lastCycle.oneOf.0.emulatedAt","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação do ciclo","example":"2025-07-30T20:14:12.599715Z","uniqueKey":"lastCycle.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"paymentHistory":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identificador da tentativa","example":"f9661d7d-92fc-468a-8223-bc51f2ce8661","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","format":"date-time","description":"Data de criação da tentativa","example":"2025-07-30T20:14:12.608115Z","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"executedAt":{"type":"string","format":"date-time","description":"Data em que a cobrança foi processada. Não vem antes do processamento","example":"2025-07-30T20:14:13.104331Z","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].executedAt","typeLabel":"string\u003cdate-time>"},"chargeId":{"oneOf":[{"type":"string","format":"uuid","description":"Identificador da cobrança na API de charges. Vem `null` quando a cobrança não chegou a ser criada","example":"e17e09a4-5d0c-40c6-a8c0-be2adc765608","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].chargeId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Identificador da cobrança na API de charges. Vem `null` quando a cobrança não chegou a ser criada","example":"e17e09a4-5d0c-40c6-a8c0-be2adc765608","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].chargeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].chargeId","typeLabel":"string\u003cuuid> | null"},"attemptNumber":{"type":"integer","description":"Número da tentativa dentro do ciclo, a partir de 1","example":1,"uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].attemptNumber","typeLabel":"integer"},"status":{"type":"string","enum":["pending","authorized","failed"],"description":"Status da cobrança. `pending` quando criada, `authorized` quando bem-sucedida, `failed` quando falhou","example":"authorized","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"paymentMethod":{"type":"object","description":"Método de pagamento usado na tentativa","properties":{"type":{"type":"string","enum":["credit"],"example":"credit","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].paymentMethod.type","typeLabel":"enum\u003cstring>"},"card":{"type":"object","properties":{"cardId":{"type":"string","format":"uuid","example":"bfb60d16-108c-440b-bdb8-bbe67140f936","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].paymentMethod.card.cardId","typeLabel":"string\u003cuuid>"}},"uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].paymentMethod.card","typeLabel":"object"},"installments":{"type":"integer","example":1,"uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].paymentMethod.installments","typeLabel":"integer"}},"uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].paymentMethod","typeLabel":"object"},"error":{"oneOf":[{"type":"object","description":"Motivo da falha da tentativa. Vem `null` ou ausente quando a tentativa não falhou. Recusas do provedor trazem `providerError`; erros da API de charges trazem `type`, `code` e `details`","properties":{"message":{"type":"string","description":"Mensagem do erro, em inglês","example":"Card declined","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].error.oneOf.0.message","typeLabel":"string"},"providerError":{"type":"object","description":"Detalhes da recusa do provedor","properties":{"declinedCode":{"type":"string","description":"Código de recusa","example":"insufficient_funds","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].error.oneOf.0.providerError.declinedCode","typeLabel":"string"},"message":{"type":"string","description":"Mensagem do provedor","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].error.oneOf.0.providerError.message","typeLabel":"string"},"networkDeniedMessage":{"type":"string","description":"Mensagem da bandeira, quando houver","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].error.oneOf.0.providerError.networkDeniedMessage","typeLabel":"string"},"networkDeniedReason":{"type":"string","description":"Motivo da bandeira, quando houver","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].error.oneOf.0.providerError.networkDeniedReason","typeLabel":"string"},"retryable":{"type":"boolean","description":"Indica se a recusa permite retentativa. Com `false`, o ciclo falha sem retentar","uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].error.oneOf.0.providerError.retryable","typeLabel":"boolean"}},"uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].error.oneOf.0.providerError","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].error.oneOf.0","typeLabel":"object"},{"type":"null","description":"Motivo da falha da tentativa. Vem `null` ou ausente quando a tentativa não falhou. Recusas do provedor trazem `providerError`; erros da API de charges trazem `type`, `code` e `details`","properties":{"message":{"type":"string","description":"Mensagem do erro, em inglês","example":"Card declined"},"providerError":{"type":"object","description":"Detalhes da recusa do provedor","properties":{"declinedCode":{"type":"string","description":"Código de recusa","example":"insufficient_funds"},"message":{"type":"string","description":"Mensagem do provedor"},"networkDeniedMessage":{"type":"string","description":"Mensagem da bandeira, quando houver"},"networkDeniedReason":{"type":"string","description":"Motivo da bandeira, quando houver"},"retryable":{"type":"boolean","description":"Indica se a recusa permite retentativa. Com `false`, o ciclo falha sem retentar"}}}},"additionalProperties":true,"uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].error.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX].error","typeLabel":"object | null"}},"uniqueKey":"lastCycle.oneOf.0.paymentHistory.items.[INDEX]","typeLabel":"object"},"description":"Tentativas de cobrança do ciclo","uniqueKey":"lastCycle.oneOf.0.paymentHistory","typeLabel":"object[]"}},"uniqueKey":"lastCycle.oneOf.0","typeLabel":"object"},{"type":"null","description":"Último ciclo da assinatura. Sempre presente nas respostas individuais (GET, CREATE, UPDATE), pode ser null se não houver ciclos. Não traz `items`.","uniqueKey":"lastCycle.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastCycle","typeLabel":"object | null"},"createdAt":{"type":"string","format":"date-time","example":"2025-07-31T13:36:40.118822Z","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","example":"2025-07-31T13:36:40.118822Z","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"cancelAtPeriodEnd":{"type":"boolean","description":"Indica se a assinatura tem cancelamento agendado. Enquanto for `true`, `recurrence.cycles` mostra o ciclo atual mais um, e o valor anterior volta quando o agendamento é removido","example":true,"uniqueKey":"cancelAtPeriodEnd","typeLabel":"boolean"},"scheduledCancellationAt":{"type":"string","format":"date","description":"Data efetiva do cancelamento agendado (YYYY-MM-DD). Só vem quando `cancelAtPeriodEnd` é `true`. Sem data enviada, é `trial.endDate` ou, sem trial, `recurrence.nextDueDate`","example":"2025-12-31","uniqueKey":"scheduledCancellationAt","typeLabel":"string\u003cdate>"},"scheduledCancellationReason":{"type":"string","description":"Motivo do cancelamento agendado. Só vem quando foi informado","example":"Cliente solicitou cancelamento","uniqueKey":"scheduledCancellationReason","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"abecf6d6-153e-4fc9-8222-8be5441de581","name":"Assinatura Premium com Eventos","clientId":"567265cb-fa7f-419f-9c1c-8e878dd2faf7","merchantId":"90d64a51-d442-426c-bbf9-b66e000e5576","customerId":"b99e159e-27d5-4927-b46e-ae7348f20131","referenceKey":"SUB-PREMIUM-001","currency":"BRL","items":[{"name":"Ingresso VIP Mensal","amount":29900,"quantity":1,"description":"Acesso VIP premium a eventos mensais","sku":"VIP-EVENT-001","risk":"Low","categoryId":"entertainment","locality":"São Paulo","date":"2025-12-01","type":1,"genre":"Shows e Eventos","tickets":{"quantityTicketSale":1,"quantityEventHouse":0,"convenienceFeeValue":15.5,"quantityFull":1,"quantityHalf":0,"batch":1},"location":{"street":"Av. Paulista","number":"1000","complement":"Centro de Convenções","zipCode":"01310-100","city":"São Paulo","state":"SP","country":"Brasil","district":"Bela Vista","reference":"Próximo ao MASP"}}],"recurrence":{"interval":"monthly","cycles":12,"startAt":"2025-08-10","endAt":"2026-08-10","nextDueDate":"2025-07-30"},"paymentMethod":{"type":"credit","card":{"cardId":"bfb60d16-108c-440b-bdb8-bbe67140f936"},"installments":1},"trial":{"endDate":"2025-08-15"},"splitRules":[{"sellerId":"d98106e8-568a-44c3-94d0-0e0bbd8b7e08","percentage":70,"processingFee":false,"chargeEntireFee":false,"chargeRemainderFee":false,"liable":true,"fares":{"mdr":2.5,"fee":0.3}}],"status":"created","amount":29900,"liveMode":true,"lastCycle":{"id":"ae765755-c909-4d97-813c-9c71add4b182","customerId":"b99e159e-27d5-4927-b46e-ae7348f20131","merchantId":"90d64a51-d442-426c-bbf9-b66e000e5576","cycle":1,"attempts":1,"status":"authorized","amount":29900,"items":[{"name":"Ingresso VIP Mensal","amount":29900,"quantity":1,"description":"Acesso VIP premium a eventos mensais","sku":"VIP-EVENT-001","risk":"Low","categoryId":"entertainment","locality":"São Paulo","date":"2025-12-01","type":1,"genre":"Shows e Eventos","tickets":{"quantityTicketSale":1,"quantityEventHouse":0,"convenienceFeeValue":15.5,"quantityFull":1,"quantityHalf":0,"batch":1},"location":{"street":"Av. Paulista","number":"1000","complement":"Centro de Convenções","zipCode":"01310-100","city":"São Paulo","state":"SP","country":"Brasil","district":"Bela Vista","reference":"Próximo ao MASP"}}],"scheduledAt":"2025-07-30","executedAt":"2025-07-30","nextAttemptAt":"2025-07-31","isEmulated":false,"emulatedAt":"2023-11-07T05:31:56Z","createdAt":"2025-07-30T20:14:12.599715Z","paymentHistory":[{"id":"f9661d7d-92fc-468a-8223-bc51f2ce8661","createdAt":"2025-07-30T20:14:12.608115Z","executedAt":"2025-07-30T20:14:13.104331Z","chargeId":"e17e09a4-5d0c-40c6-a8c0-be2adc765608","attemptNumber":1,"status":"authorized","paymentMethod":{"type":"credit","card":{"cardId":"bfb60d16-108c-440b-bdb8-bbe67140f936"},"installments":1},"error":{"message":"Card declined","providerError":{"declinedCode":"insufficient_funds","message":"\u003cstring>","networkDeniedMessage":"\u003cstring>","networkDeniedReason":"\u003cstring>","retryable":true}}}]},"createdAt":"2025-07-31T13:36:40.118822Z","updatedAt":"2025-07-31T13:36:40.118822Z","cancelAtPeriodEnd":true,"scheduledCancellationAt":"2025-12-31","scheduledCancellationReason":"Cliente solicitou cancelamento"}}},"exampleType":"generated"}},"exampleType":"generated"},"2e25b7f3-2c17-4117-a7c9-04f44d89928c":{"description":"Corpo inválido, `id` que não é UUID ou regra de negócio violada, como `trial` no corpo, split por `amount`, `startAt` depois do primeiro ciclo ou cartão e merchant não encontrados para o seu client. O motivo vem em `details`","content":{"application/json":{"schema":{"type":"object","description":"Formato dos erros do Motor de Assinaturas. Não há `businessCode` nem `key`; o motivo vem em `details`, como texto em inglês","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["bad_request","not_found","conflict","unauthorized","api_error"],"description":"Categoria do erro: `bad_request` (400), `not_found` (404) ou `conflict` (409)","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"integer","description":"Código HTTP da resposta","example":400,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","description":"Resumo do erro, em inglês","example":"Validation error","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX]","typeLabel":"string"},"description":"Motivos do erro, em inglês. Não vem em alguns erros de paginação","uniqueKey":"error.details","typeLabel":"string[]"}},"required":["type","code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"TrialNotEditable":{"title":"TrialNotEditable","value":{"error":{"type":"bad_request","code":400,"message":"Validation error","details":["trial end cannot be modified"]}}},"StartAtAfterFirstCycle":{"title":"StartAtAfterFirstCycle","value":{"error":{"type":"bad_request","code":400,"message":"Validation error","details":["startAt cannot be updated after the first cycle has been generated"]}}}},"exampleType":"examples"}},"exampleType":"examples"},"fc8a2944-80e1-4b0c-86d1-2844f95cd416":{"description":"Header `X-Client-Id` ausente. Esta resposta tem formato próprio, diferente das demais respostas de erro do Motor de Assinaturas","content":{"application/json":{"schema":{"type":"object","description":"Formato do `401` do Motor de Assinaturas, diferente das demais respostas de erro. `error` e `details` são textos","properties":{"error":{"type":"string","example":"Authentication required","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"string","example":"X-Client-Id header is required","uniqueKey":"details","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"MissingClientId":{"title":"MissingClientId","value":{"error":"Authentication required","details":"X-Client-Id header is required"}}},"exampleType":"examples"}},"exampleType":"examples"},"df40f083-9d32-441b-b2d8-7f5f273466de":{"description":"Assinatura inexistente ou de outro client. Os dois casos devolvem `404`","content":{"application/json":{"schema":{"type":"object","description":"Formato dos erros do Motor de Assinaturas. Não há `businessCode` nem `key`; o motivo vem em `details`, como texto em inglês","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["bad_request","not_found","conflict","unauthorized","api_error"],"description":"Categoria do erro: `bad_request` (400), `not_found` (404) ou `conflict` (409)","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"integer","description":"Código HTTP da resposta","example":400,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","description":"Resumo do erro, em inglês","example":"Validation error","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX]","typeLabel":"string"},"description":"Motivos do erro, em inglês. Não vem em alguns erros de paginação","uniqueKey":"error.details","typeLabel":"string[]"}},"required":["type","code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"NotFound":{"title":"NotFound","value":{"error":{"type":"not_found","code":404,"message":"Resource not found","details":["subscription with id abecf6d6-153e-4fc9-8222-8be5441de581 not found"]}}},"AnotherClient":{"title":"AnotherClient","value":{"error":{"type":"not_found","code":404,"message":"Resource not found","details":["invalid subscriptionId"]}}}},"exampleType":"examples"}},"exampleType":"examples"},"ce3079bc-e580-40f4-a77d-94818bf616ad":{"description":"Cancelamento agendado (`cancelAtPeriodEnd: true`) em assinatura `canceled` ou `expired`","content":{"application/json":{"schema":{"type":"object","description":"Formato dos erros do Motor de Assinaturas. Não há `businessCode` nem `key`; o motivo vem em `details`, como texto em inglês","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["bad_request","not_found","conflict","unauthorized","api_error"],"description":"Categoria do erro: `bad_request` (400), `not_found` (404) ou `conflict` (409)","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"integer","description":"Código HTTP da resposta","example":400,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"message":{"type":"string","description":"Resumo do erro, em inglês","example":"Validation error","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"string","uniqueKey":"error.details.items.[INDEX]","typeLabel":"string"},"description":"Motivos do erro, em inglês. Não vem em alguns erros de paginação","uniqueKey":"error.details","typeLabel":"string[]"}},"required":["type","code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"CannotSchedule":{"title":"CannotSchedule","value":{"error":{"type":"conflict","code":409,"message":"Invalid state transition","details":["only active, paused, unpaid, trialing or created subscriptions can be canceled, current status: canceled"]}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"7dd845ab-8a55-4088-a4c9-7ec907c7e310":{"X-Client-ID":{"type":"apiKey","in":"header","name":"X-Client-Id","scopes":[],"schemeName":"X-Client-ID"},"X-Api-Key":{"type":"apiKey","in":"header","name":"X-Api-Key","scopes":[],"schemeName":"X-Api-Key"}}},"servers":{"0676cd94-979e-48df-aa0c-bd30e3ec97a0":{"url":"https://api.malga.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Client-Id","scopes":[],"schemeName":"X-Client-ID"},"schema":{"title":"X-Client-Id","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"X-Client-ID","name":"X-Client-Id"},{"scheme":{"type":"apiKey","in":"header","name":"X-Api-Key","scopes":[],"schemeName":"X-Api-Key"},"schema":{"title":"X-Api-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"X-Api-Key","name":"X-Api-Key"}],"title":"X-Client-ID \u0026 X-Api-Key"}]},"originalFileLocation":"api-reference/api-spec.yaml"},"subdomain":"malga","siteName":"Malga","title":"Atualizar assinatura - Malga","relatedPagesConfig":{"enabled":true,"limit":4,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-20T18:35:30.898Z","originalFileLocation":"api-reference/subscriptions/atualizar-assinatura.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=\"Atualiza só os campos enviados. Os demais ficam como estão. - recurrence aceita só cycles e startAt. O intervalo não pode ser alterado: recurrence.interval é ignorado sem erro e a resposta mantém o intervalo antigo. Para trocar o intervalo, cancele a assinatura e crie outra. - referenceKey não pode ser alterado. O campo é ignorado sem erro e a resposta mantém o valor original. - trial não pode ser alterado. Enviar trial devolve 400. - splitRules aceita só percentage. Regra com amount devolve 400. - startAt só muda antes do primeiro ciclo. Depois dele, devolve 400. Se a nova data for hoje ou ontem (UTC), o primeiro ciclo é cobrado na mesma chamada. - Cancelamento agendado. Com cancelAtPeriodEnd: true, a assinatura precisa estar active, paused, unpaid, trialing ou created; em canceled ou expired, devolve 409. Atenção: cycles precisa ser maior que a quantidade de ciclos já executados, e items e splitRules não podem ser listas vazias. Valide os valores antes de enviar.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Malga\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/malga/FRGYPTtLcTku4cpj/_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/malga/FRGYPTtLcTku4cpj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/malga/FRGYPTtLcTku4cpj/_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/malga/FRGYPTtLcTku4cpj/_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/malga/FRGYPTtLcTku4cpj/_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/malga/FRGYPTtLcTku4cpj/_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/malga/FRGYPTtLcTku4cpj/_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/malga/FRGYPTtLcTku4cpj/_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/malga/FRGYPTtLcTku4cpj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Atualizar assinatura - Malga\">\u003cmeta data-mint-head property=\"og:description\" content=\"Atualiza só os campos enviados. Os demais ficam como estão. - recurrence aceita só cycles e startAt. O intervalo não pode ser alterado: recurrence.interval é ignorado sem erro e a resposta mantém o intervalo antigo. Para trocar o intervalo, cancele a assinatura e crie outra. - referenceKey não pode ser alterado. O campo é ignorado sem erro e a resposta mantém o valor original. - trial não pode ser alterado. Enviar trial devolve 400. - splitRules aceita só percentage. Regra com amount devolve 400. - startAt só muda antes do primeiro ciclo. Depois dele, devolve 400. Se a nova data for hoje ou ontem (UTC), o primeiro ciclo é cobrado na mesma chamada. - Cancelamento agendado. Com cancelAtPeriodEnd: true, a assinatura precisa estar active, paused, unpaid, trialing ou created; em canceled ou expired, devolve 409. Atenção: cycles precisa ser maior que a quantidade de ciclos já executados, e items e splitRules não podem ser listas vazias. Valide os valores antes de enviar.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Malga Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.malga.io/api-reference/subscriptions/atualizar-assinatura\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://malga.mintlify.site/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Atualizar+assinatura\u0026amp;description=Atualiza+s%C3%B3+os+campos+enviados.+Os+demais+ficam+como+est%C3%A3o.%0A%0A-+**%60recurrence%60+aceita+s%C3%B3+%60cycles%60+e+%60startAt%60.**+O+intervalo+n%C3%A3o+pode+ser+alterado%3A+%60recurrence.i\u0026amp;theme=bafc4230bd77064d0121c07f\u0026amp;signature=9dee907a84a7dbeab4e9d4f16b21504631f2f5fb92e0d8f361c74e90d6f85645\">\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=\"Atualizar assinatura - Malga\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Atualiza só os campos enviados. Os demais ficam como estão. - recurrence aceita só cycles e startAt. O intervalo não pode ser alterado: recurrence.interval é ignorado sem erro e a resposta mantém o intervalo antigo. Para trocar o intervalo, cancele a assinatura e crie outra. - referenceKey não pode ser alterado. O campo é ignorado sem erro e a resposta mantém o valor original. - trial não pode ser alterado. Enviar trial devolve 400. - splitRules aceita só percentage. Regra com amount devolve 400. - startAt só muda antes do primeiro ciclo. Depois dele, devolve 400. Se a nova data for hoje ou ontem (UTC), o primeiro ciclo é cobrado na mesma chamada. - Cancelamento agendado. Com cancelAtPeriodEnd: true, a assinatura precisa estar active, paused, unpaid, trialing ou created; em canceled ou expired, devolve 409. Atenção: cycles precisa ser maior que a quantidade de ciclos já executados, e items e splitRules não podem ser listas vazias. Valide os valores antes de enviar.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://malga.mintlify.site/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Atualizar+assinatura\u0026amp;description=Atualiza+s%C3%B3+os+campos+enviados.+Os+demais+ficam+como+est%C3%A3o.%0A%0A-+**%60recurrence%60+aceita+s%C3%B3+%60cycles%60+e+%60startAt%60.**+O+intervalo+n%C3%A3o+pode+ser+alterado%3A+%60recurrence.i\u0026amp;theme=bafc4230bd77064d0121c07f\u0026amp;signature=9dee907a84a7dbeab4e9d4f16b21504631f2f5fb92e0d8f361c74e90d6f85645\">\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/malga/FRGYPTtLcTku4cpj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Malga\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2FAC9B\">\u003cmeta data-mint-head name=\"og:locale\" content=\"pt_BR\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.malga.io/api-reference/subscriptions/atualizar-assinatura\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/subscriptions/atualizar-assinatura.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://malga.io/#organization\",\"name\":\"Malga\",\"url\":\"https://malga.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.malga.io/logo/light.svg\"},\"sameAs\":[\"https://www.youtube.com/@gomalga\",\"https://www.linkedin.com/company/gomalga/\",\"https://www.instagram.com/gomalga\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.malga.io#website\",\"name\":\"Malga\",\"url\":\"https://docs.malga.io\",\"publisher\":{\"@id\":\"https://malga.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.malga.io/api-reference/subscriptions/atualizar-assinatura#webpage\",\"url\":\"https://docs.malga.io/api-reference/subscriptions/atualizar-assinatura\",\"name\":\"Atualizar assinatura\",\"description\":\"Atualiza só os campos enviados. Os demais ficam como estão. - recurrence aceita só cycles e startAt. O intervalo não pode ser alterado: recurrence.interval é ignorado sem erro e a resposta mantém o intervalo antigo. Para trocar o intervalo, cancele a assinatura e crie outra. - referenceKey não pode ser alterado. O campo é ignorado sem erro e a resposta mantém o valor original. - trial não pode ser alterado. Enviar trial devolve 400. - splitRules aceita só percentage. Regra com amount devolve 400. - startAt só muda antes do primeiro ciclo. Depois dele, devolve 400. Se a nova data for hoje ou ontem (UTC), o primeiro ciclo é cobrado na mesma chamada. - Cancelamento agendado. Com cancelAtPeriodEnd: true, a assinatura precisa estar active, paused, unpaid, trialing ou created; em canceled ou expired, devolve 409. Atenção: cycles precisa ser maior que a quantidade de ciclos já executados, e items e splitRules não podem ser listas vazias. Valide os valores antes de enviar.\",\"dateModified\":\"2026-10-20T18:35:30.898Z\",\"isPartOf\":{\"@id\":\"https://docs.malga.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.malga.io/api-reference/subscriptions/atualizar-assinatura#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.malga.io/api-reference/subscriptions/atualizar-assinatura#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subscriptions\",\"item\":\"https://docs.malga.io/api-reference/subscriptions/criacao-de-uma-nova-assinatura\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Atualizar assinatura\",\"item\":\"https://docs.malga.io/api-reference/subscriptions/atualizar-assinatura\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.malga.io/api-reference/subscriptions/atualizar-assinatura#apireference\",\"headline\":\"Atualizar assinatura\",\"name\":\"Atualizar assinatura\",\"description\":\"Atualiza só os campos enviados. Os demais ficam como estão. - recurrence aceita só cycles e startAt. O intervalo não pode ser alterado: recurrence.interval é ignorado sem erro e a resposta mantém o intervalo antigo. Para trocar o intervalo, cancele a assinatura e crie outra. - referenceKey não pode ser alterado. O campo é ignorado sem erro e a resposta mantém o valor original. - trial não pode ser alterado. Enviar trial devolve 400. - splitRules aceita só percentage. Regra com amount devolve 400. - startAt só muda antes do primeiro ciclo. Depois dele, devolve 400. Se a nova data for hoje ou ontem (UTC), o primeiro ciclo é cobrado na mesma chamada. - Cancelamento agendado. Com cancelAtPeriodEnd: true, a assinatura precisa estar active, paused, unpaid, trialing ou created; em canceled ou expired, devolve 409. Atenção: cycles precisa ser maior que a quantidade de ciclos já executados, e items e splitRules não podem ser listas vazias. Valide os valores antes de enviar.\",\"url\":\"https://docs.malga.io/api-reference/subscriptions/atualizar-assinatura\",\"mainEntityOfPage\":{\"@id\":\"https://docs.malga.io/api-reference/subscriptions/atualizar-assinatura#webpage\"},\"dateModified\":\"2026-10-20T18:35:30.898Z\",\"publisher\":{\"@id\":\"https://malga.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.malga.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Malga\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Malga\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/subscriptions/atualizar-assinatura.md","siteName":"Malga","nav":{"global":{"anchors":[{"anchor":"Dashboard","icon":"table-layout","href":"https://dashboard.malga.io/"},{"anchor":"YouTube","icon":"youtube","href":"https://www.youtube.com/@gomalga"},{"anchor":"Status Page","icon":"signal-strong","href":"https://status.malga.io/"}]},"tabs":[{"tab":"Documentação","pages":[{"title":"Documentação","href":"/documentations/welcome/introduction"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/tokenization/v2/intro"}]},{"tab":"Referência da API","groups":[{"group":"Visão Geral","pages":[{"title":"Sobre as APIs da Malga","href":"/api-reference/about-apis"},{"title":"Autenticação","href":"/api-reference/authentication"}]},{"group":"Sub-keys","pages":[{"title":"Criar sub-key","openapi":"post /v1/auth","href":"/api-reference/client-token/criar-nova-chave-publica-para-uso-no-client-side"},{"title":"Remover sub-key","openapi":"delete /v1/auth/{id}","href":"/api-reference/client-token/remover-sub-key"}]},{"group":"Cards","pages":[{"openapi":"get /v1/cards","title":"Listar cartões","href":"/api-reference/cards/listar-cartoes"},{"openapi":"post /v1/cards","title":"Criar novo cartão a partir de token","href":"/api-reference/cards/criar-novo-cartao-a-partir-de-token"},{"openapi":"get /v1/cards/{id}","title":"Recuperar detalhes de cartão","href":"/api-reference/cards/recuperar-detalhes-de-cartao"}]},{"group":"Tokens","pages":[{"openapi":"post /v1/tokens","title":"Criar um novo token","href":"/api-reference/tokens/criar-um-novo-token"}]},{"group":"3DS2 Malga","pages":[{"title":"Criar um novo setup","openapi":"post /v1/charges/3ds/setup","href":"/api-reference/3ds-malga/criar-um-novo-setup"}]},{"group":"Charges","pages":[{"openapi":"get /v1/charges","title":"Listar cobranças","href":"/api-reference/charges/listar-cobrancas"},{"title":"Realizar nova cobrança","openapi":"post /v1/charges","href":"/api-reference/charges/realizar-nova-cobranca"},{"openapi":"get /v1/charges/{id}","title":"Recuperar detalhes de cobrança","href":"/api-reference/charges/recuperar-detalhes-de-cobranca"},{"openapi":"post /v1/charges/{id}","title":"Alterar o status de uma cobrança no ambiente de sandbox","href":"/api-reference/charges/alterar-o-status-de-uma-cobranca-no-ambiente-de-sandbox"},{"openapi":"patch /v1/charges/{id}/antifraud","title":"Alterar o status do antifraude no ambiente de sandbox","href":"/api-reference/charges/alterar-o-status-do-antifraude-no-ambiente-de-sandbox"},{"openapi":"post /v1/charges/{id}/capture","title":"Capturar cobrança pre-autorizada","href":"/api-reference/charges/capturar-cobranca-pre-autorizada"},{"openapi":"post /v1/charges/{id}/void","title":"Estornar cobrança aprovada","href":"/api-reference/charges/estornar-cobranca-aprovada"}]},{"group":"Sessions","pages":[{"openapi":"post /v1/sessions","title":"Criar nova sessão","href":"/api-reference/sessions/criar-nova-sessao"},{"title":"Listar sessões","openapi":"get /v1/sessions","href":"/api-reference/sessions/listar-sessoes"},{"openapi":"get /v1/sessions/{id}","title":"Recuperar detalhes de uma sessão","href":"/api-reference/sessions/recuperar-detalhes-de-uma-sessao"},{"openapi":"patch /v1/sessions/{id}","title":"Atualizar relevância de uma sessão","href":"/api-reference/sessions/atualizar-o-status-de-uma-sessao"},{"openapi":"post /v1/sessions/{id}/charge","title":"Pagar uma sessão","href":"/api-reference/sessions/pagar-uma-sessao"},{"openapi":"post /v1/sessions/{id}/purchase","title":"Pagar uma sessão com múltiplos cartões","href":"/api-reference/sessions/pagar-uma-sessao-com-multiplos-cartoes"},{"openapi":"post /v1/sessions/{id}/cancel","title":"Cancelar uma sessão","href":"/api-reference/sessions/cancelar-uma-sessao"},{"title":"Recuperar o histórico da sessão","openapi":"get /v1/sessions/{id}/history","href":"/api-reference/sessions/recuperar-o-historico-da-sessao"},{"openapi":"get /v1/sessions/{id}/link","title":"Recupera sessão com os dados das configurações da empresa","href":"/api-reference/sessions/recupera-sessao-com-os-dados-das-configuracoes-da-empresa"}]},{"group":"Purchases","pages":[{"openapi":"post /v1/purchases","title":"Criar uma Venda com múltiplos cartões","href":"/api-reference/purchases/criar-nova-venda"},{"openapi":"get /v1/purchases","title":"Listar Vendas","href":"/api-reference/purchases/listar-vendas"},{"openapi":"get /v1/purchases/{id}","title":"Recuperar detalhes de uma Venda","href":"/api-reference/purchases/recuperar-detalhes-de-uma-venda"},{"openapi":"get /v1/purchases/{id}/history","title":"Recuperar o histórico de uma Venda","href":"/api-reference/purchases/recuperar-o-historico-da-venda"},{"openapi":"post /v1/purchases/{id}/capture","title":"Capturar uma Venda pré-autorizada","href":"/api-reference/purchases/capturar-venda-pre-autorizada"},{"openapi":"post /v1/purchases/{id}/void","title":"Cancelar ou estornar uma Venda","href":"/api-reference/purchases/cancelar-ou-estornar-venda"}]},{"group":"Subscriptions","pages":[{"openapi":"post /v1/subscriptions","title":"Criação de uma nova assinatura","href":"/api-reference/subscriptions/criacao-de-uma-nova-assinatura"},{"openapi":"get /v1/subscriptions","title":"Listagem de assinaturas","href":"/api-reference/subscriptions/listagem-de-assinaturas"},{"openapi":"get /v1/subscriptions/{id}","title":"Recuperar detalhes de assinatura","href":"/api-reference/subscriptions/recuperar-detalhes-de-assinatura"},{"openapi":"get /v1/subscriptions/{id}/cycles","title":"Listar cycles de uma assinatura","href":"/api-reference/subscriptions/listagem-de-cycles-de-uma-assinatura"},{"openapi":"get /v1/subscriptions/{id}/cycles/{cycleId}","title":"Recuperar detalhes de um cycle específico","description":"Devolve o ciclo com o histórico de tentativas de cobrança (`paymentHistory`).\n\nUse um `cycleId` da [listagem de ciclos](/api-reference/subscriptions/listagem-de-cycles-de-uma-assinatura).\n","href":"/api-reference/subscriptions/recuperar-detalhes-de-cycle"},{"openapi":"put /v1/subscriptions/{id}","title":"Atualizar assinatura","href":"/api-reference/subscriptions/atualizar-assinatura"},{"openapi":"patch /v1/subscriptions/{id}/cancel","title":"Cancelar assinatura","description":"Cancela a assinatura na hora. Funciona nos status `active`, `paused`, `unpaid`, `trialing` e `created`; em `canceled` ou `expired`, devolve `409`. Uma assinatura cancelada não pode ser reativada.\n\nOs ciclos `scheduled`, `pending` e `retrying` passam para `canceled`. Ciclos `authorized` e `failed` não mudam. Se havia cancelamento agendado, ele é descartado. A operação emite o webhook `subscription.canceled`.\n\nO corpo é opcional. O `cancellationReason` enviado é gravado, mas não volta em nenhuma resposta da API.\n","href":"/api-reference/subscriptions/cancelar-assinatura"},{"openapi":"patch /v1/subscriptions/{id}/pause","title":"Pausar assinatura","href":"/api-reference/subscriptions/pausar-assinatura"},{"openapi":"patch /v1/subscriptions/{id}/resume","title":"Reativar assinatura","href":"/api-reference/subscriptions/reativar-assinatura"},{"openapi":"patch /v1/subscriptions/settings","title":"Atualizar configurações do cliente","href":"/api-reference/subscriptions/atualizar-configuracoes-do-cliente"},{"openapi":"get /v1/subscriptions/settings","title":"Obter configurações do cliente","href":"/api-reference/subscriptions/obter-configuracoes-do-cliente"}]},{"group":"Customers","pages":[{"openapi":"get /v1/customers","title":"Listagem de customers cadastrados","href":"/api-reference/customers/listagem-de-customers-cadastrados"},{"openapi":"post /v1/customers","title":"Criação de novo customer para cobrança","href":"/api-reference/customers/criacao-de-novo-customer-para-cobranca"},{"openapi":"get /v1/customers/{id}","title":"Recuperar detalhes de customer","href":"/api-reference/customers/recuperar-detalhes-de-customer"},{"openapi":"delete /v1/customers/{id}","title":"Deletar customer pelo id","href":"/api-reference/customers/deletar-customer-pelo-id"},{"openapi":"patch /v1/customers/{id}","title":"Atualizar customer pelo id","href":"/api-reference/customers/atualizar-customer-pelo-id"},{"openapi":"get /v1/customers/{customer_id}/cards","title":"Listagem dos cartões do customer","href":"/api-reference/customers/listagem-dos-cartoes-do-customer"},{"openapi":"post /v1/customers/{customer_id}/cards","title":"Adicionar cartão de crédito ao customer","href":"/api-reference/customers/adicionar-cartao-de-credito-ao-customer"}]},{"group":"Merchants","pages":[{"openapi":"get /v1/merchants","title":"Listagem de merchants cadastrados","href":"/api-reference/merchants/listagem-de-merchants-cadastrados"},{"openapi":"post /v1/merchants","title":"Criação de novo merchant para cobrança","href":"/api-reference/merchants/criacao-de-novo-merchant-para-cobranca"},{"openapi":"get /v1/merchants/{id}","title":"Recuperar detalhes de merchant pelo id","href":"/api-reference/merchants/recuperar-detalhes-de-merchant-pelo-id"},{"openapi":"delete /v1/merchants/{id}","title":"Deletar merchant pelo id","href":"/api-reference/merchants/deletar-merchant-pelo-id"},{"openapi":"patch /v1/merchants/{id}","title":"Atualizar configurações de merchant","href":"/api-reference/merchants/atualizar-configuracoes-de-merchant"},{"group":"Platform Fee","pages":[{"openapi":"patch /v1/merchants/{merchantId}/platform-fee/enabled","title":"Ativar ou desativar platform fee do merchant","href":"/api-reference/merchants/ativar-desativar-platform-fee"},{"openapi":"post /v1/merchants/{merchantId}/platform-fee","title":"Criar regras de platform fee","href":"/api-reference/merchants/criar-regras-de-platform-fee"},{"openapi":"get /v1/merchants/{merchantId}/platform-fee","title":"Listar regras de platform fee","href":"/api-reference/merchants/listar-regras-de-platform-fee"},{"openapi":"put /v1/merchants/{merchantId}/platform-fee","title":"Atualizar regras de platform fee","href":"/api-reference/merchants/atualizar-regras-de-platform-fee"},{"openapi":"delete /v1/merchants/{merchantId}/platform-fee/{platformFeeId}","title":"Deletar uma regra de platform fee pelo ID","href":"/api-reference/merchants/deletar-regras-de-platform-fee"},{"openapi":"post /v1/merchants/{merchantId}/sellers/{sellerId}/platform-fee","title":"Criar regras de platform fee de um seller","href":"/api-reference/merchants/criar-regras-de-platform-fee-do-seller"},{"openapi":"get /v1/merchants/{merchantId}/sellers/{sellerId}/platform-fee","title":"Listar regras de platform fee de um seller","href":"/api-reference/merchants/listar-regras-de-platform-fee-do-seller"},{"openapi":"put /v1/merchants/{merchantId}/sellers/{sellerId}/platform-fee","title":"Atualizar regras de platform fee de um seller","href":"/api-reference/merchants/atualizar-regras-de-platform-fee-do-seller"}]}]},{"group":"Providers","pages":[{"openapi":"patch /v1/providers/{id}","title":"Atualizar configurações de provedores do merchant","href":"/api-reference/providers/atualizar-configuracoes-de-provider-de-merchant"}]},{"group":"Vendors","pages":[{"openapi":"get /v1/vendors","title":"Listagem de vendedores paginada","href":"/api-reference/vendors/listagem-paginada-de-vendedores"},{"openapi":"post /v1/vendors","title":"Criação de um novo vendedor","href":"/api-reference/vendors/criacao-de-um-novo-vendedor"},{"openapi":"patch /v1/vendors/{id}","title":"Atualizar um vendedor","href":"/api-reference/vendors/atualizacao-de-vendedor-pelo-id"},{"openapi":"get /v1/vendors/{id}","title":"Recuperar detalhes de um vendedor","href":"/api-reference/vendors/consultar-um-vendedor-pelo-id"},{"openapi":"delete /v1/vendors/{id}","title":"Deletar vededor pelo id","href":"/api-reference/vendors/deletar-vendedor-por-id"}]},{"group":"Sellers","pages":[{"openapi":"post /v1/sellers","title":"Criação de um novo recebedor","href":"/api-reference/sellers/criacao-de-um-novo-recebedor"},{"openapi":"get /v1/sellers/{id}","title":"Consultar um recebedor pelo ID","href":"/api-reference/sellers/consultar-um-recebedor-pelo-id"},{"openapi":"get /v1/sellers","title":"Consultar recebedores por listagem paginada","href":"/api-reference/sellers/consultar-um-recebedor-por-listagem-paginada"},{"openapi":"delete /v1/sellers/{id}","title":"Deletar recebedor por ID","href":"/api-reference/sellers/deletar-recebedor-por-id"},{"openapi":"patch /v1/sellers/{id}","title":"Atualização de recebedor pelo ID","href":"/api-reference/sellers/atualizacao-de-recebedor-pelo-id"},{"openapi":"delete /v1/sellers/{id}/plan","title":"Desvincular plano de venda de um recebedor","href":"/api-reference/sellers/desvincular-plano-de-venda-de-um-recebedor"},{"title":"Alterar status de recebedor no Sandbox","openapi":"post /v1/sellers/{id}/status","href":"/api-reference/sellers/alterar-o-status-de-um-recebedor-no-ambiente-de-sandbox"},{"openapi":"post /v1/sellers/documents","title":"Upload de documento","href":"/api-reference/sellers/upload-de-documento"},{"openapi":"get /v1/sellers/documents","title":"Listar documentos","href":"/api-reference/sellers/listar-documentos"},{"openapi":"get /v1/sellers/documents/{documentId}","title":"Consultar documento","href":"/api-reference/sellers/consultar-documento"},{"openapi":"delete /v1/sellers/documents/{documentId}","title":"Deletar documento","href":"/api-reference/sellers/deletar-documento"},{"openapi":"get /v1/sellers/registration-reviews","title":"Listar processos de revisão cadastral","href":"/api-reference/sellers/listar-processos-de-revisao-cadastral"},{"openapi":"get /v1/sellers/{sellerId}/registration-reviews","title":"Listar processos de revisão cadastral de um recebedor","href":"/api-reference/sellers/listar-processos-de-revisao-cadastral-de-um-recebedor"},{"openapi":"post /v1/sellers/{sellerId}/registration-reviews/{processId}/submit","title":"Enviar os dados coletados de uma revisão cadastral","href":"/api-reference/sellers/enviar-dados-de-revisao-cadastral"}]},{"group":"Payouts","pages":[{"openapi":"get /v1/payouts/balance","title":"Consultar saldo","href":"/api-reference/payouts/consultar-saldo-de-payouts"},{"openapi":"get /v1/payouts/payment-batches","title":"Listar repasses","href":"/api-reference/payouts/listar-payment-batches"},{"openapi":"get /v1/payouts/payment-batches/{id}","title":"Consultar repasse pelo ID","href":"/api-reference/payouts/consultar-payment-batch-pelo-id"},{"openapi":"get /v1/payouts/payment-batches/{id}/orders","title":"Listar ordens de pagamento de um repasse","href":"/api-reference/payouts/listar-ordens-de-um-payment-batch"},{"openapi":"get /v1/payouts/orders","title":"Listar ordens de pagamento","href":"/api-reference/payouts/listar-ordens"},{"openapi":"get /v1/payouts/orders/{id}","title":"Consultar ordem de pagamento pelo ID","href":"/api-reference/payouts/consultar-ordem-pelo-id"}]},{"group":"Plans","pages":[{"openapi":"get /v1/subacquirer/plans","title":"Listar planos de venda","href":"/api-reference/subacquirer/listar-planos-de-venda"}]},{"group":"Prepayment","tag":"BETA","pages":[{"openapi":"get /v1/subacquirer/prepayment/receivables","title":"Consultar recebíveis disponíveis para antecipação","href":"/api-reference/prepayment/consultar-recebiveis-disponiveis-para-antecipacao"},{"openapi":"post /v1/subacquirer/prepayment","title":"Simular antecipação","href":"/api-reference/prepayment/simular-antecipacao"},{"openapi":"get /v1/subacquirer/prepayment","title":"Listar antecipações","href":"/api-reference/prepayment/listar-antecipacoes"},{"openapi":"get /v1/subacquirer/prepayment/{id}","title":"Recuperar detalhes de uma antecipação","href":"/api-reference/prepayment/consultar-antecipacao"},{"openapi":"post /v1/subacquirer/prepayment/{id}/commit","title":"Confirmar antecipação (aceite)","href":"/api-reference/prepayment/confirmar-antecipacao"}]},{"group":"Receipts","pages":[{"openapi":"post /v1/subacquirer/{transactionId}/receipts","title":"Gerar documento comprobatório de estorno","href":"/api-reference/receipts/gerar-documento-comprobatorio"}]},{"group":"Flows","pages":[{"openapi":"get /v1/flows","title":"Recuperar todos os fluxos paginado","href":"/api-reference/flows/recuperar-todos-os-fluxos-paginado"},{"openapi":"get /v1/flows/{id}","title":"Consultar um fluxo pelo id","href":"/api-reference/flows/consultar-um-fluxo-pelo-id"}]},{"group":"Webhooks","pages":[{"openapi":"get /v1/webhooks","title":"Listagem de webhooks cadastrados","href":"/api-reference/webhooks/listagem-de-webhooks-cadastrados"},{"openapi":"post /v1/webhooks","title":"Criação de novo webhook para notificação","href":"/api-reference/webhooks/criacao-de-novo-webhook-para-notificacao"},{"openapi":"get /v1/webhooks/{id}","title":"Recuperar detalhes de webhook","href":"/api-reference/webhooks/recuperar-detalhes-de-webhook"},{"openapi":"delete /v1/webhooks/{id}","title":"Deletar webhook pelo id","href":"/api-reference/webhooks/deletar-webhook-pelo-id"},{"openapi":"patch /v1/webhooks/{id}","title":"Atualizar webhook pelo id","href":"/api-reference/webhooks/atualizar-webhook-pelo-id"}]},{"group":"Settings","pages":[{"title":"Configurar link de pagamento personalizado","openapi":"post /v1/settings","href":"/api-reference/settings/criar-configuracao-de-link-de-pagamento"},{"title":"Recuperar configuração de link de pagamento personalizado","openapi":"get /v1/settings","href":"/api-reference/settings/recuperar-configuracao-de-link-de-pagamento"},{"title":"Editar configuração de link de pagamento","openapi":"patch /v1/settings","href":"/api-reference/settings/editar-configuracao-de-link-de-pagamento"},{"title":"Cadastrar códigos de facilitador por bandeira","openapi":"put /v1/settings/payment-facilitators","href":"/api-reference/settings/cadastrar-codigos-de-facilitador-por-bandeira"},{"title":"Listar códigos de facilitador por bandeira","openapi":"get /v1/settings/payment-facilitators","href":"/api-reference/settings/listar-codigos-de-facilitador-por-bandeira"}]}]},{"tab":"Analytics","pages":[{"title":"Analytics","href":"/analytics/intro"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/2026-10-29-Release-Notes"}]}]},"basePath":"","title":"Atualizar assinatura - Malga","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-DV3Oq1fY.js","dist-C-XZBk9h.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-D3Isdib3.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","AssistantPageLink--qIqmmVG.js"]}