Returns what the checkout page needs to show an invoice: your account’s details, the invoice and the available payment methods. Takes no key; it runs in the payer’s browser.
GET
/
pay
/
{slug}
/
invoices
/
{invoiceID}
Read an invoice at checkout
curl --request GET \ --url https://api-sandbox.beinfi.com/pay/{slug}/invoices/{invoiceID}
Whether the store can receive payments on this path. false until the receiving account at the payment provider is ready: paymentOptions is empty and the checkout tells the payer. Always present.
Authorization to save the card, which the payer must accept. Present only when card is available and the invoice is open. Send version as consentTextVersion when charging with saveInstrument.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Infi","colors":{"primary":"#0A1430","light":"#E2B13C","dark":"#0A1430"},"logo":{"light":"https://mintcdn.com/beinfi/owBheEE6vXSyqXTj/logo/logo.svg?fit=max\u0026auto=format\u0026n=owBheEE6vXSyqXTj\u0026q=85\u0026s=b1b9ce09a8814e42032ef2bf2c08fb54","dark":"https://mintcdn.com/beinfi/owBheEE6vXSyqXTj/logo/logo.svg?fit=max\u0026auto=format\u0026n=owBheEE6vXSyqXTj\u0026q=85\u0026s=b1b9ce09a8814e42032ef2bf2c08fb54","href":"https://beinfi.com"},"favicon":"https://mintcdn.com/beinfi/owBheEE6vXSyqXTj/favicon.svg?fit=max\u0026auto=format\u0026n=owBheEE6vXSyqXTj\u0026q=85\u0026s=cbb3280c14965b007e9662521134e88c","api":{"playground":{"display":"interactive"}},"navbar":{"links":[{"href":"https://app-sandbox.beinfi.com","label":"Sandbox"}],"primary":{"type":"button","label":"Começar","href":"https://app.beinfi.com"}},"footer":{"socials":{"website":"https://beinfi.com"}},"styling":{"latex":true},"navigation":{"languages":[{"language":"pt-BR","default":true,"href":"introducao"},{"language":"en","href":"en/introducao"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"beinfi","hasAudioNarration":false,"actualSubdomain":"beinfi","customDomains":["docs.beinfi.com"],"gitSource":{"type":"github","owner":"be-infinitum","repo":"infi","deployBranch":"main","contentDirectory":"infi-docs","isPrivate":true,"mountPath":"","label":"","_id":"6adfafa06d56e5c194b62908"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae91a58c27bfbde36d8601a","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"pt-BR","tag":"Referência da API","count":72},{"language":"en","tag":"API reference","count":72},{"language":"pt-BR","tag":"Catálogo","count":21},{"language":"en","tag":"Catalog","count":21},{"language":"pt-BR","tag":"Guias","count":17},{"language":"en","tag":"Guides","count":17},{"language":"pt-BR","tag":"Começar","count":13},{"language":"en","tag":"Get started","count":13},{"language":"pt-BR","tag":"Clientes","count":8},{"language":"pt-BR","tag":"Faturas","count":8},{"language":"en","tag":"Customers","count":8},{"language":"en","tag":"Invoices","count":8},{"language":"pt-BR","tag":"Webhooks","count":7},{"language":"en","tag":"Webhooks","count":7},{"language":"pt-BR","tag":"Conta","count":5},{"language":"pt-BR","tag":"Cupons","count":5},{"language":"pt-BR","tag":"Pagamentos","count":5},{"language":"en","tag":"Account","count":5},{"language":"en","tag":"Coupons","count":5},{"language":"en","tag":"Payments","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":false},"customCss":[],"page":{"pagePath":"en/api-reference/checkout/read-an-invoice-at-checkout","slug":"/en/api-reference/checkout/read-an-invoice-at-checkout","pageMetadata":{"title":"Read an invoice at checkout","description":"Returns what the checkout page needs to show an invoice: your account's details, the invoice and the available payment methods. Takes no key; it runs in the payer's browser.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /pay/{slug}/invoices/{invoiceID}","href":"/en/api-reference/checkout/read-an-invoice-at-checkout","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns what the checkout page needs to show an invoice: your account’s details, the invoice and the available payment methods. Takes no key; it runs in the payer’s browser.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Read an invoice at checkout","description":"Returns what the checkout page needs to show an invoice: your account's details, the invoice and the available payment methods. Takes no key; it runs in the payer's browser.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /pay/{slug}/invoices/{invoiceID}","href":"/en/api-reference/checkout/read-an-invoice-at-checkout","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Checkout"],"operationId":"getCheckoutSession","security":[],"parameters":["64bc5e11-3c25-4f36-8d30-dd1dc48095a1","04988349-9f01-40b6-ae12-dba81ef0c56c"],"responses":{"200":"edfd8f6c-c884-4d44-b86f-dd4271bfd706","400":"ad49ae0c-53ec-465c-be60-ebf08cc776d6","404":"7a846c44-0e24-4bb4-918f-082a70bc05a8","429":"c008e4f2-82ed-4914-bf3b-d17e5f0bb7f5"},"summary":"Read an invoice at checkout","description":"Returns what the checkout page needs to show an invoice: your account's details, the invoice and the available payment methods. Takes no key; it runs in the payer's browser.\n","method":"get","type":"path","servers":["32764daa-a0ab-4e11-9cce-071a6d157f12","8926f6ec-3b25-4b18-916e-1427c5952655"],"path":"/pay/{slug}/invoices/{invoiceID}","baseUrlOptions":["https://api-sandbox.beinfi.com","https://api.beinfi.com"],"title":"Read an invoice at checkout","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"64bc5e11-3c25-4f36-8d30-dd1dc48095a1":{"name":"slug","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Your account's public identifier, as in checkout URLs.","uniqueKey":"","typeLabel":"string"},"description":"Your account's public identifier, as in checkout URLs."},"04988349-9f01-40b6-ae12-dba81ef0c56c":{"name":"invoiceID","in":"path","required":true,"schema":{"type":"string","pattern":"^inv_[0-9A-Za-z]{22}$","example":"inv_6yi30EKotIwGHZdePSdsFc","isRequired":true,"description":"Invoice ID.","uniqueKey":"","typeLabel":"string"},"description":"Invoice ID."}},"responses":{"edfd8f6c-c884-4d44-b86f-dd4271bfd706":{"content":{"application/json":{"schema":{"type":"object","required":["merchant","invoice","testMode","paymentOptions","cardEnabled","acceptsPayments"],"properties":{"merchant":{"type":"object","required":["slug","name"],"properties":{"slug":{"type":"string","isRequired":true,"uniqueKey":"merchant.slug","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"merchant.name","typeLabel":"string"},"logoUrl":{"type":"string","format":"uri","uniqueKey":"merchant.logoUrl","typeLabel":"string\u003curi>"}},"description":"Your account's name and look, as the payer sees them.","isRequired":true,"uniqueKey":"merchant","typeLabel":"object"},"invoice":{"type":"object","required":["id","status","currency","subtotal","tax","total","amountDue","createdAt"],"properties":{"id":{"type":"string","pattern":"^inv_[0-9A-Za-z]{22}$","example":"inv_6yi30EKotIwGHZdePSdsFc","isRequired":true,"uniqueKey":"invoice.id","typeLabel":"string"},"status":{"type":"string","enum":["draft","pending","open","paid","void","uncollectible"],"description":"`draft` (being built), `open` (issued, awaiting payment), `paid`, `void` (canceled) or `uncollectible` (written off).","isRequired":true,"uniqueKey":"invoice.status","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","description":"Currency, as an ISO 4217 code (`BRL`).","isRequired":true,"uniqueKey":"invoice.currency","typeLabel":"string"},"subtotal":{"type":"string","description":"Sum of line items before tax and discounts.","isRequired":true,"uniqueKey":"invoice.subtotal","typeLabel":"string"},"tax":{"type":"string","description":"Tax on the invoice.","isRequired":true,"uniqueKey":"invoice.tax","typeLabel":"string"},"total":{"type":"string","description":"The invoice's final amount.","isRequired":true,"uniqueKey":"invoice.total","typeLabel":"string"},"amountDue":{"type":"string","description":"How much is still owed.","isRequired":true,"uniqueKey":"invoice.amountDue","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"invoice.createdAt","typeLabel":"string\u003cdate-time>"},"customerId":{"oneOf":[{"type":"string","format":"uuid","description":"The customer's product enrollment id. Set on product, usage and subscription invoices.","uniqueKey":"invoice.customerId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The customer's product enrollment id. Set on product, usage and subscription invoices.","uniqueKey":"invoice.customerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.customerId","typeLabel":"string\u003cuuid> | null"},"payerId":{"oneOf":[{"type":"string","description":"The paying customer's id. Set on one-off invoices.","pattern":"^cus_[0-9A-Za-z]{22}$","example":"cus_6Tq0Y2rGJ1aQ9zXk3LmPbV","uniqueKey":"invoice.payerId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The paying customer's id. Set on one-off invoices.","uniqueKey":"invoice.payerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.payerId","typeLabel":"string | null"},"subscriptionId":{"oneOf":[{"type":"string","description":"The subscription that generated the invoice","pattern":"^sub_[0-9A-Za-z]{22}$","example":"sub_2Kp7rWqT0aLm4XcVb8NzJe","uniqueKey":"invoice.subscriptionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The subscription that generated the invoice","uniqueKey":"invoice.subscriptionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.subscriptionId","typeLabel":"string | null"},"invoiceNumber":{"oneOf":[{"type":"string","description":"Sequential invoice number","uniqueKey":"invoice.invoiceNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Sequential invoice number","uniqueKey":"invoice.invoiceNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.invoiceNumber","typeLabel":"string | null"},"periodStart":{"oneOf":[{"type":"string","format":"date-time","description":"Start of the billed period","uniqueKey":"invoice.periodStart.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start of the billed period","uniqueKey":"invoice.periodStart.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.periodStart","typeLabel":"string\u003cdate-time> | null"},"periodEnd":{"oneOf":[{"type":"string","format":"date-time","description":"End of the billed period","uniqueKey":"invoice.periodEnd.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End of the billed period","uniqueKey":"invoice.periodEnd.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.periodEnd","typeLabel":"string\u003cdate-time> | null"},"dueDate":{"oneOf":[{"type":"string","format":"date-time","description":"Due date.","uniqueKey":"invoice.dueDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Due date.","uniqueKey":"invoice.dueDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.dueDate","typeLabel":"string\u003cdate-time> | null"},"finalizedAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the invoice was issued.","uniqueKey":"invoice.finalizedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the invoice was issued.","uniqueKey":"invoice.finalizedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.finalizedAt","typeLabel":"string\u003cdate-time> | null"},"paidAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the invoice was paid.","uniqueKey":"invoice.paidAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the invoice was paid.","uniqueKey":"invoice.paidAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.paidAt","typeLabel":"string\u003cdate-time> | null"},"successUrl":{"oneOf":[{"type":"string","description":"Where checkout sends the buyer after payment.","uniqueKey":"invoice.successUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Where checkout sends the buyer after payment.","uniqueKey":"invoice.successUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.successUrl","typeLabel":"string | null"},"cancelUrl":{"oneOf":[{"type":"string","description":"Where checkout sends the buyer if they back out.","uniqueKey":"invoice.cancelUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Where checkout sends the buyer if they back out.","uniqueKey":"invoice.cancelUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.cancelUrl","typeLabel":"string | null"},"lineItems":{"type":"array","items":{"type":"object","required":["id","type","description","quantity","amount","proration"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"invoice.lineItems.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["usage","recurring","proration","credit","adjustment","commitment","manual"],"description":"`usage` (metered usage), `recurring` (recurring fee), `proration` (pro-rata adjustment for a mid-period change), `credit`, `adjustment` (usage that arrived after its period was already invoiced), `commitment` (top-up to the minimum commitment) or `manual` (free-form line).","isRequired":true,"uniqueKey":"invoice.lineItems.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","isRequired":true,"uniqueKey":"invoice.lineItems.items.[INDEX].description","typeLabel":"string"},"quantity":{"type":"string","description":"Quantity billed","isRequired":true,"uniqueKey":"invoice.lineItems.items.[INDEX].quantity","typeLabel":"string"},"amount":{"type":"string","description":"Line total","isRequired":true,"uniqueKey":"invoice.lineItems.items.[INDEX].amount","typeLabel":"string"},"proration":{"type":"boolean","description":"`true` when the line is a pro-rated amount.","isRequired":true,"uniqueKey":"invoice.lineItems.items.[INDEX].proration","typeLabel":"boolean"},"meterId":{"oneOf":[{"type":"string","format":"uuid","description":"The meter the usage came from","uniqueKey":"invoice.lineItems.items.[INDEX].meterId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The meter the usage came from","uniqueKey":"invoice.lineItems.items.[INDEX].meterId.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.lineItems.items.[INDEX].meterId","typeLabel":"string\u003cuuid> | null"},"priceId":{"oneOf":[{"type":"string","format":"uuid","description":"The price applied to this line.","uniqueKey":"invoice.lineItems.items.[INDEX].priceId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The price applied to this line.","uniqueKey":"invoice.lineItems.items.[INDEX].priceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.lineItems.items.[INDEX].priceId","typeLabel":"string\u003cuuid> | null"},"unitPrice":{"oneOf":[{"type":"string","description":"Price per unit","uniqueKey":"invoice.lineItems.items.[INDEX].unitPrice.oneOf.0","typeLabel":"string"},{"type":"null","description":"Price per unit","uniqueKey":"invoice.lineItems.items.[INDEX].unitPrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoice.lineItems.items.[INDEX].unitPrice","typeLabel":"string | null"}},"description":"One line on an invoice.","uniqueKey":"invoice.lineItems.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoice.lineItems","typeLabel":"object[]"}},"description":"What a customer owes: line items, totals and status. Status: `draft` → `open` → `paid`, or `void` / `uncollectible`.","isRequired":true,"uniqueKey":"invoice","typeLabel":"object"},"testMode":{"type":"boolean","description":"`true` when the invoice is in sandbox: no real money moves.","isRequired":true,"uniqueKey":"testMode","typeLabel":"boolean"},"paymentOptions":{"type":"array","items":{"oneOf":[{"type":"object","description":"A payment method the checkout can offer. It is a hint: availability is checked again at charge time.","required":["method","provider","flow"],"properties":{"method":{"type":"string","const":"card","isRequired":true,"uniqueKey":"paymentOptions.items.[INDEX].oneOf.0.method","typeLabel":"string"},"provider":{"type":"string","const":"infi_stripe_uk","isRequired":true,"uniqueKey":"paymentOptions.items.[INDEX].oneOf.0.provider","typeLabel":"string"},"flow":{"type":"string","const":"stripe_elements","isRequired":true,"uniqueKey":"paymentOptions.items.[INDEX].oneOf.0.flow","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"paymentOptions.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A payment method the checkout can offer. It is a hint: availability is checked again at charge time.","required":["method","provider","flow"],"properties":{"method":{"type":"string","const":"pix","isRequired":true,"uniqueKey":"paymentOptions.items.[INDEX].oneOf.1.method","typeLabel":"string"},"provider":{"type":"string","const":"pagarme_pix","isRequired":true,"uniqueKey":"paymentOptions.items.[INDEX].oneOf.1.provider","typeLabel":"string"},"flow":{"type":"string","const":"pix","description":"How the payment is completed in the browser.","isRequired":true,"uniqueKey":"paymentOptions.items.[INDEX].oneOf.1.flow","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"paymentOptions.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A payment method the checkout can offer. It is a hint: availability is checked again at charge time.","required":["method","provider","flow","requiresPayerDetails"],"properties":{"method":{"type":"string","const":"card","isRequired":true,"uniqueKey":"paymentOptions.items.[INDEX].oneOf.2.method","typeLabel":"string"},"provider":{"type":"string","const":"pagarme_card","isRequired":true,"uniqueKey":"paymentOptions.items.[INDEX].oneOf.2.provider","typeLabel":"string"},"flow":{"type":"string","const":"pagarme_core_v5_token","description":"How the payment is completed in the browser.","isRequired":true,"uniqueKey":"paymentOptions.items.[INDEX].oneOf.2.flow","typeLabel":"string"},"requiresPayerDetails":{"type":"boolean","const":true,"isRequired":true,"uniqueKey":"paymentOptions.items.[INDEX].oneOf.2.requiresPayerDetails","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"paymentOptions.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"paymentOptions.items.[INDEX]","typeLabel":"object"},"description":"The payment methods available for this invoice.","isRequired":true,"uniqueKey":"paymentOptions","typeLabel":"object[]"},"cardEnabled":{"type":"boolean","description":"Whether card is available. Derived from `paymentOptions`; always present.","isRequired":true,"uniqueKey":"cardEnabled","typeLabel":"boolean"},"acceptsPayments":{"type":"boolean","description":"Whether the store can receive payments on this path. `false` until the receiving account at the payment provider is ready: `paymentOptions` is empty and the checkout tells the payer. Always present.","isRequired":true,"uniqueKey":"acceptsPayments","typeLabel":"boolean"},"purchase":{"oneOf":[{"type":"object","required":["kind","revision"],"properties":{"kind":{"type":"string","enum":["country_required"],"isRequired":true,"uniqueKey":"purchase.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"revision":{"type":"integer","format":"int64","minimum":0,"isRequired":true,"uniqueKey":"purchase.oneOf.0.revision","typeLabel":"integer\u003cint64>"}},"uniqueKey":"purchase.oneOf.0","typeLabel":"object"},{"type":"object","required":["kind","revision","quoteId","consentDigest","buyerCountry"],"properties":{"kind":{"type":"string","enum":["quoted"],"isRequired":true,"uniqueKey":"purchase.oneOf.1.kind","typeLabel":"enum\u003cstring>"},"revision":{"type":"integer","format":"int64","minimum":1,"isRequired":true,"uniqueKey":"purchase.oneOf.1.revision","typeLabel":"integer\u003cint64>"},"quoteId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"purchase.oneOf.1.quoteId","typeLabel":"string\u003cuuid>"},"consentDigest":{"type":"string","isRequired":true,"uniqueKey":"purchase.oneOf.1.consentDigest","typeLabel":"string"},"buyerCountry":{"type":"string","isRequired":true,"uniqueKey":"purchase.oneOf.1.buyerCountry","typeLabel":"string"},"countryEditable":{"type":"boolean","uniqueKey":"purchase.oneOf.1.countryEditable","typeLabel":"boolean"}},"uniqueKey":"purchase.oneOf.1","typeLabel":"object"},{"type":"object","required":["kind","revision","reason","countryEditable"],"properties":{"kind":{"type":"string","enum":["unavailable"],"isRequired":true,"uniqueKey":"purchase.oneOf.2.kind","typeLabel":"enum\u003cstring>"},"revision":{"type":"integer","format":"int64","minimum":0,"isRequired":true,"uniqueKey":"purchase.oneOf.2.revision","typeLabel":"integer\u003cint64>"},"reason":{"type":"string","isRequired":true,"uniqueKey":"purchase.oneOf.2.reason","typeLabel":"string"},"countryEditable":{"type":"boolean","isRequired":true,"uniqueKey":"purchase.oneOf.2.countryEditable","typeLabel":"boolean"},"buyerCountry":{"type":"string","uniqueKey":"purchase.oneOf.2.buyerCountry","typeLabel":"string"}},"uniqueKey":"purchase.oneOf.2","typeLabel":"object"},{"type":"object","required":["kind","buyerCountry","countryEditable"],"properties":{"kind":{"type":"string","enum":["preserved"],"isRequired":true,"uniqueKey":"purchase.oneOf.3.kind","typeLabel":"enum\u003cstring>"},"buyerCountry":{"type":"string","isRequired":true,"uniqueKey":"purchase.oneOf.3.buyerCountry","typeLabel":"string"},"countryEditable":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"purchase.oneOf.3.countryEditable","typeLabel":"enum\u003cboolean>"},"payment":{"type":"object","required":["id","invoiceId","provider","method","amount","currency","status","createdAt","switchable"],"properties":{"id":{"type":"string","pattern":"^pay_[0-9A-Za-z]{22}$","example":"pay_585vbbvnwDyuyeA3MTOitd","isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.id","typeLabel":"string"},"invoiceId":{"type":"string","pattern":"^inv_[0-9A-Za-z]{22}$","example":"inv_6yi30EKotIwGHZdePSdsFc","isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.invoiceId","typeLabel":"string"},"provider":{"type":"string","description":"The processor the charge ran through. In sandbox, `sandbox`.","isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.provider","typeLabel":"string"},"method":{"type":"string","enum":["pix","card"],"isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.method","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","description":"Amount charged, as a decimal string.","isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.amount","typeLabel":"string"},"currency":{"type":"string","isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.currency","typeLabel":"string"},"status":{"type":"string","enum":["pending","confirmed","failed","refunded","charged_back"],"description":"`pending` awaits payment; `confirmed` was paid; `failed` was not paid (see `failureCode`); `refunded` was fully refunded; `charged_back` was disputed by the buyer with their bank.","isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.createdAt","typeLabel":"string\u003cdate-time>"},"switchable":{"type":"boolean","description":"Whether this charge can still be dropped so the same invoice is paid another way: `true` while `pending`, `false` once paid or failed. Present only on the charge-creation response; treat a missing value as `false`.","isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.switchable","typeLabel":"boolean"},"providerId":{"oneOf":[{"type":"string","description":"The charge's reference at the processor, useful for support.","uniqueKey":"purchase.oneOf.3.payment.providerId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The charge's reference at the processor, useful for support.","uniqueKey":"purchase.oneOf.3.payment.providerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.3.payment.providerId","typeLabel":"string | null"},"refundedAmount":{"type":"string","description":"Total refunded so far, as a decimal string. Absent when nothing was refunded. A partial refund keeps `status` at `confirmed`; only refunding the full amount sets `refunded`. Use this field, not `status`, to know how much went back.","uniqueKey":"purchase.oneOf.3.payment.refundedAmount","typeLabel":"string"},"failureCode":{"oneOf":[{"type":"string","enum":["insufficient_funds","do_not_honor","card_declined","authentication_required","card_expired","card_stolen","card_invalid","mandate_revoked","mandate_refused","brand_changed","provider_error","provider_timeout","superseded",null],"description":"Why the charge failed. `superseded` is not a decline: the buyer switched payment method to pay the same invoice. Null when the payment did not fail or when no reason was recorded. New codes may appear; treat an unknown value as a generic failure.","uniqueKey":"purchase.oneOf.3.payment.failureCode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["insufficient_funds","do_not_honor","card_declined","authentication_required","card_expired","card_stolen","card_invalid","mandate_revoked","mandate_refused","brand_changed","provider_error","provider_timeout","superseded",null],"description":"Why the charge failed. `superseded` is not a decline: the buyer switched payment method to pay the same invoice. Null when the payment did not fail or when no reason was recorded. New codes may appear; treat an unknown value as a generic failure.","uniqueKey":"purchase.oneOf.3.payment.failureCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.3.payment.failureCode","typeLabel":"enum\u003cstring> | null"},"failedAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the charge moved to `failed`.","uniqueKey":"purchase.oneOf.3.payment.failedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the charge moved to `failed`.","uniqueKey":"purchase.oneOf.3.payment.failedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.3.payment.failedAt","typeLabel":"string\u003cdate-time> | null"},"payer":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","pattern":"^cus_[0-9A-Za-z]{22}$","example":"cus_6Tq0Y2rGJ1aQ9zXk3LmPbV","uniqueKey":"purchase.oneOf.3.payment.payer.oneOf.0.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","uniqueKey":"purchase.oneOf.3.payment.payer.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"purchase.oneOf.3.payment.payer.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.3.payment.payer.oneOf.0.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"purchase.oneOf.3.payment.payer.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"purchase.oneOf.3.payment.payer.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.3.payment.payer.oneOf.0.email","typeLabel":"string | null"}},"description":"Who paid. On a one-off invoice, `id` is the customer ID; on a subscription invoice, it is the ID of the customer's enrollment in the product. Present only on `GET /billing/payments` and `GET /billing/payments/{paymentID}`, and null when the invoice does not identify the customer.","uniqueKey":"purchase.oneOf.3.payment.payer.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","pattern":"^cus_[0-9A-Za-z]{22}$","example":"cus_6Tq0Y2rGJ1aQ9zXk3LmPbV"},"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"email":{"oneOf":[{"type":"string"},{"type":"null"}]}},"description":"Who paid. On a one-off invoice, `id` is the customer ID; on a subscription invoice, it is the ID of the customer's enrollment in the product. Present only on `GET /billing/payments` and `GET /billing/payments/{paymentID}`, and null when the invoice does not identify the customer.","uniqueKey":"purchase.oneOf.3.payment.payer.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.3.payment.payer","typeLabel":"object | null"},"invoiceUrl":{"type":"string","description":"Hosted payment page. Present only on the charge-creation response.","uniqueKey":"purchase.oneOf.3.payment.invoiceUrl","typeLabel":"string"},"pixPayload":{"type":"string","description":"Pix copy-and-paste code. Render the QR from it. Still available on later reads of the payment.","uniqueKey":"purchase.oneOf.3.payment.pixPayload","typeLabel":"string"},"pixQrImage":{"type":"string","description":"The Pix QR as a base64 PNG (no `data:` prefix), if you would rather not render it yourself.","uniqueKey":"purchase.oneOf.3.payment.pixQrImage","typeLabel":"string"},"pixExpiresAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the Pix code expires (Pix charges only).","uniqueKey":"purchase.oneOf.3.payment.pixExpiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the Pix code expires (Pix charges only).","uniqueKey":"purchase.oneOf.3.payment.pixExpiresAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.3.payment.pixExpiresAt","typeLabel":"string\u003cdate-time> | null"},"checkoutAction":{"type":"object","required":["kind","paymentId","clientSecret","publishableKey"],"properties":{"kind":{"type":"string","enum":["stripe_checkout_elements"],"isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.checkoutAction.kind","typeLabel":"enum\u003cstring>"},"paymentId":{"type":"string","pattern":"^pay_[0-9A-Za-z]{22}$","example":"pay_585vbbvnwDyuyeA3MTOitd","isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.checkoutAction.paymentId","typeLabel":"string"},"clientSecret":{"type":"string","isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.checkoutAction.clientSecret","typeLabel":"string"},"publishableKey":{"type":"string","isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.checkoutAction.publishableKey","typeLabel":"string"},"expiresAt":{"type":"string","format":"date-time","uniqueKey":"purchase.oneOf.3.payment.checkoutAction.expiresAt","typeLabel":"string\u003cdate-time>"},"mode":{"type":"string","enum":["payment","setup"],"uniqueKey":"purchase.oneOf.3.payment.checkoutAction.mode","typeLabel":"enum\u003cstring>"},"mandate":{"type":"object","required":["version","text"],"properties":{"version":{"type":"string","isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.checkoutAction.mandate.version","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"purchase.oneOf.3.payment.checkoutAction.mandate.text","typeLabel":"string"}},"uniqueKey":"purchase.oneOf.3.payment.checkoutAction.mandate","typeLabel":"object"}},"description":"What is needed to mount a card payment on an international sale through BEINFI LTD. Coming soon.","uniqueKey":"purchase.oneOf.3.payment.checkoutAction","typeLabel":"object"}},"description":"One charge attempt against an invoice. An invoice can have several payments.","uniqueKey":"purchase.oneOf.3.payment","typeLabel":"object"}},"uniqueKey":"purchase.oneOf.3","typeLabel":"object"}],"uniqueKey":"purchase","typeLabel":"object"},"legalSeller":{"type":"object","additionalProperties":false,"required":["name","country"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"legalSeller.name","typeLabel":"string"},"country":{"type":"string","example":"GB","isRequired":true,"uniqueKey":"legalSeller.country","typeLabel":"string"}},"description":"The merchant of record on an international sale. Coming soon.","uniqueKey":"legalSeller","typeLabel":"object"},"totals":{"type":"object","additionalProperties":false,"required":["currency","subtotal","tax","total","finality"],"properties":{"currency":{"type":"string","isRequired":true,"uniqueKey":"totals.currency","typeLabel":"string"},"subtotal":{"type":"string","isRequired":true,"uniqueKey":"totals.subtotal","typeLabel":"string"},"tax":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"totals.tax.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"totals.tax.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"totals.tax","typeLabel":"string | null"},"total":{"type":"string","isRequired":true,"uniqueKey":"totals.total","typeLabel":"string"},"finality":{"type":"string","enum":["provisional","final"],"isRequired":true,"uniqueKey":"totals.finality","typeLabel":"enum\u003cstring>"},"buyerCountry":{"type":"string","uniqueKey":"totals.buyerCountry","typeLabel":"string"}},"uniqueKey":"totals","typeLabel":"object"},"autoTopupAvailable":{"type":"boolean","uniqueKey":"autoTopupAvailable","typeLabel":"boolean"},"withdrawalWaiver":{"type":"object","required":["version","text"],"properties":{"version":{"type":"string","example":"wd-v1","isRequired":true,"uniqueKey":"withdrawalWaiver.version","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"withdrawalWaiver.text","typeLabel":"string"}},"uniqueKey":"withdrawalWaiver","typeLabel":"object"},"unavailableReason":{"type":"string","enum":["product_not_available","buyer_country_required","supplier_country_required","supplier_country_conflict","domestic_payments_unavailable","collection_unavailable","country_mismatch","invoice_not_payable","direct_collection_reconciliation_required"],"uniqueKey":"unavailableReason","typeLabel":"enum\u003cstring>"},"paymentMethod":{"type":"string","enum":["pix","card"],"description":"Method of the confirmed payment. Present only once the invoice is paid.","uniqueKey":"paymentMethod","typeLabel":"enum\u003cstring>"},"mandate":{"type":"object","required":["version","text"],"properties":{"version":{"type":"string","isRequired":true,"uniqueKey":"mandate.version","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"mandate.text","typeLabel":"string"}},"description":"Authorization to save the card, which the payer must accept. Present only when card is available and the invoice is open. Send `version` as `consentTextVersion` when charging with `saveInstrument`.","uniqueKey":"mandate","typeLabel":"object"},"remember":{"type":"object","required":["version","text"],"properties":{"version":{"type":"string","isRequired":true,"uniqueKey":"remember.version","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"remember.text","typeLabel":"string"}},"uniqueKey":"remember","typeLabel":"object"}},"description":"What the checkout page receives to show and charge an invoice.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"merchant":{"slug":"\u003cstring>","name":"\u003cstring>","logoUrl":"\u003cstring>"},"invoice":{"id":"inv_6yi30EKotIwGHZdePSdsFc","status":"draft","currency":"\u003cstring>","subtotal":"\u003cstring>","tax":"\u003cstring>","total":"\u003cstring>","amountDue":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","customerId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","payerId":"cus_6Tq0Y2rGJ1aQ9zXk3LmPbV","subscriptionId":"sub_2Kp7rWqT0aLm4XcVb8NzJe","invoiceNumber":"\u003cstring>","periodStart":"2023-11-07T05:31:56Z","periodEnd":"2023-11-07T05:31:56Z","dueDate":"2023-11-07T05:31:56Z","finalizedAt":"2023-11-07T05:31:56Z","paidAt":"2023-11-07T05:31:56Z","successUrl":"\u003cstring>","cancelUrl":"\u003cstring>","lineItems":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"usage","description":"\u003cstring>","quantity":"\u003cstring>","amount":"\u003cstring>","proration":true,"meterId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","priceId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","unitPrice":"\u003cstring>"}]},"testMode":true,"paymentOptions":[{"method":"card","provider":"infi_stripe_uk","flow":"stripe_elements"}],"cardEnabled":true,"acceptsPayments":true,"purchase":{"kind":"country_required","revision":1},"legalSeller":{"name":"\u003cstring>","country":"GB"},"totals":{"currency":"\u003cstring>","subtotal":"\u003cstring>","tax":"\u003cstring>","total":"\u003cstring>","finality":"provisional","buyerCountry":"\u003cstring>"},"autoTopupAvailable":true,"withdrawalWaiver":{"version":"wd-v1","text":"\u003cstring>"},"unavailableReason":"product_not_available","paymentMethod":"pix","mandate":{"version":"\u003cstring>","text":"\u003cstring>"},"remember":{"version":"\u003cstring>","text":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"The invoice and payment options.","exampleType":"generated"},"ad49ae0c-53ec-465c-be60-ebf08cc776d6":{"content":{"application/json":{"schema":{"type":"object","required":["message","error_code","tracer_id"],"properties":{"message":{"type":"string","description":"Human-readable sentence.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","examples":["internal_error","validation_failed","bad_request","unauthorized","forbidden","not_found","conflict","rate_limited"],"description":"Stable error code. Branch on it.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"tracer_id":{"type":"string","description":"Request id. Include it when contacting support.","isRequired":true,"uniqueKey":"tracer_id","typeLabel":"string"}},"description":"The standard error body. It is flat (no `error` wrapper) and the trace id is `tracer_id`.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error_code":"internal_error","tracer_id":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Malformed request.","exampleType":"generated"},"7a846c44-0e24-4bb4-918f-082a70bc05a8":{"content":{"application/json":{"schema":{"type":"object","required":["message","error_code","tracer_id","resource"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","examples":["internal_error","validation_failed","bad_request","unauthorized","forbidden","not_found","conflict","rate_limited"],"description":"Stable error code. The list is open: besides the generic codes, each area defines its own (`coupon_expired`, `insufficient_balance`, `version_not_draft`, `idempotency_key_reused`…). Handle a code you do not recognize by its HTTP status and show `message`; do not fail parsing the response.","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"tracer_id":{"type":"string","isRequired":true,"uniqueKey":"tracer_id","typeLabel":"string"},"resource":{"type":"string","isRequired":true,"uniqueKey":"resource","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error_code":"internal_error","tracer_id":"\u003cstring>","resource":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Resource not found.","exampleType":"generated"},"c008e4f2-82ed-4914-bf3b-d17e5f0bb7f5":{"headers":{"Retry-After":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","examples":["internal_error","validation_failed","bad_request","unauthorized","forbidden","not_found","conflict","rate_limited"],"description":"Stable error code. The list is open: besides the generic codes, each area defines its own (`coupon_expired`, `insufficient_balance`, `version_not_draft`, `idempotency_key_reused`…). Handle a code you do not recognize by its HTTP status and show `message`; do not fail parsing the response.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"internal_error","message":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Rate limit exceeded. `Retry-After` gives the wait in seconds.","exampleType":"generated"}},"security":{},"servers":{"32764daa-a0ab-4e11-9cce-071a6d157f12":{"url":"https://api-sandbox.beinfi.com","description":"Sandbox"},"8926f6ec-3b25-4b18-916e-1427c5952655":{"url":"https://api.beinfi.com","description":"Production"}}},"originalFileLocation":"api-reference/openapi.en.json"},"subdomain":"beinfi","siteName":"Infi","title":"Read an invoice at checkout - Infi","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/introducao","matchLevel":4},"en":{"href":"/en/api-reference/checkout/read-an-invoice-at-checkout","matchLevel":0}}},"lastModified":"2026-11-02T23:19:06.824Z","originalFileLocation":"en/api-reference/checkout/read-an-invoice-at-checkout.mdx","locale":"en"},"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=\"Returns what the checkout page needs to show an invoice: your account\u0026#x27;s details, the invoice and the available payment methods. Takes no key; it runs in the payer\u0026#x27;s browser.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Infi\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_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/beinfi/6L9ijlDVcq5aSfgL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read an invoice at checkout - Infi\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns what the checkout page needs to show an invoice: your account\u0026#x27;s details, the invoice and the available payment methods. Takes no key; it runs in the payer\u0026#x27;s browser.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Infi\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.beinfi.com/en/api-reference/checkout/read-an-invoice-at-checkout\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://beinfi.mintlify.site/_mintlify/api/og/v2?division=Checkout\u0026amp;title=Read+an+invoice+at+checkout\u0026amp;description=Returns+what+the+checkout+page+needs+to+show+an+invoice%3A+your+account%27s+details%2C+the+invoice+and+the+available+payment+methods.+Takes+no+key%3B+it+runs+in+the+pay\u0026amp;theme=0f1e10ebee4743982aba108c\u0026amp;signature=a8aed90a851be725fd08b8477a3dbb6bbbbf1556027a7f9c5e451cb460841778\">\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=\"Read an invoice at checkout - Infi\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns what the checkout page needs to show an invoice: your account\u0026#x27;s details, the invoice and the available payment methods. Takes no key; it runs in the payer\u0026#x27;s browser.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://beinfi.mintlify.site/_mintlify/api/og/v2?division=Checkout\u0026amp;title=Read+an+invoice+at+checkout\u0026amp;description=Returns+what+the+checkout+page+needs+to+show+an+invoice%3A+your+account%27s+details%2C+the+invoice+and+the+available+payment+methods.+Takes+no+key%3B+it+runs+in+the+pay\u0026amp;theme=0f1e10ebee4743982aba108c\u0026amp;signature=a8aed90a851be725fd08b8477a3dbb6bbbbf1556027a7f9c5e451cb460841778\">\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/beinfi/6L9ijlDVcq5aSfgL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Infi\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A1430\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.beinfi.com/en/api-reference/checkout/read-an-invoice-at-checkout\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/checkout/read-an-invoice-at-checkout.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.beinfi.com/#organization\",\"name\":\"Infi\",\"url\":\"https://docs.beinfi.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/beinfi/owBheEE6vXSyqXTj/logo/logo.svg?fit=max\u0026auto=format\u0026n=owBheEE6vXSyqXTj\u0026q=85\u0026s=b1b9ce09a8814e42032ef2bf2c08fb54\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.beinfi.com#website\",\"name\":\"Infi\",\"url\":\"https://docs.beinfi.com\",\"publisher\":{\"@id\":\"https://docs.beinfi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.beinfi.com/en/api-reference/checkout/read-an-invoice-at-checkout#webpage\",\"url\":\"https://docs.beinfi.com/en/api-reference/checkout/read-an-invoice-at-checkout\",\"name\":\"Read an invoice at checkout\",\"description\":\"Returns what the checkout page needs to show an invoice: your account's details, the invoice and the available payment methods. Takes no key; it runs in the payer's browser.\",\"dateModified\":\"2026-11-02T23:19:06.824Z\",\"isPartOf\":{\"@id\":\"https://docs.beinfi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.beinfi.com/en/api-reference/checkout/read-an-invoice-at-checkout#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.beinfi.com/en/api-reference/checkout/read-an-invoice-at-checkout#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Infi\",\"item\":\"https://docs.beinfi.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Read an invoice at checkout\",\"item\":\"https://docs.beinfi.com/en/api-reference/checkout/read-an-invoice-at-checkout\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.beinfi.com/en/api-reference/checkout/read-an-invoice-at-checkout#apireference\",\"headline\":\"Read an invoice at checkout\",\"name\":\"Read an invoice at checkout\",\"description\":\"Returns what the checkout page needs to show an invoice: your account's details, the invoice and the available payment methods. Takes no key; it runs in the payer's browser.\",\"url\":\"https://docs.beinfi.com/en/api-reference/checkout/read-an-invoice-at-checkout\",\"mainEntityOfPage\":{\"@id\":\"https://docs.beinfi.com/en/api-reference/checkout/read-an-invoice-at-checkout#webpage\"},\"dateModified\":\"2026-11-02T23:19:06.824Z\",\"publisher\":{\"@id\":\"https://docs.beinfi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.beinfi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Infi\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Infi","nav":{"global":null,"languages":[{"language":"pt-BR","default":true,"pages":[{"title":"pt-BR","href":"/introducao"}]},{"language":"en","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/en/introducao"}]},{"tab":"API reference","groups":[{"group":"Checkout","pages":[{"title":"Read an invoice at checkout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /pay/{slug}/invoices/{invoiceID}","href":"/en/api-reference/checkout/read-an-invoice-at-checkout"},{"title":"Pay an invoice at checkout","description":"Creates a charge on an open invoice using the method the payer picked: `pix` or `card` (single payment), both in test environment. `boleto` is coming soon. The response carries what the payer needs to finish, such as the Pix QR code. Confirmation comes later: poll the payment status or wait for the `payment.confirmed` webhook.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /pay/{slug}/invoices/{invoiceID}/charge","href":"/en/api-reference/checkout/pay-an-invoice-at-checkout"},{"title":"Apply a coupon to an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /pay/{slug}/invoices/{invoiceID}/coupon","href":"/en/api-reference/checkout/apply-a-coupon-to-an-invoice"},{"title":"Download a digital product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /pay/{slug}/download/{token}","href":"/en/api-reference/checkout/download-a-digital-product"}]},{"group":"Test account","pages":[{"title":"Create a test account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /public/v1/claimables","href":"/en/api-reference/test-account/create-a-test-account"},{"title":"Get a test account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /public/v1/claimables/{claimableID}","href":"/en/api-reference/test-account/get-a-test-account"}]},{"group":"Catalog","pages":[{"title":"Prepare an image upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /catalog/images/presign","href":"/en/api-reference/catalog/prepare-an-image-upload"},{"title":"List products","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products","href":"/en/api-reference/catalog/list-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products","href":"/en/api-reference/catalog/create-a-product"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products/{productID}","href":"/en/api-reference/catalog/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json patch /products/{productID}","href":"/en/api-reference/catalog/update-a-product"},{"title":"List product versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products/{productID}/versions","href":"/en/api-reference/catalog/list-product-versions"},{"title":"Create a new version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/versions","href":"/en/api-reference/catalog/create-a-new-version"},{"title":"Publish a version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/versions/{versionID}/publish","href":"/en/api-reference/catalog/publish-a-version"},{"title":"List a version's prices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products/{productID}/versions/{versionID}/prices","href":"/en/api-reference/catalog/list-a-versions-prices"},{"title":"Add a price to a version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/versions/{versionID}/prices","href":"/en/api-reference/catalog/add-a-price-to-a-version"},{"title":"List a product's meters","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products/{productID}/meters","href":"/en/api-reference/catalog/list-a-products-meters"},{"title":"Create a meter","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/meters","href":"/en/api-reference/catalog/create-a-meter"},{"title":"Create a link with a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /payment-links","href":"/en/api-reference/catalog/create-a-link-with-a-product"},{"title":"List a product's links","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products/{productID}/payment-links","href":"/en/api-reference/catalog/list-a-products-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/payment-links","href":"/en/api-reference/catalog/create-a-payment-link"},{"title":"Revoke a payment link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /products/{productID}/payment-links/{linkID}","href":"/en/api-reference/catalog/revoke-a-payment-link"},{"title":"Update a meter","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json patch /products/{productID}/meters/{meterID}","href":"/en/api-reference/catalog/update-a-meter"},{"title":"Get a file upload URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/deliverable/presign","href":"/en/api-reference/catalog/get-a-file-upload-url"},{"title":"Get the deliverable","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /products/{productID}/deliverable","href":"/en/api-reference/catalog/get-the-deliverable"},{"title":"Save the deliverable","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json put /products/{productID}/deliverable","href":"/en/api-reference/catalog/save-the-deliverable"},{"title":"Delete the deliverable","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /products/{productID}/deliverable","href":"/en/api-reference/catalog/delete-the-deliverable"}]},{"group":"Customers","pages":[{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /customers","href":"/en/api-reference/customers/create-a-customer"},{"title":"Enroll a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /products/{productID}/customers","href":"/en/api-reference/customers/enroll-a-customer"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /customers/{customerID}","href":"/en/api-reference/customers/get-a-customer"},{"title":"Get customer state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /customers/{customerID}/state","href":"/en/api-reference/customers/get-customer-state"},{"title":"Get balances","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /customers/{customerID}/wallet","href":"/en/api-reference/customers/get-balances"},{"title":"List customer rate cards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /customers/{customerID}/rate-cards","href":"/en/api-reference/customers/list-customer-rate-cards"},{"title":"Set a customer rate card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /customers/{customerID}/rate-cards","href":"/en/api-reference/customers/set-a-customer-rate-card"},{"title":"Delete a customer rate card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /customers/{customerID}/rate-cards/{rateCardID}","href":"/en/api-reference/customers/delete-a-customer-rate-card"}]},{"group":"Metering","pages":[{"title":"Record a usage event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /metering/events","href":"/en/api-reference/metering/record-a-usage-event"},{"title":"Record usage events in batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /metering/events/batch","href":"/en/api-reference/metering/record-usage-events-in-batch"},{"title":"Get customer usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /metering/usage","href":"/en/api-reference/metering/get-customer-usage"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/invoices","href":"/en/api-reference/invoices/list-invoices"},{"title":"Create a one-off invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/invoices","href":"/en/api-reference/invoices/create-a-one-off-invoice"},{"title":"Invoice accrued usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/invoices/from-usage","href":"/en/api-reference/invoices/invoice-accrued-usage"},{"title":"Sell a product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/products/{productID}/invoices","href":"/en/api-reference/invoices/sell-a-product"},{"title":"Invoice the current period","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/subscriptions/{subscriptionID}/invoices","href":"/en/api-reference/invoices/invoice-the-current-period"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/invoices/{invoiceID}","href":"/en/api-reference/invoices/get-an-invoice"},{"title":"Email an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/invoices/{invoiceID}/send","href":"/en/api-reference/invoices/email-an-invoice"},{"title":"Void an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/invoices/{invoiceID}/void","href":"/en/api-reference/invoices/void-an-invoice"}]},{"group":"Payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/payments","href":"/en/api-reference/payments/list-payments"},{"title":"List an invoice's payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/invoices/{invoiceID}/payments","href":"/en/api-reference/payments/list-an-invoices-payments"},{"title":"Get a payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/payments/{paymentID}","href":"/en/api-reference/payments/get-a-payment"},{"title":"Refund a payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/payments/{paymentID}/refund","href":"/en/api-reference/payments/refund-a-payment"},{"title":"List a payment's refunds","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/payments/{paymentID}/refunds","href":"/en/api-reference/payments/list-a-payments-refunds"}]},{"group":"Subscriptions","pages":[{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/products/{productID}/subscriptions","href":"/en/api-reference/subscriptions/create-a-subscription"},{"title":"List an enrollment's subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/customers/{customerID}/subscriptions","href":"/en/api-reference/subscriptions/list-an-enrollments-subscriptions"},{"title":"Get a subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/subscriptions/{subscriptionID}","href":"/en/api-reference/subscriptions/get-a-subscription"}]},{"group":"Billing","pages":[{"title":"List invoice download links","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/invoices/{invoiceID}/deliverable","href":"/en/api-reference/billing/list-invoice-download-links"}]},{"group":"Coupons","pages":[{"title":"List coupons","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/coupons","href":"/en/api-reference/coupons/list-coupons"},{"title":"Create a coupon","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /billing/coupons","href":"/en/api-reference/coupons/create-a-coupon"},{"title":"Get a coupon","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /billing/coupons/{couponID}","href":"/en/api-reference/coupons/get-a-coupon"},{"title":"Delete a coupon","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /billing/coupons/{couponID}","href":"/en/api-reference/coupons/delete-a-coupon"},{"title":"Activate or archive a coupon","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json patch /billing/coupons/{couponID}","href":"/en/api-reference/coupons/activate-or-archive-a-coupon"}]},{"group":"Account","pages":[{"title":"Get your account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /account/tenant","href":"/en/api-reference/account/get-your-account"},{"title":"Update your account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json patch /account/tenant","href":"/en/api-reference/account/update-your-account"},{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /account/api-keys","href":"/en/api-reference/account/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /account/api-keys","href":"/en/api-reference/account/create-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /account/api-keys/{keyID}","href":"/en/api-reference/account/revoke-an-api-key"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /account/webhooks","href":"/en/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /account/webhooks","href":"/en/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /account/webhooks/deliveries","href":"/en/api-reference/webhooks/list-webhook-deliveries"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /account/webhooks/{endpointID}","href":"/en/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /account/webhooks/{endpointID}","href":"/en/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json patch /account/webhooks/{endpointID}","href":"/en/api-reference/webhooks/update-a-webhook"},{"title":"Rotate a webhook secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /account/webhooks/{endpointID}/rotate-secret","href":"/en/api-reference/webhooks/rotate-a-webhook-secret"}]}]}]}]},"basePath":"","title":"Read an invoice at checkout - Infi","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}