{
"error": "Token de autenticação inválido ou ausente."
}
{
"error": "Billing not found"
}
Assinaturas
Buscar um checkout de assinatura
Retorna um checkout de assinatura (bill_... com frequency: SUBSCRIPTION), criado via POST /subscriptions/create. O formato é o mesmo do GET /checkouts/get.
Informe ao menos um entre id, externalId e customerId.
{
"error": "Token de autenticação inválido ou ausente."
}
{
"error": "Billing not found"
}
Retorna um checkout de assinatura (bill_... com frequency: SUBSCRIPTION), criado via Criar checkout de assinatura.
Requer a permissão SUBSCRIPTION:READ.
O formato da resposta é o mesmo do Buscar um Checkout. Informe ao menos um entre id, externalId e customerId.
Até 23/09/2026, checkouts de assinatura também saíam pelo GET /checkouts/get. Essa rota agora retorna apenas checkouts de pagamento único e links de pagamento. Veja o changelog.
Valores de status:
Valor
Significado
PENDING
Aguardando o primeiro pagamento
PAID
Pago; a assinatura foi criada
EXPIRED
Expirado sem pagamento
CANCELLED
Cancelado
REFUNDED
Reembolsado
Depois do pagamento, use Listar assinaturas com checkoutId para encontrar as assinaturas geradas por este checkout.
Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"AbacatePay","colors":{"primary":"#9EEA6C","light":"#9EEA6C","dark":"#9EEA6C"},"logo":{"light":"https://mintcdn.com/abacatepay/xO7P7BJz7mYAZGWC/images/logo_abkt.svg?fit=max\u0026auto=format\u0026n=xO7P7BJz7mYAZGWC\u0026q=85\u0026s=80cd7615ed55a1cad74cbb6920fa0bed","dark":"https://mintcdn.com/abacatepay/xO7P7BJz7mYAZGWC/images/logo_abkt.svg?fit=max\u0026auto=format\u0026n=xO7P7BJz7mYAZGWC\u0026q=85\u0026s=80cd7615ed55a1cad74cbb6920fa0bed"},"favicon":"https://mintcdn.com/abacatepay/A_mLrlQaTYJZv5aB/favicon.ico?fit=max\u0026auto=format\u0026n=A_mLrlQaTYJZv5aB\u0026q=85\u0026s=6ef5964a0b4fdbe414358c16720e89ae","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://api.abacatepay.com/v2"}},"appearance":{"default":"dark","strict":true},"navbar":{"links":[{"href":"https://docs.abacatepay.com/llms.txt","label":"llms.txt"},{"href":"https://github.com/AbacatePay/documentation","label":"Repositório"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.abacatepay.com/"}},"footer":{"socials":{"x":"https://x.com/abacatepay","github":"https://github.com/AbacatePay","discord":"https://discord.com/invite/CP57mm7EFk","linkedin":"https://br.linkedin.com/company/abacatepay?trk=public_post_feed-actor-name","youtube":"https://www.youtube.com/@abacatepay","instagram":"https://www.instagram.com/abacatepay"}},"fonts":{"family":"Fustat"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"abacatepay","hasAudioNarration":false,"actualSubdomain":"abacatepay","customDomains":["docs.abacatepay.com"],"gitSource":{"type":"github","owner":"abacatepay","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6aee3d7bc83575df2e25597b","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Referência","count":77},{"language":"default","tag":"API Reference","count":32},{"language":"default","tag":"CLI","count":14},{"language":"default","tag":"Webhooks","count":14},{"language":"default","tag":"Vídeos","count":14},{"language":"default","tag":"Guias","count":11},{"language":"default","tag":"SDKs","count":11},{"language":"default","tag":"Para Lojistas","count":10},{"language":"default","tag":"Assinaturas","count":10},{"language":"default","tag":"Checkout Transparente","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":"button[class*=\"try-it\"],button[aria-label*=\"Try it\"],button:has-text(\"Try it\"){background-color:#9EEA6C!important;color:#0A1B39!important}button[data-testid=\"try-it-button\"],.mintlify-code-block button[class*=\"try\"],pre button[class*=\"try\"],.mintlify-code button{background-color:#9eea6c!important;color:#0a1b39!important}button[class*=\"try-it\"]:hover,button[aria-label*=\"Try it\"]:hover{background-color:#8dd95b!important}[class*=\"TryIt\"] button,[class*=\"try-it\"] button,button:contains(\"Try it\"){background-color:#9EEA6C!important;color:#0A1B39!important}"}],"page":{"pagePath":"pages/subscriptions/checkouts-get","slug":"/pages/subscriptions/checkouts-get","pageMetadata":{"title":"Buscar um checkout de assinatura","openapi":"GET /subscriptions/checkouts/get","description":"Retorna um checkout de assinatura (`bill_...` com `frequency: SUBSCRIPTION`), criado via `POST /subscriptions/create`. O formato é o mesmo do `GET /checkouts/get`.\n\nInforme ao menos um entre `id`, `externalId` e `customerId`.\n","href":"/pages/subscriptions/checkouts-get"},"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 p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Retorna um checkout de assinatura (\", _jsx(_components.code, {\n children: \"bill_...\"\n }), \" com \", _jsx(_components.code, {\n children: \"frequency: SUBSCRIPTION\"\n }), \"), criado via \", _jsx(_components.code, {\n children: \"POST /subscriptions/create\"\n }), \". O formato é o mesmo do \", _jsx(_components.code, {\n children: \"GET /checkouts/get\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Informe ao menos um entre \", _jsx(_components.code, {\n children: \"id\"\n }), \", \", _jsx(_components.code, {\n children: \"externalId\"\n }), \" e \", _jsx(_components.code, {\n children: \"customerId\"\n }), \".\"]\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Card,Info,Table}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Retorna um checkout de assinatura (`,_jsx(_components.code,{children:`bill_...`}),` com `,_jsx(_components.code,{children:`frequency: SUBSCRIPTION`}),`), criado via `,_jsx(_components.a,{href:`/pages/subscriptions/create`,children:`Criar checkout de assinatura`}),`.`]}),`\n`,_jsx(Card,{horizontal:true,children:_jsxs(_components.p,{children:[`Requer a permissão `,_jsx(_components.code,{children:`SUBSCRIPTION:READ`}),`.`]})}),`\n`,_jsxs(_components.p,{children:[`O formato da resposta é o mesmo do `,_jsx(_components.a,{href:`/pages/payment/one`,children:`Buscar um Checkout`}),`. Informe ao menos um entre `,_jsx(_components.code,{children:`id`}),`, `,_jsx(_components.code,{children:`externalId`}),` e `,_jsx(_components.code,{children:`customerId`}),`.`]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Até 23/09/2026, checkouts de assinatura também saíam pelo `,_jsx(_components.code,{children:`GET /checkouts/get`}),`. Essa rota agora retorna apenas checkouts de pagamento único e links de pagamento. Veja o `,_jsx(_components.a,{href:`/pages/changelog/index`,children:`changelog`}),`.`]})}),`\n`,_jsx(_components.p,{children:_jsxs(_components.strong,{children:[`Valores de `,_jsx(_components.code,{children:`status`}),`:`]})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Valor`}),_jsx(_components.th,{children:`Significado`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`PENDING`})}),_jsx(_components.td,{children:`Aguardando o primeiro pagamento`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`PAID`})}),_jsx(_components.td,{children:`Pago; a assinatura foi criada`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`EXPIRED`})}),_jsx(_components.td,{children:`Expirado sem pagamento`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`CANCELLED`})}),_jsx(_components.td,{children:`Cancelado`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`REFUNDED`})}),_jsx(_components.td,{children:`Reembolsado`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Depois do pagamento, use `,_jsx(_components.a,{href:`/pages/subscriptions/list`,children:`Listar assinaturas`}),` com `,_jsx(_components.code,{children:`checkoutId`}),` para encontrar as assinaturas geradas por este checkout.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Buscar um checkout de assinatura","openapi":"GET /subscriptions/checkouts/get","description":"Retorna um checkout de assinatura (`bill_...` com `frequency: SUBSCRIPTION`), criado via `POST /subscriptions/create`. O formato é o mesmo do `GET /checkouts/get`.\n\nInforme ao menos um entre `id`, `externalId` e `customerId`.\n","href":"/pages/subscriptions/checkouts-get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Buscar um checkout de assinatura","description":"Retorna um checkout de assinatura (`bill_...` com `frequency: SUBSCRIPTION`), criado via `POST /subscriptions/create`. O formato é o mesmo do `GET /checkouts/get`.\n\nInforme ao menos um entre `id`, `externalId` e `customerId`.\n","security":["29d04b4d-1444-4c11-b67e-a1a314020631"],"parameters":["3e71a77d-3d50-481c-a98a-173d1863b6f3","cfee1861-12d6-49d1-8204-ef77e407bfdc","cf734a1f-b87a-4751-a80a-59dd45463e59","01edf44d-fe03-463c-8945-dd9ee02cddb3"],"responses":{"200":"0192c4da-9127-4291-92fe-dbba69a9bcda","401":"a927402b-1988-46e2-bb5d-f2706d21d59d","404":"e74829c3-e88f-43a1-a461-8620316a546b"},"method":"get","type":"path","servers":["4cb55518-ff72-4dd9-8f0f-e550515e6a6d"],"path":"/subscriptions/checkouts/get","baseUrlOptions":["https://api.abacatepay.com/v2"],"title":"Buscar um checkout de assinatura","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3e71a77d-3d50-481c-a98a-173d1863b6f3":{"name":"id","in":"query","description":"Identificador único do checkout de assinatura","required":false,"schema":{"type":"string","example":"bill_abc123xyz","isRequired":false,"description":"Identificador único do checkout de assinatura","uniqueKey":"","typeLabel":"string"}},"cfee1861-12d6-49d1-8204-ef77e407bfdc":{"name":"externalId","in":"query","description":"Identificador do checkout no seu sistema","required":false,"schema":{"type":"string","example":"assinatura-123","isRequired":false,"description":"Identificador do checkout no seu sistema","uniqueKey":"","typeLabel":"string"}},"cf734a1f-b87a-4751-a80a-59dd45463e59":{"name":"customerId","in":"query","description":"Identificador do cliente associado","required":false,"schema":{"type":"string","example":"cust_abc123xyz","isRequired":false,"description":"Identificador do cliente associado","uniqueKey":"","typeLabel":"string"}},"01edf44d-fe03-463c-8945-dd9ee02cddb3":{"name":"method","in":"query","description":"Método de pagamento. Casa o checkout que oferece este método, mesmo que ofereça outros também.","required":false,"schema":{"type":"string","enum":["PIX","CARD"],"isRequired":false,"description":"Método de pagamento. Casa o checkout que oferece este método, mesmo que ofereça outros também.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"0192c4da-9127-4291-92fe-dbba69a9bcda":{"description":"Checkout de assinatura encontrado com sucesso.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único do Checkout.","example":"bill_abc123xyz","uniqueKey":"data.id","typeLabel":"string"},"externalId":{"oneOf":[{"type":"string","description":"ID do Checkout no seu sistema.","example":"pedido-123","uniqueKey":"data.externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID do Checkout no seu sistema.","example":"pedido-123","uniqueKey":"data.externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.externalId","typeLabel":"string | null"},"url":{"type":"string","format":"uri","description":"URL onde o usuário pode concluir o pagamento.","example":"https://app.abacatepay.com/pay/bill_abc123xyz","uniqueKey":"data.url","typeLabel":"string\u003curi>"},"amount":{"type":"number","description":"Valor total a ser pago em centavos.","example":10000,"uniqueKey":"data.amount","typeLabel":"number"},"paidAmount":{"oneOf":[{"type":"number","description":"Valor já pago em centavos. Null se ainda não foi pago.","example":null,"uniqueKey":"data.paidAmount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Valor já pago em centavos. Null se ainda não foi pago.","example":null,"uniqueKey":"data.paidAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.paidAmount","typeLabel":"number | null"},"items":{"type":"array","description":"Lista de itens no Checkout.","items":{"type":"object","properties":{"id":{"type":"string","description":"ID do produto.","example":"prod_456","uniqueKey":"data.\\items.items.[INDEX].id","typeLabel":"string"},"quantity":{"type":"integer","description":"Quantidade do item.","example":2,"uniqueKey":"data.\\items.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"data.\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.\\items","typeLabel":"object[]"},"status":{"type":"string","description":"Status atual do Checkout. `REDEEMED` quando o cliente fechou o checkout com um cupom de 100%, sem pagar nada.","enum":["PENDING","EXPIRED","CANCELLED","PAID","REFUNDED","REDEEMED"],"example":"PENDING","uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"coupons":{"type":"array","description":"Lista de cupons aplicados no Checkout.","items":{"type":"string","uniqueKey":"data.coupons.items.[INDEX]","typeLabel":"string"},"example":[],"uniqueKey":"data.coupons","typeLabel":"string[]"},"devMode":{"type":"boolean","description":"Indica se a cobrança foi criada em ambiente de testes.","example":false,"uniqueKey":"data.devMode","typeLabel":"boolean"},"customerId":{"oneOf":[{"type":"string","description":"ID do cliente associado ao Checkout.","example":null,"uniqueKey":"data.customerId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID do cliente associado ao Checkout.","example":null,"uniqueKey":"data.customerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.customerId","typeLabel":"string | null"},"returnUrl":{"oneOf":[{"type":"string","format":"uri","description":"URL para onde o cliente será redirecionado ao clicar em \"Voltar\".","example":null,"uniqueKey":"data.returnUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL para onde o cliente será redirecionado ao clicar em \"Voltar\".","example":null,"uniqueKey":"data.returnUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.returnUrl","typeLabel":"string\u003curi> | null"},"completionUrl":{"oneOf":[{"type":"string","format":"uri","description":"URL para onde o cliente será redirecionado após o pagamento.","example":null,"uniqueKey":"data.completionUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL para onde o cliente será redirecionado após o pagamento.","example":null,"uniqueKey":"data.completionUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.completionUrl","typeLabel":"string\u003curi> | null"},"receiptUrl":{"oneOf":[{"type":"string","format":"uri","description":"URL do comprovante de pagamento.","example":null,"uniqueKey":"data.receiptUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"URL do comprovante de pagamento.","example":null,"uniqueKey":"data.receiptUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.receiptUrl","typeLabel":"string\u003curi> | null"},"upSellProductId":{"oneOf":[{"type":"string","description":"ID do produto de upsell vinculado ao Checkout. Null se nenhum produto de upsell foi informado na criação.","example":"prod_bump456xyz","uniqueKey":"data.upSellProductId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID do produto de upsell vinculado ao Checkout. Null se nenhum produto de upsell foi informado na criação.","example":"prod_bump456xyz","uniqueKey":"data.upSellProductId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.upSellProductId","typeLabel":"string | null"},"installmentsCount":{"oneOf":[{"type":"integer","description":"Número de parcelas do pagamento quando realizado via Cartão de crédito com mais de uma parcela. `null` para pagamentos à vista ou realizados por outros métodos (PIX, Boleto).","example":3,"uniqueKey":"data.installmentsCount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Número de parcelas do pagamento quando realizado via Cartão de crédito com mais de uma parcela. `null` para pagamentos à vista ou realizados por outros métodos (PIX, Boleto).","example":3,"uniqueKey":"data.installmentsCount.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.installmentsCount","typeLabel":"integer | null"},"card":{"type":"object","description":"Configuração do pagamento por cartão enviada na criação.","properties":{"maxInstallments":{"type":"integer","description":"Número máximo de parcelas oferecidas no checkout.","example":12,"uniqueKey":"data.card.maxInstallments","typeLabel":"integer"},"passFeesToCustomer":{"type":"boolean","description":"Se a taxa do cartão é repassada ao cliente.","example":false,"uniqueKey":"data.card.passFeesToCustomer","typeLabel":"boolean"}},"uniqueKey":"data.card","typeLabel":"object"},"customerFee":{"oneOf":[{"type":"integer","description":"Acréscimo, em centavos, que o cliente pagou com o repasse da taxa do cartão (`card.passFeesToCustomer`). `null` sem repasse ou quando o pagamento não foi no cartão.","example":null,"uniqueKey":"data.customerFee.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Acréscimo, em centavos, que o cliente pagou com o repasse da taxa do cartão (`card.passFeesToCustomer`). `null` sem repasse ou quando o pagamento não foi no cartão.","example":null,"uniqueKey":"data.customerFee.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.customerFee","typeLabel":"integer | null"},"dueDate":{"oneOf":[{"type":"string","format":"date","description":"Data de vencimento do boleto (`YYYY-MM-DD`). `null` quando não foi configurada ou quando o método de pagamento não é BOLETO.","example":"2026-08-15","uniqueKey":"data.dueDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"Data de vencimento do boleto (`YYYY-MM-DD`). `null` quando não foi configurada ou quando o método de pagamento não é BOLETO.","example":"2026-08-15","uniqueKey":"data.dueDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.dueDate","typeLabel":"string\u003cdate> | null"},"interest":{"oneOf":[{"type":"object","description":"Juros por atraso configurados para o boleto. `null` quando não foi configurado ou quando o método de pagamento não é BOLETO.","required":["value"],"properties":{"value":{"type":"integer","minimum":0,"description":"Percentual de juros ao mês em centésimos de percentual (`100` = 1% ao mês, `250` = 2,5% ao mês). Quando `0` ou omitido, sem juros. Calculado pro rata die após o vencimento.\nEN: Monthly late-interest rate in hundredths of a percent (`100` = 1%/month). Accrues pro rata die after the due date; `0` or omitted disables interest.","example":100,"isRequired":true,"uniqueKey":"data.interest.oneOf.0.value","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"data.interest.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.interest.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.interest","typeLabel":"object | null"},"fine":{"oneOf":[{"type":"object","description":"Multa por atraso configurada para o boleto. `null` quando não foi configurada ou quando o método de pagamento não é BOLETO.","required":["value","type"],"properties":{"value":{"type":"integer","minimum":0,"description":"Quando `type = \"PERCENTAGE\"`: centésimos de percentual sobre o valor do boleto (`200` = 2%). Quando `type = \"FIXED\"`: valor fixo em centavos (`1000` = R$ 10,00). Quando `0` ou omitido, sem multa.\nEN: With `type: \"PERCENTAGE\"`, value is in hundredths of a percent (`200` = 2%). With `type: \"FIXED\"`, value is in cents (`1000` = R$ 10.00). `0` or omitted disables the fine.","example":200,"isRequired":true,"uniqueKey":"data.fine.oneOf.0.value","typeLabel":"integer"},"type":{"type":"string","description":"Tipo da multa. `PERCENTAGE` aplica percentual sobre o valor do boleto; `FIXED` aplica um valor fixo em centavos.\nEN: Fine type. `PERCENTAGE` applies a percent of the boleto amount; `FIXED` applies a fixed amount in cents.","enum":["PERCENTAGE","FIXED"],"example":"PERCENTAGE","isRequired":true,"uniqueKey":"data.fine.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"data.fine.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.fine.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.fine","typeLabel":"object | null"},"metadata":{"type":"object","description":"Metadados adicionais do Checkout.","additionalProperties":true,"example":{},"uniqueKey":"data.metadata","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"Data e hora de criação do Checkout.","example":"2024-11-04T18:38:28.573Z","uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Data e hora da última atualização do Checkout.","example":"2024-11-04T18:38:28.573Z","uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data","typeLabel":"object"},"error":{"oneOf":[{"type":"string","example":null,"uniqueKey":"error.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"string | null"},"success":{"type":"boolean","description":"Se a requisição obteve sucesso ou não.","example":true,"uniqueKey":"success","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"bill_abc123xyz","externalId":"pedido-123","url":"https://app.abacatepay.com/pay/bill_abc123xyz","amount":10000,"paidAmount":null,"items":[{"id":"prod_456","quantity":2}],"status":"PENDING","coupons":[],"devMode":false,"customerId":null,"returnUrl":null,"completionUrl":null,"receiptUrl":null,"upSellProductId":"prod_bump456xyz","installmentsCount":3,"card":{"maxInstallments":12,"passFeesToCustomer":false},"customerFee":null,"dueDate":"2026-08-15","interest":{"value":100},"fine":{"value":200,"type":"PERCENTAGE"},"metadata":{},"createdAt":"2024-11-04T18:38:28.573Z","updatedAt":"2024-11-04T18:38:28.573Z"},"error":null,"success":true}}},"exampleType":"generated"}},"exampleType":"generated"},"a927402b-1988-46e2-bb5d-f2706d21d59d":{"description":"Não autorizado. Falha na autenticação.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Token de autenticação inválido ou ausente.","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Token de autenticação inválido ou ausente."}}},"exampleType":"generated"}},"exampleType":"generated"},"e74829c3-e88f-43a1-a461-8620316a546b":{"description":"Checkout de assinatura não encontrado.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Billing not found","uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Billing not found"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"29d04b4d-1444-4c11-b67e-a1a314020631":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Todas as requisições devem incluir sua chave de API no header Authorization usando o formato `Bearer \u003cabacatepay-api-key>`. Sem esse header a requisição será rejeitada.\n\nSaiba mais sobre como criar e usar chaves de API na [documentação de autenticação](/pages/authentication).\n","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"4cb55518-ff72-4dd9-8f0f-e550515e6a6d":{"url":"https://api.abacatepay.com/v2","description":"Único servidor para os ambientes de produção e sandbox."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Todas as requisições devem incluir sua chave de API no header Authorization usando o formato `Bearer \u003cabacatepay-api-key>`. Sem esse header a requisição será rejeitada.\n\nSaiba mais sobre como criar e usar chaves de API na [documentação de autenticação](/pages/authentication).\n","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Todas as requisições devem incluir sua chave de API no header Authorization usando o formato `Bearer \u003cabacatepay-api-key>`. Sem esse header a requisição será rejeitada.\n\nSaiba mais sobre como criar e usar chaves de API na [documentação de autenticação](/pages/authentication).\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"abacatepay","siteName":"AbacatePay","title":"Buscar um checkout de assinatura - AbacatePay","navMaps":{"firstHrefInVersion":{"v2":{"href":"/pages/subscriptions/checkouts-get","matchLevel":0},"v1":{"href":"/pages/v1/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-09-23T21:48:30.926Z","originalFileLocation":"pages/subscriptions/checkouts-get.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";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=\"dark\"}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=\"Retorna um checkout de assinatura (bill_... com frequency: SUBSCRIPTION), criado via POST /subscriptions/create. O formato é o mesmo do GET /checkouts/get. Informe ao menos um entre id, externalId e customerId.\">\u003cmeta data-mint-head name=\"application-name\" content=\"AbacatePay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_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/abacatepay/3vOAsUCVrWwWFehF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Buscar um checkout de assinatura - AbacatePay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retorna um checkout de assinatura (bill_... com frequency: SUBSCRIPTION), criado via POST /subscriptions/create. O formato é o mesmo do GET /checkouts/get. Informe ao menos um entre id, externalId e customerId.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AbacatePay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.abacatepay.com/pages/subscriptions/checkouts-get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://abacatepay.mintlify.site/_mintlify/api/og/v2?division=Assinaturas\u0026amp;title=Buscar+um+checkout+de+assinatura\u0026amp;description=Retorna+um+checkout+de+assinatura+%28%60bill_...%60+com+%60frequency%3A+SUBSCRIPTION%60%29%2C+criado+via+%60POST+%2Fsubscriptions%2Fcreate%60.+O+formato+%C3%A9+o+mesmo+do+%60GET+%2Fcheckouts%2Fge\u0026amp;theme=50c7415e24595ab8b55c789a\u0026amp;signature=60c29892bc3c4470dc27999053a5334ad84336ba51081ae89cddd2575019498e\">\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=\"Buscar um checkout de assinatura - AbacatePay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retorna um checkout de assinatura (bill_... com frequency: SUBSCRIPTION), criado via POST /subscriptions/create. O formato é o mesmo do GET /checkouts/get. Informe ao menos um entre id, externalId e customerId.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://abacatepay.mintlify.site/_mintlify/api/og/v2?division=Assinaturas\u0026amp;title=Buscar+um+checkout+de+assinatura\u0026amp;description=Retorna+um+checkout+de+assinatura+%28%60bill_...%60+com+%60frequency%3A+SUBSCRIPTION%60%29%2C+criado+via+%60POST+%2Fsubscriptions%2Fcreate%60.+O+formato+%C3%A9+o+mesmo+do+%60GET+%2Fcheckouts%2Fge\u0026amp;theme=50c7415e24595ab8b55c789a\u0026amp;signature=60c29892bc3c4470dc27999053a5334ad84336ba51081ae89cddd2575019498e\">\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/abacatepay/3vOAsUCVrWwWFehF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"AbacatePay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9EEA6C\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.abacatepay.com/pages/subscriptions/checkouts-get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pages/subscriptions/checkouts-get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.abacatepay.com/#organization\",\"name\":\"AbacatePay\",\"url\":\"https://docs.abacatepay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/abacatepay/xO7P7BJz7mYAZGWC/images/logo_abkt.svg?fit=max\u0026auto=format\u0026n=xO7P7BJz7mYAZGWC\u0026q=85\u0026s=80cd7615ed55a1cad74cbb6920fa0bed\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.abacatepay.com#website\",\"name\":\"AbacatePay\",\"url\":\"https://docs.abacatepay.com\",\"publisher\":{\"@id\":\"https://docs.abacatepay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.abacatepay.com/pages/subscriptions/checkouts-get#webpage\",\"url\":\"https://docs.abacatepay.com/pages/subscriptions/checkouts-get\",\"name\":\"Buscar um checkout de assinatura\",\"description\":\"Retorna um checkout de assinatura (bill_... com frequency: SUBSCRIPTION), criado via POST /subscriptions/create. O formato é o mesmo do GET /checkouts/get. Informe ao menos um entre id, externalId e customerId.\",\"dateModified\":\"2026-09-23T21:48:30.926Z\",\"isPartOf\":{\"@id\":\"https://docs.abacatepay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.abacatepay.com/pages/subscriptions/checkouts-get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.abacatepay.com/pages/subscriptions/checkouts-get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Assinaturas\",\"item\":\"https://docs.abacatepay.com/pages/subscriptions/reference\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Buscar um checkout de assinatura\",\"item\":\"https://docs.abacatepay.com/pages/subscriptions/checkouts-get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.abacatepay.com/pages/subscriptions/checkouts-get#apireference\",\"headline\":\"Buscar um checkout de assinatura\",\"name\":\"Buscar um checkout de assinatura\",\"description\":\"Retorna um checkout de assinatura (bill_... com frequency: SUBSCRIPTION), criado via POST /subscriptions/create. O formato é o mesmo do GET /checkouts/get. Informe ao menos um entre id, externalId e customerId.\",\"url\":\"https://docs.abacatepay.com/pages/subscriptions/checkouts-get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.abacatepay.com/pages/subscriptions/checkouts-get#webpage\"},\"dateModified\":\"2026-09-23T21:48:30.926Z\",\"publisher\":{\"@id\":\"https://docs.abacatepay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.abacatepay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"AbacatePay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"AbacatePay","nav":{"global":null,"versions":[{"version":"v2","tag":"Current","tabs":[{"tab":"Comece aqui","pages":[{"title":"Comece aqui","href":"/pages/start/welcome"}]},{"tab":"Para Lojistas","pages":[{"title":"Para Lojistas","href":"/pages/concepts/overview"}]},{"tab":"Guias","pages":[{"title":"Guias","href":"/pages/authentication"}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/pages/webhooks"}]},{"tab":"Referência","groups":[{"group":"Introdução","pages":[{"title":"Introdução","icon":"book-open","href":"/pages/reference/introduction"}]},{"group":"Cobrar com Checkout","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/payment/reference"},{"title":"Criar um Checkout","openapi":"POST /checkouts/create","href":"/pages/payment/create"},{"title":"Receber parcelado (Cartão)","icon":"credit-card","href":"/pages/payment/installments"},{"title":"Listar Checkouts","openapi":"GET /checkouts/list","href":"/pages/payment/list"},{"title":"Buscar um Checkout","openapi":"GET /checkouts/get","href":"/pages/payment/one"},{"title":"Reembolsar um Checkout","openapi":"POST /checkouts/refund","href":"/pages/payment/refund"}]},{"group":"Links de pagamento","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/payment-links/reference"},{"title":"Criar um link de pagamento","openapi":"POST /payment-links/create","href":"/pages/payment-links/create"},{"title":"Listar links de pagamento","openapi":"GET /payment-links/list","href":"/pages/payment-links/list"},{"title":"Buscar um link de pagamento","openapi":"GET /payment-links/get","href":"/pages/payment-links/one"},{"title":"Reembolsar pagamento de link","openapi":"POST /payment-links/refund","href":"/pages/payment-links/refund"}]},{"group":"Clientes","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/client/reference"},{"title":"Criar um Cliente","openapi":"POST /customers/create","href":"/pages/client/create"},{"title":"Listar Clientes","openapi":"GET /customers/list","href":"/pages/client/list"},{"title":"Buscar um Cliente","openapi":"GET /customers/get","href":"/pages/client/get"},{"title":"Deletar um Cliente","openapi":"POST /customers/delete","href":"/pages/client/delete"}]},{"group":"Portal do cliente","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/customer-portal/reference"},{"title":"Criar um link do portal","openapi":"POST /customer-portal/create","href":"/pages/customer-portal/create"}]},{"group":"Checkout Transparente","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/transparents/reference"},{"title":"Criar cobrança PIX","openapi":"POST /transparents/create","href":"/pages/transparents/create"},{"title":"Criar cobrança Boleto","openapi":"POST /transparents/create","href":"/pages/transparents/boleto"},{"title":"Criar cobrança Cartão","api":"POST /transparents/create","href":"/pages/transparents/card"},{"title":"Chave pública (publicKey)","icon":"key","href":"/pages/transparents/public-key"},{"title":"abacatepay.js","icon":"js","href":"/pages/transparents/abacatepay-js"},{"title":"Listar Checkouts Transparentes","openapi":"GET /transparents/list","href":"/pages/transparents/list"},{"title":"Simular Pagamento","openapi":"POST /transparents/simulate-payment","href":"/pages/transparents/simulate-payment"},{"title":"Checar Status","openapi":"GET /transparents/check","href":"/pages/transparents/check"},{"title":"Reembolsar Checkout Transparente","openapi":"POST /transparents/refund","href":"/pages/transparents/refund"}]},{"group":"Cupons","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/coupons/reference"},{"title":"Criar um cupom","openapi":"POST /coupons/create","href":"/pages/coupons/create"},{"title":"Listar cupons","openapi":"GET /coupons/list","href":"/pages/coupons/list"},{"title":"Buscar um Cupom","openapi":"GET /coupons/get","href":"/pages/coupons/get"},{"title":"Deletar um Cupom","openapi":"POST /coupons/delete","href":"/pages/coupons/delete"},{"title":"Alternar Status de um Cupom","openapi":"POST /coupons/toggle","href":"/pages/coupons/toggle"}]},{"group":"Produtos","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/products/reference"},{"title":"Criar um produto","openapi":"POST /products/create","href":"/pages/products/create"},{"title":"Listar produtos","openapi":"GET /products/list","href":"/pages/products/list"},{"title":"Buscar um produto","openapi":"GET /products/get","href":"/pages/products/get"},{"title":"Deletar um Produto","openapi":"POST /products/delete","href":"/pages/products/delete"}]},{"group":"Webhooks","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/webhooks/reference"},{"title":"Criar um webhook","openapi":"POST /webhooks/create","href":"/pages/webhooks/create"},{"title":"Listar webhooks","openapi":"GET /webhooks/list","href":"/pages/webhooks/list"},{"title":"Buscar um webhook","openapi":"GET /webhooks/get","href":"/pages/webhooks/get"},{"title":"Deletar um webhook","openapi":"POST /webhooks/delete","href":"/pages/webhooks/delete"}]},{"group":"Assinaturas","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/subscriptions/reference"},{"title":"Criar Checkout de assinatura","openapi":"POST /subscriptions/create","description":"Cria um Checkout de assinatura — uma página de pagamento igual ao Checkout comum, mas para cobrança recorrente.\n\nAceita os mesmos parâmetros do Checkout (`returnUrl`, `completionUrl`, `customerId`, `externalId`, `metadata`, `coupons`, `methods`). O Checkout de assinatura aceita **apenas um produto**; o ciclo (frequência) já deve estar definido no produto ao criá-lo na loja — não é enviado no checkout.\n","href":"/pages/subscriptions/create"},{"title":"Buscar um checkout de assinatura","openapi":"GET /subscriptions/checkouts/get","href":"/pages/subscriptions/checkouts-get"},{"title":"Listar checkouts de assinatura","openapi":"GET /subscriptions/checkouts/list","description":"Retorna os checkouts de assinatura (`bill_...` com `frequency: SUBSCRIPTION`) da sua loja, pagos ou não, com paginação por cursor. O formato de cada item é o mesmo do `GET /checkouts/list`.\n","href":"/pages/subscriptions/checkouts-list"},{"title":"Deletar um checkout de assinatura","openapi":"POST /subscriptions/checkouts/delete","href":"/pages/subscriptions/checkouts-delete"},{"title":"Buscar uma assinatura","openapi":"GET /subscriptions/get","href":"/pages/subscriptions/get"},{"title":"Listar assinaturas","openapi":"GET /subscriptions/list","href":"/pages/subscriptions/list"},{"title":"Cancelar uma assinatura","openapi":"POST /subscriptions/cancel","href":"/pages/subscriptions/cancel"},{"title":"Alterar plano da assinatura","openapi":"POST /subscriptions/change-plan","href":"/pages/subscriptions/change-plan"},{"title":"Registrar uso","openapi":"POST /subscriptions/record-usage","href":"/pages/subscriptions/record-usage"}]},{"group":"Saques","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/payouts/reference"},{"title":"Criar um Saque","openapi":"POST /payouts/create","href":"/pages/payouts/create"},{"title":"Buscar saque","openapi":"GET /payouts/get","href":"/pages/payouts/get"},{"title":"Listar Saques","openapi":"GET /payouts/list","href":"/pages/payouts/list"}]},{"group":"PIX","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/pix/reference"},{"title":"Enviar PIX","openapi":"POST /pix/send","href":"/pages/pix/create"},{"title":"Buscar PIX","openapi":"GET /pix/get","href":"/pages/pix/get"},{"title":"Listar PIX","openapi":"GET /pix/list","href":"/pages/pix/list"}]},{"group":"Subcontas","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/sub-accounts/reference"},{"title":"Criar subconta","openapi":"POST /sub-accounts/create","href":"/pages/sub-accounts/create"},{"title":"Buscar subconta","openapi":"GET /sub-accounts/get","href":"/pages/sub-accounts/get"},{"title":"Listar subcontas","openapi":"GET /sub-accounts/list","href":"/pages/sub-accounts/list"},{"title":"Sacar da subconta","openapi":"POST /sub-accounts/withdraw","href":"/pages/sub-accounts/withdraw"}]},{"group":"Extrato","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/bank-statement/reference"},{"title":"Listar extrato","openapi":"GET /bank-statement/list","href":"/pages/bank-statement/list"}]},{"group":"Loja","pages":[{"title":"Referência","icon":"store","href":"/pages/store/reference"},{"title":"Obter detalhes da loja","openapi":"GET /stores/get","href":"/pages/store/get"}]},{"group":"Public MRR","pages":[{"title":"Referência","icon":"book-open-cover","href":"/pages/trustMRR/reference"},{"title":"Obter MRR","openapi":"openapi.yaml GET /public-mrr/mrr","href":"/pages/trustMRR/mrr"},{"title":"Obter MRR por Dia","openapi":"openapi.yaml GET /public-mrr/mrr-by-day","href":"/pages/trustMRR/mrr-by-day"},{"title":"Obter Informações do Merchant","openapi":"openapi.yaml GET /public-mrr/merchant-info","href":"/pages/trustMRR/get"},{"title":"Obter Receita por Período","openapi":"openapi.yaml GET /public-mrr/revenue","href":"/pages/trustMRR/list"}]}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/pages/sdks/sdks"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/pages/cli/overview"}]},{"tab":"AI","pages":[{"title":"AI","href":"/pages/ai/overview"}]},{"tab":"Ferramentas","pages":[{"title":"Ferramentas","href":"/pages/ecosystem/ecosystem"}]},{"tab":"Vídeos","pages":[{"title":"Vídeos","href":"/pages/videos"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/pages/changelog"}]}]},{"version":"v1","tag":"Legacy","pages":[{"title":"v1","href":"/pages/v1/introduction"}]}]},"basePath":"","title":"Buscar um checkout de assinatura - AbacatePay","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}