You can generate a Personal Access Token from your settings.
Scopes
payments:read
pat
payments:read
oat
Query Parameters
organization_id
string<uuid4>string<uuid4>[]
Filter by organization ID.
The organization ID.
Example:
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
checkout_id
string<uuid4>string<uuid4>[]
Filter by checkout ID.
order_id
string<uuid4>string<uuid4>[]
Filter by order ID.
customer_id
string<uuid4>string<uuid4>[]
Filter by customer ID.
The customer ID.
status
enum<string>enum<string>[]
Filter by payment status.
Available options:
pending,
succeeded,
failed
method
stringstring[]
Filter by payment method.
customer_email
stringstring[]
Filter by customer email.
page
integer
default:1
Page number, defaults to 1.
limit
integer
default:10
Size of a page, defaults to 10. Maximum is 100.
sorting
enum<string>[] | null
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Polar","description":"Payments \u0026 Billing with 6 lines of code. Open Source \u0026 Global Merchant of Record.","colors":{"primary":"#000","light":"#fff","dark":"#000"},"logo":{"light":"https://mintcdn.com/polar/4USyJwN59kbPHT7o/logo/light.png?fit=max\u0026auto=format\u0026n=4USyJwN59kbPHT7o\u0026q=85\u0026s=e950d8c7839bea573a30b2b2f26b279e","dark":"https://mintcdn.com/polar/4USyJwN59kbPHT7o/logo/dark.png?fit=max\u0026auto=format\u0026n=4USyJwN59kbPHT7o\u0026q=85\u0026s=0cb4a91e4d18beb58a8a8ca4dd31e2bc","href":"https://polar.sh"},"favicon":"https://mintcdn.com/polar/4USyJwN59kbPHT7o/logo/favicon.png?fit=max\u0026auto=format\u0026n=4USyJwN59kbPHT7o\u0026q=85\u0026s=0cc6bd7c8b4641686d063d38f2d95c29","appearance":{"default":"system"},"background":{"color":{"dark":"#131316"}},"navbar":{"links":[{"href":"https://polar.sh/docs/llms-full.txt","label":"llms-full.txt"},{"href":"https://polar.sh/docs/support","label":"Contact support"}],"primary":{"type":"button","label":"Dashboard","href":"https://polar.sh"}},"footer":{"socials":{"x":"https://x.com/polar_sh","github":"https://github.com/polarsource/polar","discord":"https://dub.sh/polar-discord"}},"seo":{"metatags":{"og:site_name":"Polar","og:image":"https://polar.sh/assets/brand/polar_og.jpg","og:type":"website","twitter:card":"summary_large_image","twitter:site":"@polar_sh"}},"styling":{"latex":false},"integrations":{"ga4":{"measurementId":"G-MBYW1QZFHE"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"polar","hasAudioNarration":false,"actualSubdomain":"polar","customDomains":["polar.sh","buy.polar.sh","sandbox.polar.sh","vcpypolar.xyz"],"gitSource":{"type":"github","owner":"polarsource","repo":"polar","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"edits":true,"thumbs":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af86111d49d28f986f25145","clientVersion":"0.0.4142","searchFilterCounts":[{"language":"default","tag":"API Reference","count":651},{"language":"default","tag":"Core API","count":344},{"language":"default","tag":"Customer Portal API","count":132},{"language":"default","tag":"Webhook Events","count":117},{"language":"default","tag":"Billing Events","count":81},{"language":"default","tag":"Subscriptions","count":65},{"language":"default","tag":"Documentation","count":64},{"language":"default","tag":"Orders","count":57},{"language":"default","tag":"Developer Resources","count":53},{"language":"default","tag":"Integrations","count":52}]},"assistantConfig":{"deflection":{"enabled":true,"email":"[email protected]"}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".dark\\:bg-background-dark:is(.dark *),.chat-assistant-floating-input:is(.dark *)::before{background-color:#070708}#content-area{max-width:48rem}.migration-coexistence{--migration-columns: 42% 16% 42%;--migration-line: #d4d4d8;--migration-dot: #71717a;margin:2rem 0;padding:1.5rem;color:#18181b;background:#ffffff;border:1px solid #e4e4e7;border-radius:1.25rem}.migration-coexistence__tree{max-width:28rem;margin:0 auto}.migration-coexistence__node{padding:0.75rem 0.875rem;background:#fafafa;border:1px solid #e4e4e7;border-radius:0.875rem}.migration-coexistence__node--app{max-width:14rem;margin:0 auto;text-align:center}.migration-coexistence__node--stripe{border-top:2px solid #635bff}.migration-coexistence__node--polar{border-top:2px solid #18181b}.migration-coexistence__name{display:block;color:#18181b;font-size:0.8125rem;font-weight:700}.migration-coexistence__note{display:block;margin-top:0.125rem;color:#71717a;font-size:0.75rem}.migration-coexistence__branch{display:block;width:100%;aspect-ratio:100 / 12;overflow:visible}.migration-coexistence__rail{fill:none;stroke:var(--migration-line);stroke-dasharray:4 4;stroke-width:1}.migration-coexistence__dot{fill:var(--migration-dot)}.migration-coexistence__children{display:grid;grid-template-columns:var(--migration-columns)}.migration-coexistence__caption{max-width:32rem;margin:1.25rem auto 0;color:#52525b;font-size:0.875rem;line-height:1.55;text-align:center}.migration-switch{margin:1.5rem 0;overflow:hidden;background:#ffffff;border:1px solid #e4e4e7;border-radius:1rem}.migration-switch__header,.migration-switch__row{display:grid;grid-template-columns:minmax(0, 1fr) 3.5rem minmax(0, 1fr);align-items:center}.migration-switch__header{padding:0.75rem 1rem;background:#fafafa;border-bottom:1px solid #e4e4e7;color:#18181b;font-size:0.8125rem;font-weight:700}.migration-switch__header span:nth-child(2){color:#71717a;font-size:0.6875rem;font-weight:600;letter-spacing:0.06em;text-align:center;text-transform:uppercase}.migration-switch__header span:last-child{text-align:right}.migration-switch__row{min-height:4rem;padding:0.75rem 1rem;color:#52525b;font-size:0.8125rem}.migration-switch__row+.migration-switch__row{border-top:1px solid #f4f4f5}.migration-switch__arrow{display:grid;width:1.75rem;height:1.75rem;margin:0 auto;place-items:center;color:#52525b;background:#f4f4f5;border-radius:999px}.migration-switch__state--polar{color:#18181b;font-weight:600;text-align:right}.dark .migration-coexistence{--migration-line: #52525b;--migration-dot: #a1a1aa;color:#fafafa;background:#131316;border-color:#3f3f46}.dark .migration-coexistence__node{background:#18181b;border-color:#3f3f46}.dark .migration-coexistence__node--stripe{border-top-color:#635bff}.dark .migration-coexistence__node--polar{border-top-color:#fafafa}.dark .migration-coexistence__name{color:#fafafa}.dark .migration-coexistence__note,.dark .migration-coexistence__caption{color:#a1a1aa}.dark .migration-switch{background:#131316;border-color:#3f3f46}.dark .migration-switch__header{color:#fafafa;background:#18181b;border-bottom-color:#3f3f46}.dark .migration-switch__header span:nth-child(2),.dark .migration-switch__row{color:#a1a1aa}.dark .migration-switch__row+.migration-switch__row{border-top-color:#27272a}.dark .migration-switch__arrow{color:#d4d4d8;background:#27272a}.dark .migration-switch__state--polar{color:#fafafa}@media (max-width: 42rem){.migration-coexistence{padding:1.125rem}.migration-coexistence__node--app{max-width:none}.migration-coexistence__caption{font-size:0.8125rem}.migration-switch__header,.migration-switch__row{grid-template-columns:minmax(0, 1fr) 2.5rem minmax(0, 1fr)}.migration-switch__header,.migration-switch__row{padding-right:0.75rem;padding-left:0.75rem}}@media (prefers-reduced-motion: reduce){.migration-coexistence__dot{display:none}}"}],"page":{"pagePath":"api-reference/2027-01/payments/list-payments","slug":"/api-reference/2027-01/payments/list-payments","pageMetadata":{"title":"List Payments","description":"List payments.\n\n**Scopes**: `payments:read`","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/payments/","href":"/api-reference/2027-01/payments/list-payments","autogeneratedByOpenApi":true},"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 strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"List payments.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Scopes\"\n }), \": \", _jsx(_components.code, {\n children: \"payments:read\"\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}=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":"List Payments","description":"List payments.\n\n**Scopes**: `payments:read`","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/payments/","href":"/api-reference/2027-01/payments/list-payments","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["payments","public","mcp","cli"],"summary":"List Payments","description":"List payments.\n\n**Scopes**: `payments:read`","operationId":"payments:list","security":["88ff6bb0-0c1d-4540-b61a-29d2a4ed7427","298755b2-642a-44c6-87f2-287d6e81857c","c6ea9283-338f-4931-b264-de057e3108d8"],"parameters":["67f0ac07-f8a0-418c-8720-081149b25487","9897be53-f0c9-4c38-a43f-0bfb3b08f692","1eb0c64a-5211-49d2-a483-504a4e4fe3d3","a27502c0-ba28-4577-870b-4fc50658a5e3","0d380b50-0e3b-4e05-9826-1edd61aac864","aaba019c-9e60-42ce-b718-36cd31c98419","dc091a30-26bc-4e44-9bd7-fe8a6c586669","fe011da5-b5f6-4b9b-929e-557870bb8232","fd1edde5-bcfb-4bce-9bb8-06160c37a3b5","314c12d4-2054-4fc2-b0e0-84c9949a3334"],"responses":{"200":"394f4c68-9e2b-41e2-bf09-42cca38e2c0a","422":"72026fb6-51a1-45d5-b6bc-6f71e4b28247"},"x-tool-name":"payments_list","x-tool-title":"List Payments","x-tool-description":"List payments.","x-tool-annotations":["read_only","idempotent"],"x-polar-allowed-subjects":["Organization","User"],"x-speakeasy-pagination":{"type":"offsetLimit","inputs":[{"name":"page","in":"parameters","type":"page"},{"name":"limit","in":"parameters","type":"limit"}],"outputs":{"results":"$.items","numPages":"$.pagination.max_page"}},"x-speakeasy-group":"payments","x-speakeasy-name-override":"list","x-polar-pagination":{"type":"page_limit","item_schema":{"$ref":"#/components/schemas/Payment"}},"x-codeSamples":[{"lang":"python","source":"from polar.v2027_01 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nfor item in polar.payments.iter_list(\n page=1,\n limit=10,\n sorting=['-created_at'],\n):\n print(item)\n"},{"lang":"typescript","source":"import { createPolar } from \"@polar-sh/sdk/2027-01\";\n\nconst polar = createPolar({\n accessToken: \"polar_oat_xxx\",\n});\n\nfor await (const item of polar.payments.iterList(\n {\n \"page\": 1,\n \"limit\": 10,\n \"sorting\": [\n \"-created_at\"\n ]\n },\n)) {\n console.log(item);\n}\n"}],"method":"get","type":"path","servers":["177dd155-65e4-4d5f-8733-d90b8e78bf56","4d9577bf-df28-423c-b9bd-28d986e1b2a3"],"path":"/v1/payments/","baseUrlOptions":["https://api.polar.sh","https://sandbox-api.polar.sh"],"title":"List Payments","codeSamples":[{"lang":"python","source":"from polar.v2027_01 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nfor item in polar.payments.iter_list(\n page=1,\n limit=10,\n sorting=['-created_at'],\n):\n print(item)\n"},{"lang":"typescript","source":"import { createPolar } from \"@polar-sh/sdk/2027-01\";\n\nconst polar = createPolar({\n accessToken: \"polar_oat_xxx\",\n});\n\nfor await (const item of polar.payments.iterList(\n {\n \"page\": 1,\n \"limit\": 10,\n \"sorting\": [\n \"-created_at\"\n ]\n },\n)) {\n console.log(item);\n}\n"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"67f0ac07-f8a0-418c-8720-081149b25487":{"name":"organization_id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"OrganizationID Filter","description":"Filter by organization ID.\nThe organization ID.","format":"uuid4","example":"1dbfc517-0bbf-4301-9ba8-555ca42b9737","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"array","items":{"type":"string","format":"uuid4","description":"The organization ID.","examples":["1dbfc517-0bbf-4301-9ba8-555ca42b9737"],"uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"string\u003cuuid4>"},"title":"OrganizationID Filter","description":"Filter by organization ID.","uniqueKey":"oneOf.1","typeLabel":"string\u003cuuid4>[]"},{"type":"null","title":"OrganizationID Filter","description":"Filter by organization ID.","uniqueKey":"oneOf.2","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid4> | string\u003cuuid4>[] | null"},"description":"Filter by organization ID."},"9897be53-f0c9-4c38-a43f-0bfb3b08f692":{"name":"checkout_id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"CheckoutID Filter","description":"Filter by checkout ID.","format":"uuid4","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"array","items":{"type":"string","format":"uuid4","uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"string\u003cuuid4>"},"title":"CheckoutID Filter","description":"Filter by checkout ID.","uniqueKey":"oneOf.1","typeLabel":"string\u003cuuid4>[]"},{"type":"null","title":"CheckoutID Filter","description":"Filter by checkout ID.","uniqueKey":"oneOf.2","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid4> | string\u003cuuid4>[] | null"},"description":"Filter by checkout ID."},"1eb0c64a-5211-49d2-a483-504a4e4fe3d3":{"name":"order_id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"OrderID Filter","description":"Filter by order ID.","format":"uuid4","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"array","items":{"type":"string","format":"uuid4","uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"string\u003cuuid4>"},"title":"OrderID Filter","description":"Filter by order ID.","uniqueKey":"oneOf.1","typeLabel":"string\u003cuuid4>[]"},{"type":"null","title":"OrderID Filter","description":"Filter by order ID.","uniqueKey":"oneOf.2","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid4> | string\u003cuuid4>[] | null"},"description":"Filter by order ID."},"a27502c0-ba28-4577-870b-4fc50658a5e3":{"name":"customer_id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"CustomerID Filter","description":"Filter by customer ID.\nThe customer ID.","format":"uuid4","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"array","items":{"type":"string","format":"uuid4","description":"The customer ID.","uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"string\u003cuuid4>"},"title":"CustomerID Filter","description":"Filter by customer ID.","uniqueKey":"oneOf.1","typeLabel":"string\u003cuuid4>[]"},{"type":"null","title":"CustomerID Filter","description":"Filter by customer ID.","uniqueKey":"oneOf.2","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid4> | string\u003cuuid4>[] | null"},"description":"Filter by customer ID."},"0d380b50-0e3b-4e05-9826-1edd61aac864":{"name":"status","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"PaymentStatus","description":"Filter by payment status.","enum":["pending","succeeded","failed"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"array","items":{"type":"string","enum":["pending","succeeded","failed"],"title":"PaymentStatus","uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Status Filter","description":"Filter by payment status.","uniqueKey":"oneOf.1","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Status Filter","description":"Filter by payment status.","uniqueKey":"oneOf.2","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | enum\u003cstring>[] | null"},"description":"Filter by payment status."},"aaba019c-9e60-42ce-b718-36cd31c98419":{"name":"method","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Method Filter","description":"Filter by payment method.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"string"},"title":"Method Filter","description":"Filter by payment method.","uniqueKey":"oneOf.1","typeLabel":"string[]"},{"type":"null","title":"Method Filter","description":"Filter by payment method.","uniqueKey":"oneOf.2","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | string[] | null"},"description":"Filter by payment method."},"dc091a30-26bc-4e44-9bd7-fe8a6c586669":{"name":"customer_email","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"CustomerEmail Filter","description":"Filter by customer email.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.items.[INDEX]","typeLabel":"string"},"title":"CustomerEmail Filter","description":"Filter by customer email.","uniqueKey":"oneOf.1","typeLabel":"string[]"},{"type":"null","title":"CustomerEmail Filter","description":"Filter by customer email.","uniqueKey":"oneOf.2","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | string[] | null"},"description":"Filter by customer email."},"fe011da5-b5f6-4b9b-929e-557870bb8232":{"name":"page","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Page number, defaults to 1.","default":1,"title":"Page","isRequired":false,"uniqueKey":"","typeLabel":"integer"},"description":"Page number, defaults to 1."},"fd1edde5-bcfb-4bce-9bb8-06160c37a3b5":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"description":"Size of a page, defaults to 10. Maximum is 100.","default":10,"title":"Limit","isRequired":false,"uniqueKey":"","typeLabel":"integer"},"description":"Size of a page, defaults to 10. Maximum is 100."},"314c12d4-2054-4fc2-b0e0-84c9949a3334":{"name":"sorting","in":"query","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","enum":["created_at","-created_at","status","-status","amount","-amount","method","-method"],"title":"PaymentSortProperty","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Sorting","description":"Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.","default":["-created_at"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Sorting","description":"Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.","default":["-created_at"],"uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[] | null"},"description":"Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order."}},"responses":{"394f4c68-9e2b-41e2-bf09-42cca38e2c0a":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"items":{"items":{"oneOf":[{"type":"object","title":"CardPayment","description":"Schema of a payment with a card payment method.","required":["created_at","modified_at","id","processor","status","amount","currency","method","trigger","decline_reason","decline_message","organization_id","checkout_id","order_id","method_metadata"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.id","typeLabel":"string\u003cuuid4>"},"processor":{"type":"string","enum":["stripe"],"title":"PaymentProcessor","description":"The payment processor.","examples":["stripe"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.processor","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["pending","succeeded","failed"],"title":"PaymentStatus","description":"The payment status.","examples":["succeeded"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","title":"Amount","description":"The payment amount in cents.","examples":[1000],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.amount","typeLabel":"integer"},"currency":{"type":"string","title":"Currency","description":"The payment currency","examples":["usd"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.currency","typeLabel":"string"},"method":{"type":"string","const":"card","title":"Method","description":"The payment method used.","examples":["card"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.method","typeLabel":"string"},"trigger":{"oneOf":[{"type":"string","title":"PaymentTrigger","description":"What initiated this payment attempt, e.g. initial purchase, subscription renewal, or an automated dunning retry.","enum":["purchase","subscription_cycle","retry_dunning","retry_customer","retry_payment_method_update","retry_admin"],"example":"subscription_cycle","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.trigger.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"What initiated this payment attempt, e.g. initial purchase, subscription renewal, or an automated dunning retry.","example":"subscription_cycle","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.trigger.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.trigger","typeLabel":"enum\u003cstring> | null"},"decline_reason":{"oneOf":[{"type":"string","title":"Decline Reason","description":"Error code, if the payment was declined.","example":"insufficient_funds","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.decline_reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Decline Reason","description":"Error code, if the payment was declined.","example":"insufficient_funds","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.decline_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.decline_reason","typeLabel":"string | null"},"decline_message":{"oneOf":[{"type":"string","title":"Decline Message","description":"Human-readable error message, if the payment was declined.","example":"Your card has insufficient funds.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.decline_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Decline Message","description":"Human-readable error message, if the payment was declined.","example":"Your card has insufficient funds.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.decline_message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.decline_message","typeLabel":"string | null"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization that owns the payment.","examples":["1dbfc517-0bbf-4301-9ba8-555ca42b9737"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.organization_id","typeLabel":"string\u003cuuid4>"},"checkout_id":{"oneOf":[{"type":"string","title":"Checkout Id","description":"The ID of the checkout session associated with this payment.","format":"uuid4","example":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.checkout_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Checkout Id","description":"The ID of the checkout session associated with this payment.","example":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.checkout_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.checkout_id","typeLabel":"string\u003cuuid4> | null"},"order_id":{"oneOf":[{"type":"string","title":"Order Id","description":"The ID of the order associated with this payment.","format":"uuid4","example":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.order_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Order Id","description":"The ID of the order associated with this payment.","example":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.order_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.order_id","typeLabel":"string\u003cuuid4> | null"},"method_metadata":{"properties":{"brand":{"type":"string","title":"Brand","description":"The brand of the card used for the payment.","examples":["visa","amex"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.method_metadata.brand","typeLabel":"string"},"last4":{"type":"string","title":"Last4","description":"The last 4 digits of the card number.","examples":["4242"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.method_metadata.last4","typeLabel":"string"}},"type":"object","required":["brand","last4"],"title":"CardPaymentMetadata","description":"Additional metadata for the card payment method.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.0.method_metadata","typeLabel":"CardPaymentMetadata · object"},"processor_metadata":{"additionalProperties":true,"type":"object","title":"Processor Metadata","description":"Additional metadata from the payment processor for internal use.","uniqueKey":"\\items.items.[INDEX].oneOf.0.processor_metadata","typeLabel":"Processor Metadata · object"}},"uniqueKey":"\\items.items.[INDEX].oneOf.0","typeLabel":"CardPayment · object"},{"type":"object","title":"KrCardPayment","description":"Schema of a payment with a South Korean card payment method.","required":["created_at","modified_at","id","processor","status","amount","currency","method","trigger","decline_reason","decline_message","organization_id","checkout_id","order_id","method_metadata"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.id","typeLabel":"string\u003cuuid4>"},"processor":{"type":"string","enum":["stripe"],"title":"PaymentProcessor","description":"The payment processor.","examples":["stripe"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.processor","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["pending","succeeded","failed"],"title":"PaymentStatus","description":"The payment status.","examples":["succeeded"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","title":"Amount","description":"The payment amount in cents.","examples":[1000],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.amount","typeLabel":"integer"},"currency":{"type":"string","title":"Currency","description":"The payment currency","examples":["usd"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.currency","typeLabel":"string"},"method":{"type":"string","const":"kr_card","title":"Method","description":"The payment method used.","examples":["kr_card"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.method","typeLabel":"string"},"trigger":{"oneOf":[{"type":"string","title":"PaymentTrigger","description":"What initiated this payment attempt, e.g. initial purchase, subscription renewal, or an automated dunning retry.","enum":["purchase","subscription_cycle","retry_dunning","retry_customer","retry_payment_method_update","retry_admin"],"example":"subscription_cycle","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.trigger.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"What initiated this payment attempt, e.g. initial purchase, subscription renewal, or an automated dunning retry.","example":"subscription_cycle","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.trigger.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.trigger","typeLabel":"enum\u003cstring> | null"},"decline_reason":{"oneOf":[{"type":"string","title":"Decline Reason","description":"Error code, if the payment was declined.","example":"insufficient_funds","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.decline_reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Decline Reason","description":"Error code, if the payment was declined.","example":"insufficient_funds","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.decline_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.decline_reason","typeLabel":"string | null"},"decline_message":{"oneOf":[{"type":"string","title":"Decline Message","description":"Human-readable error message, if the payment was declined.","example":"Your card has insufficient funds.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.decline_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Decline Message","description":"Human-readable error message, if the payment was declined.","example":"Your card has insufficient funds.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.decline_message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.decline_message","typeLabel":"string | null"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization that owns the payment.","examples":["1dbfc517-0bbf-4301-9ba8-555ca42b9737"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.organization_id","typeLabel":"string\u003cuuid4>"},"checkout_id":{"oneOf":[{"type":"string","title":"Checkout Id","description":"The ID of the checkout session associated with this payment.","format":"uuid4","example":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.checkout_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Checkout Id","description":"The ID of the checkout session associated with this payment.","example":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.checkout_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.checkout_id","typeLabel":"string\u003cuuid4> | null"},"order_id":{"oneOf":[{"type":"string","title":"Order Id","description":"The ID of the order associated with this payment.","format":"uuid4","example":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.order_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Order Id","description":"The ID of the order associated with this payment.","example":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.order_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.order_id","typeLabel":"string\u003cuuid4> | null"},"method_metadata":{"properties":{"brand":{"oneOf":[{"type":"string","title":"Brand","description":"The local South Korean card brand used for the payment.","example":"kookmin","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.method_metadata.brand.oneOf.0","typeLabel":"string"},{"type":"null","title":"Brand","description":"The local South Korean card brand used for the payment.","example":"kookmin","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.method_metadata.brand.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.method_metadata.brand","typeLabel":"string | null"},"last4":{"oneOf":[{"type":"string","title":"Last4","description":"The last 4 digits of the card number.","example":"4242","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.method_metadata.last4.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last4","description":"The last 4 digits of the card number.","example":"4242","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.method_metadata.last4.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.method_metadata.last4","typeLabel":"string | null"}},"type":"object","required":["brand","last4"],"title":"KrCardPaymentMetadata","description":"Additional metadata for the South Korean card payment method.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.1.method_metadata","typeLabel":"KrCardPaymentMetadata · object"},"processor_metadata":{"additionalProperties":true,"type":"object","title":"Processor Metadata","description":"Additional metadata from the payment processor for internal use.","uniqueKey":"\\items.items.[INDEX].oneOf.1.processor_metadata","typeLabel":"Processor Metadata · object"}},"uniqueKey":"\\items.items.[INDEX].oneOf.1","typeLabel":"KrCardPayment · object"},{"type":"object","title":"GenericPayment","description":"Schema of a payment with a generic payment method.","required":["created_at","modified_at","id","processor","status","amount","currency","method","trigger","decline_reason","decline_message","organization_id","checkout_id","order_id"],"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp of the object.","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"oneOf":[{"type":"string","title":"Modified At","description":"Last modification timestamp of the object.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.id","typeLabel":"string\u003cuuid4>"},"processor":{"type":"string","enum":["stripe"],"title":"PaymentProcessor","description":"The payment processor.","examples":["stripe"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.processor","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["pending","succeeded","failed"],"title":"PaymentStatus","description":"The payment status.","examples":["succeeded"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","title":"Amount","description":"The payment amount in cents.","examples":[1000],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.amount","typeLabel":"integer"},"currency":{"type":"string","title":"Currency","description":"The payment currency","examples":["usd"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.currency","typeLabel":"string"},"method":{"type":"string","title":"Method","description":"The payment method used.","examples":["card"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.method","typeLabel":"string"},"trigger":{"oneOf":[{"type":"string","title":"PaymentTrigger","description":"What initiated this payment attempt, e.g. initial purchase, subscription renewal, or an automated dunning retry.","enum":["purchase","subscription_cycle","retry_dunning","retry_customer","retry_payment_method_update","retry_admin"],"example":"subscription_cycle","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.trigger.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"What initiated this payment attempt, e.g. initial purchase, subscription renewal, or an automated dunning retry.","example":"subscription_cycle","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.trigger.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.trigger","typeLabel":"enum\u003cstring> | null"},"decline_reason":{"oneOf":[{"type":"string","title":"Decline Reason","description":"Error code, if the payment was declined.","example":"insufficient_funds","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.decline_reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Decline Reason","description":"Error code, if the payment was declined.","example":"insufficient_funds","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.decline_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.decline_reason","typeLabel":"string | null"},"decline_message":{"oneOf":[{"type":"string","title":"Decline Message","description":"Human-readable error message, if the payment was declined.","example":"Your card has insufficient funds.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.decline_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Decline Message","description":"Human-readable error message, if the payment was declined.","example":"Your card has insufficient funds.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.decline_message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.decline_message","typeLabel":"string | null"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization that owns the payment.","examples":["1dbfc517-0bbf-4301-9ba8-555ca42b9737"],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.organization_id","typeLabel":"string\u003cuuid4>"},"checkout_id":{"oneOf":[{"type":"string","title":"Checkout Id","description":"The ID of the checkout session associated with this payment.","format":"uuid4","example":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.checkout_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Checkout Id","description":"The ID of the checkout session associated with this payment.","example":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.checkout_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.checkout_id","typeLabel":"string\u003cuuid4> | null"},"order_id":{"oneOf":[{"type":"string","title":"Order Id","description":"The ID of the order associated with this payment.","format":"uuid4","example":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.order_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Order Id","description":"The ID of the order associated with this payment.","example":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.order_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].oneOf.2.order_id","typeLabel":"string\u003cuuid4> | null"},"processor_metadata":{"additionalProperties":true,"type":"object","title":"Processor Metadata","description":"Additional metadata from the payment processor for internal use.","uniqueKey":"\\items.items.[INDEX].oneOf.2.processor_metadata","typeLabel":"Processor Metadata · object"}},"uniqueKey":"\\items.items.[INDEX].oneOf.2","typeLabel":"GenericPayment · object"}],"uniqueKey":"\\items.items.[INDEX]","typeLabel":"CardPayment · object | KrCardPayment · object | GenericPayment · object"},"type":"array","title":"Items","isRequired":true,"uniqueKey":"\\items","typeLabel":"(CardPayment · object | KrCardPayment · object | GenericPayment · object)[]"},"pagination":{"properties":{"total_count":{"type":"integer","title":"Total Count","isRequired":true,"uniqueKey":"pagination.total_count","typeLabel":"integer"},"max_page":{"type":"integer","title":"Max Page","isRequired":true,"uniqueKey":"pagination.max_page","typeLabel":"integer"}},"type":"object","required":["total_count","max_page"],"title":"Pagination","isRequired":true,"uniqueKey":"pagination","typeLabel":"Pagination · object"}},"type":"object","required":["items","pagination"],"title":"ListResource[Payment]","uniqueKey":"","typeLabel":"ListResource[Payment] · object"},"examples":{"Example":{"title":"Example","value":{"items":[{"created_at":"2026-01-01T00:00:00.000000Z","modified_at":"2026-01-01T00:00:00.000000Z","id":"\u003cstring>","processor":"stripe","status":"succeeded","amount":1000,"currency":"usd","method":"card","trigger":"subscription_cycle","decline_reason":"insufficient_funds","decline_message":"Your card has insufficient funds.","organization_id":"1dbfc517-0bbf-4301-9ba8-555ca42b9737","checkout_id":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","order_id":"e4b478fa-cd25-4253-9f1f-8a41e6370ede","method_metadata":{"brand":"visa","last4":"4242"},"processor_metadata":{}}],"pagination":{"total_count":123,"max_page":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"72026fb6-51a1-45d5-b6bc-6f71e4b28247":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"88ff6bb0-0c1d-4540-b61a-29d2a4ed7427":{"oidc":{"type":"openIdConnect","openIdConnectUrl":"/.well-known/openid-configuration","scopes":["payments:read"],"schemeName":"oidc"}},"298755b2-642a-44c6-87f2-287d6e81857c":{"pat":{"type":"http","description":"You can generate a **Personal Access Token** from your [settings](https://polar.sh/settings).","scheme":"bearer","scopes":["payments:read"],"schemeName":"pat"}},"c6ea9283-338f-4931-b264-de057e3108d8":{"oat":{"type":"http","description":"You can generate an **Organization Access Token** from your organization's settings.","scheme":"bearer","scopes":["payments:read"],"schemeName":"oat"}}},"servers":{"177dd155-65e4-4d5f-8733-d90b8e78bf56":{"url":"https://api.polar.sh","description":"Production environment","x-speakeasy-server-id":"production","x-polar-environment":"production"},"4d9577bf-df28-423c-b9bd-28d986e1b2a3":{"url":"https://sandbox-api.polar.sh","description":"Sandbox environment","x-speakeasy-server-id":"sandbox","x-polar-environment":"sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"You can generate a **Personal Access Token** from your [settings](https://polar.sh/settings).","scheme":"bearer","scopes":["payments:read"],"schemeName":"pat"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"You can generate a **Personal Access Token** from your [settings](https://polar.sh/settings).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"pat","name":"Authorization"}],"title":"pat"},{"schemes":[{"scheme":{"type":"http","description":"You can generate an **Organization Access Token** from your organization's settings.","scheme":"bearer","scopes":["payments:read"],"schemeName":"oat"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"You can generate an **Organization Access Token** from your organization's settings.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oat","name":"Authorization"}],"title":"oat"}]},"originalFileLocation":"openapi/2027-01.openapi.json"},"subdomain":"polar","siteName":"Polar","title":"List Payments - Polar","navMaps":{"firstHrefInVersion":{"2026-04":{"href":"/api-reference/2026-04/payments/list-payments","matchLevel":1},"2026-10":{"href":"/api-reference/2026-10/payments/list-payments","matchLevel":1},"2027-01":{"href":"/api-reference/2027-01/payments/list-payments","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-14T13:24:57.604Z","originalFileLocation":"api-reference/2027-01/payments/list-payments.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"List payments. Scopes: payments:read\">\u003cmeta data-mint-head name=\"application-name\" content=\"Polar\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_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=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Payments - Polar\">\u003cmeta data-mint-head property=\"og:description\" content=\"List payments. Scopes: payments:read\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Polar\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://polar.sh/docs/api-reference/2027-01/payments/list-payments\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://polar.sh/assets/brand/polar_og.jpg\">\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=\"List Payments - Polar\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List payments. Scopes: payments:read\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://polar.sh/assets/brand/polar_og.jpg\">\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=\"/docs/mintlify-assets/_mintlify/favicons/polar/QOhyWW-Aw_fueaue/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Polar\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://polar.sh/docs/api-reference/2027-01/payments/list-payments\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/2027-01/payments/list-payments.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://polar.sh/#organization\",\"name\":\"Polar\",\"url\":\"https://polar.sh\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/polar/4USyJwN59kbPHT7o/logo/light.png?fit=max\u0026auto=format\u0026n=4USyJwN59kbPHT7o\u0026q=85\u0026s=e950d8c7839bea573a30b2b2f26b279e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://polar.sh/docs#website\",\"name\":\"Polar\",\"url\":\"https://polar.sh/docs\",\"publisher\":{\"@id\":\"https://polar.sh/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://polar.sh/docs/api-reference/2027-01/payments/list-payments#webpage\",\"url\":\"https://polar.sh/docs/api-reference/2027-01/payments/list-payments\",\"name\":\"List Payments\",\"description\":\"List payments. Scopes: payments:read\",\"dateModified\":\"2026-11-14T13:24:57.604Z\",\"isPartOf\":{\"@id\":\"https://polar.sh/docs#website\"},\"breadcrumb\":{\"@id\":\"https://polar.sh/docs/api-reference/2027-01/payments/list-payments#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://polar.sh/docs/api-reference/2027-01/payments/list-payments#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core API\",\"item\":\"https://polar.sh/docs/api-reference/2027-01/checkouts/create-checkout-session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Payments\",\"item\":\"https://polar.sh/docs/api-reference/2027-01/payments/list-payments\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://polar.sh/docs/api-reference/2027-01/payments/list-payments#apireference\",\"headline\":\"List Payments\",\"name\":\"List Payments\",\"description\":\"List payments. Scopes: payments:read\",\"url\":\"https://polar.sh/docs/api-reference/2027-01/payments/list-payments\",\"mainEntityOfPage\":{\"@id\":\"https://polar.sh/docs/api-reference/2027-01/payments/list-payments#webpage\"},\"image\":\"https://polar.sh/assets/brand/polar_og.jpg\",\"dateModified\":\"2026-11-14T13:24:57.604Z\",\"publisher\":{\"@id\":\"https://polar.sh/#organization\"},\"isPartOf\":{\"@id\":\"https://polar.sh/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Polar\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Polar\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/2027-01/payments/list-payments.md","siteName":"Polar","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"compass","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Developer Resources","icon":"rectangle-terminal","pages":[{"title":"Developer Resources","href":"/integrate/authentication"}]},{"tab":"API Reference","icon":"code","versions":[{"version":"2026-04","tag":"Deprecated","pages":[{"title":"2026-04","href":"/api-reference/2026-04/payments/list-payments"}]},{"version":"2026-10","default":true,"tag":"Current","pages":[{"title":"2026-10","href":"/api-reference/2026-10/payments/list-payments"}]},{"version":"2027-01","tag":"Next","groups":[{"group":"General","pages":[{"title":"API Overview","sidebarTitle":"Introduction","href":"/api-reference/2027-01/introduction"},{"title":"API Versioning","sidebarTitle":"Versioning","href":"/api-reference/2027-01/versioning"}]},{"group":"Core API","pages":[{"group":"Checkout","pages":[{"title":"Create Checkout Session","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/checkouts/","href":"/api-reference/2027-01/checkouts/create-checkout-session"},{"title":"Get Checkout Session","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/checkouts/{id}","href":"/api-reference/2027-01/checkouts/get-checkout-session"},{"title":"List Checkout Sessions","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/checkouts/","href":"/api-reference/2027-01/checkouts/list-checkout-sessions"},{"title":"Update Checkout Session","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/checkouts/{id}","href":"/api-reference/2027-01/checkouts/update-checkout-session"},{"title":"Get Checkout Session from Client","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/checkouts/client/{client_secret}","href":"/api-reference/2027-01/checkouts/get-checkout-session-from-client"},{"title":"Update Checkout Session from Client","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/checkouts/client/{client_secret}","href":"/api-reference/2027-01/checkouts/update-checkout-session-from-client"},{"title":"Confirm Checkout Session from Client","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/checkouts/client/{client_secret}/confirm","href":"/api-reference/2027-01/checkouts/confirm-checkout-session-from-client"}]},{"group":"Checkout Links","pages":[{"title":"Create Checkout Link","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/checkout-links/","href":"/api-reference/2027-01/checkout-links/create-checkout-link"},{"title":"Get Checkout Link","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/checkout-links/{id}","href":"/api-reference/2027-01/checkout-links/get-checkout-link"},{"title":"List Checkout Links","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/checkout-links/","href":"/api-reference/2027-01/checkout-links/list-checkout-links"},{"title":"Update Checkout Link","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/checkout-links/{id}","href":"/api-reference/2027-01/checkout-links/update-checkout-link"},{"title":"Delete Checkout Link","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/checkout-links/{id}","href":"/api-reference/2027-01/checkout-links/delete-checkout-link"}]},{"group":"Custom Checkout Fields","pages":[{"title":"Create Custom Field","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/custom-fields/","href":"/api-reference/2027-01/custom-fields/create-custom-field"},{"title":"Get Custom Field","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/custom-fields/{id}","href":"/api-reference/2027-01/custom-fields/get-custom-field"},{"title":"List Custom Fields","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/custom-fields/","href":"/api-reference/2027-01/custom-fields/list-custom-fields"},{"title":"Update Custom Field","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/custom-fields/{id}","href":"/api-reference/2027-01/custom-fields/update-custom-field"},{"title":"Delete Custom Field","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/custom-fields/{id}","href":"/api-reference/2027-01/custom-fields/delete-custom-field"}]},{"group":"Customers","pages":[{"title":"Get Customer State","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customers/{id}/state","href":"/api-reference/2027-01/customers/get-customer-state"},{"title":"Get Customer State by External ID","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customers/external/{external_id}/state","href":"/api-reference/2027-01/customers/get-customer-state-by-external-id"},{"title":"List Customers","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customers/","href":"/api-reference/2027-01/customers/list-customers"},{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customers/","href":"/api-reference/2027-01/customers/create-customer"},{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customers/{id}","href":"/api-reference/2027-01/customers/get-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/customers/{id}","href":"/api-reference/2027-01/customers/update-customer"},{"title":"Delete Customer","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/customers/{id}","href":"/api-reference/2027-01/customers/delete-customer"},{"title":"Get Customer by External ID","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customers/external/{external_id}","href":"/api-reference/2027-01/customers/get-customer-by-external-id"},{"title":"Update Customer by External ID","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/customers/external/{external_id}","href":"/api-reference/2027-01/customers/update-customer-by-external-id"},{"title":"Delete Customer by External ID","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/customers/external/{external_id}","href":"/api-reference/2027-01/customers/delete-customer-by-external-id"},{"title":"List Customer Payment Methods","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customers/{id}/payment-methods","href":"/api-reference/2027-01/customers/list-customer-payment-methods"},{"title":"List Customer Payment Methods by External ID","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customers/external/{external_id}/payment-methods","href":"/api-reference/2027-01/customers/list-customer-payment-methods-by-external-id"}]},{"group":"Subscriptions","pages":[{"title":"Get Subscription","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/subscriptions/{id}","href":"/api-reference/2027-01/subscriptions/get-subscription"},{"title":"List Subscriptions","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/subscriptions/","href":"/api-reference/2027-01/subscriptions/list-subscriptions"},{"title":"Create Subscription","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/subscriptions/","href":"/api-reference/2027-01/subscriptions/create-subscription"},{"title":"Update Subscription","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/subscriptions/{id}","href":"/api-reference/2027-01/subscriptions/update-subscription"},{"title":"Revoke Subscription","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/subscriptions/{id}","href":"/api-reference/2027-01/subscriptions/revoke-subscription"}]},{"group":"Orders","pages":[{"title":"Get Order","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/orders/{id}","href":"/api-reference/2027-01/orders/get-order"},{"title":"Update Order","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/orders/{id}","href":"/api-reference/2027-01/orders/update-order"},{"title":"List Orders","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/orders/","href":"/api-reference/2027-01/orders/list-orders"},{"title":"Generate Order Invoice","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/orders/{id}/invoice","href":"/api-reference/2027-01/orders/generate-order-invoice"},{"title":"Get Order Invoice","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/orders/{id}/invoice","href":"/api-reference/2027-01/orders/get-order-invoice"},{"title":"Get Order Receipt","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/orders/{id}/receipt","href":"/api-reference/2027-01/orders/get-order-receipt"},{"title":"Create Order","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/orders/","href":"/api-reference/2027-01/orders/create-order"},{"title":"Export Orders","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/orders/export","href":"/api-reference/2027-01/orders/export-orders"},{"title":"Finalize Order","description":"Finalize a draft order and synchronously attempt an off-session charge.\n\nOn success, the order transitions to `paid` and benefit grants fire\nbefore the response returns. On failure (decline, missing payment method,\nSCA challenge), the order stays in `draft` and a 4xx error is returned.\n\nThe request fails with 412 if the order is not in `draft` status.\n\n**Scopes**: `orders:write`","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/orders/{id}/finalize","href":"/api-reference/2027-01/orders/finalize-order"}]},{"group":"Payments","pages":[{"title":"List Payments","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/payments/","href":"/api-reference/2027-01/payments/list-payments"},{"title":"Get Payment","description":"Get a payment by ID.\n\n**Scopes**: `payments:read`","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/payments/{id}","href":"/api-reference/2027-01/payments/get-payment"}]},{"group":"Disputes","pages":[{"title":"List Disputes","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/disputes/","href":"/api-reference/2027-01/disputes/list-disputes"},{"title":"Get Dispute","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/disputes/{id}","href":"/api-reference/2027-01/disputes/get-dispute"},{"title":"Accept Dispute","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/disputes/{id}/accept","href":"/api-reference/2027-01/disputes/accept-dispute"}]},{"group":"Discounts","pages":[{"title":"Get Discount","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/discounts/{id}","href":"/api-reference/2027-01/discounts/get-discount"},{"title":"List Discounts","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/discounts/","href":"/api-reference/2027-01/discounts/list-discounts"},{"title":"Create Discount","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/discounts/","href":"/api-reference/2027-01/discounts/create-discount"},{"title":"Update Discount","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/discounts/{id}","href":"/api-reference/2027-01/discounts/update-discount"},{"title":"Delete Discount","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/discounts/{id}","href":"/api-reference/2027-01/discounts/delete-discount"}]},{"group":"Refunds","pages":[{"title":"Create Refund","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/refunds/","href":"/api-reference/2027-01/refunds/create-refund"},{"title":"List Refunds","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/refunds/","href":"/api-reference/2027-01/refunds/list-refunds"}]},{"group":"Products","pages":[{"title":"Get Product","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/products/{id}","href":"/api-reference/2027-01/products/get-product"},{"title":"List Products","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/products/","href":"/api-reference/2027-01/products/list-products"},{"title":"Create Product","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/products/","href":"/api-reference/2027-01/products/create-product"},{"title":"Update Product","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/products/{id}","href":"/api-reference/2027-01/products/update-product"},{"title":"Delete Product","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/products/{id}","href":"/api-reference/2027-01/products/delete-product"},{"title":"Update Product Benefits","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/products/{id}/benefits","href":"/api-reference/2027-01/products/update-product-benefits"}]},{"group":"Events","pages":[{"title":"Ingest Events","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/events/ingest","href":"/api-reference/2027-01/events/ingest-events"},{"title":"Get Event","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/events/{id}","href":"/api-reference/2027-01/events/get-event"},{"title":"List Events","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/events/","href":"/api-reference/2027-01/events/list-events"}]},{"group":"Meters","pages":[{"title":"Create Meter","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/meters/","href":"/api-reference/2027-01/meters/create-meter"},{"title":"Get Meter","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/meters/{id}","href":"/api-reference/2027-01/meters/get-meter"},{"title":"List Meters","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/meters/","href":"/api-reference/2027-01/meters/list-meters"},{"title":"Update Meter","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/meters/{id}","href":"/api-reference/2027-01/meters/update-meter"},{"title":"Get Meter Quantities","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/meters/{id}/quantities","href":"/api-reference/2027-01/meters/get-meter-quantities"},{"title":"Get Meter by External ID","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/meters/external/{external_id}","href":"/api-reference/2027-01/meters/get-meter-by-external-id"}]},{"group":"Benefits","pages":[{"title":"Create Benefit","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/benefits/","href":"/api-reference/2027-01/benefits/create-benefit"},{"title":"Get Benefit","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/benefits/{id}","href":"/api-reference/2027-01/benefits/get-benefit"},{"title":"List Benefits","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/benefits/","href":"/api-reference/2027-01/benefits/list-benefits"},{"title":"List Benefit Grants","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/benefits/{id}/grants","href":"/api-reference/2027-01/benefits/list-benefit-grants"},{"title":"Create Benefit Grant","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/benefit-grants/","href":"/api-reference/2027-01/benefit-grants/create-benefit-grant"},{"title":"Revoke Benefit Grant","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/benefit-grants/{id}","href":"/api-reference/2027-01/benefit-grants/revoke-benefit-grant"},{"title":"Update Benefit","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/benefits/{id}","href":"/api-reference/2027-01/benefits/update-benefit"},{"title":"Delete Benefit","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/benefits/{id}","href":"/api-reference/2027-01/benefits/delete-benefit"},{"title":"List Benefit Grants","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/benefit-grants/","href":"/api-reference/2027-01/benefit-grants/list-benefit-grants"}]},{"group":"Customer Meters","pages":[{"title":"Get Customer Meter","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-meters/{id}","href":"/api-reference/2027-01/customer_meters/get-customer-meter"},{"title":"List Customer Meters","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-meters/","href":"/api-reference/2027-01/customer_meters/list-customer-meters"},{"title":"Credit Customer Meter","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-meters/credits","href":"/api-reference/2027-01/customer_meters/credit-customer-meter"},{"title":"Reverse Customer Meter Credit","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-meters/credits/{id}/reverse","href":"/api-reference/2027-01/customer_meters/reverse-customer-meter-credit"}]},{"group":"License Keys","pages":[{"title":"Get License Key","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/license-keys/{id}","href":"/api-reference/2027-01/license_keys/get-license-key"},{"title":"List License Keys","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/license-keys/","href":"/api-reference/2027-01/license_keys/list-license-keys"},{"title":"Update License Key","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/license-keys/{id}","href":"/api-reference/2027-01/license_keys/update-license-key"},{"title":"Get Activation","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/license-keys/{id}/activations/{activation_id}","href":"/api-reference/2027-01/license_keys/get-activation"},{"title":"Validate License Key","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/license-keys/validate","href":"/api-reference/2027-01/license_keys/validate-license-key"},{"title":"Activate License Key","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/license-keys/activate","href":"/api-reference/2027-01/license_keys/activate-license-key"},{"title":"Deactivate License Key","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/license-keys/deactivate","href":"/api-reference/2027-01/license_keys/deactivate-license-key"},{"title":"Rotate License Key","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/license-keys/{id}/rotate","href":"/api-reference/2027-01/license_keys/rotate-license-key"}]},{"group":"Members","pages":[{"title":"List Members","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customers/{id}/members","href":"/api-reference/2027-01/customers/list-members"},{"title":"Create Member","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customers/{id}/members","href":"/api-reference/2027-01/customers/create-member"},{"title":"Get Member","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customers/{id}/members/{member_id}","href":"/api-reference/2027-01/customers/get-member"},{"title":"Update Member","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/customers/{id}/members/{member_id}","href":"/api-reference/2027-01/customers/update-member"},{"title":"Delete Member","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/customers/{id}/members/{member_id}","href":"/api-reference/2027-01/customers/delete-member"},{"title":"List Members by Customer External ID","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customers/external/{external_id}/members","href":"/api-reference/2027-01/customers/list-members-by-customer-external-id"},{"title":"Create Member by Customer External ID","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customers/external/{external_id}/members","href":"/api-reference/2027-01/customers/create-member-by-customer-external-id"},{"title":"Get Member by External ID","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customers/external/{external_id}/members/{member_external_id}","href":"/api-reference/2027-01/customers/get-member-by-external-id"},{"title":"Update Member by External ID","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/customers/external/{external_id}/members/{member_external_id}","href":"/api-reference/2027-01/customers/update-member-by-external-id"},{"title":"Delete Member by External ID","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/customers/external/{external_id}/members/{member_external_id}","href":"/api-reference/2027-01/customers/delete-member-by-external-id"}]},{"group":"Customer Seats","pages":[{"title":"Assign Seat","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-seats","href":"/api-reference/2027-01/customer-seats/assign-seat"},{"title":"List Seats","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-seats","href":"/api-reference/2027-01/customer-seats/list-seats"},{"title":"Revoke Seat","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/customer-seats/{seat_id}","href":"/api-reference/2027-01/customer-seats/revoke-seat"},{"title":"Resend Invitation","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-seats/{seat_id}/resend","href":"/api-reference/2027-01/customer-seats/resend-invitation"},{"title":"Get Claim Info","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-seats/claim/{invitation_token}","href":"/api-reference/2027-01/customer-seats/get-claim-info"},{"title":"Claim Seat","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-seats/claim","href":"/api-reference/2027-01/customer-seats/claim-seat"}]},{"group":"Files","pages":[{"title":"Create File","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/files/","href":"/api-reference/2027-01/files/create-file"},{"title":"List Files","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/files/","href":"/api-reference/2027-01/files/list-files"},{"title":"Update File","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/files/{id}","href":"/api-reference/2027-01/files/update-file"},{"title":"Delete File","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/files/{id}","href":"/api-reference/2027-01/files/delete-file"},{"title":"Complete File Upload","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/files/{id}/uploaded","href":"/api-reference/2027-01/files/complete-file-upload"}]},{"group":"Organizations","pages":[{"title":"Get Organization","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/organizations/{id}","href":"/api-reference/2027-01/organizations/get-organization"},{"title":"List Organizations","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/organizations/","href":"/api-reference/2027-01/organizations/list-organizations"},{"title":"Create Organization","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/organizations/","href":"/api-reference/2027-01/organizations/create-organization"},{"title":"Update Organization","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/organizations/{id}","href":"/api-reference/2027-01/organizations/update-organization"}]},{"group":"Metrics","pages":[{"title":"Get Metrics","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/metrics/","href":"/api-reference/2027-01/metrics/get-metrics"},{"title":"Get Metrics Limits","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/metrics/limits","href":"/api-reference/2027-01/metrics/get-metrics-limits"}]}]},{"group":"Customer Portal API","pages":[{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/customers/me","href":"/api-reference/2027-01/customer_portal/get-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/customer-portal/customers/me","href":"/api-reference/2027-01/customer_portal/update-customer"},{"title":"Request Email Change","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-portal/customers/me/email-update/request","href":"/api-reference/2027-01/customer_portal/request-email-change"},{"title":"Check Email Change Token","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/customers/me/email-update/check","href":"/api-reference/2027-01/customer_portal/check-email-change-token"},{"title":"Verify Email Change","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-portal/customers/me/email-update/verify","href":"/api-reference/2027-01/customer_portal/verify-email-change"},{"title":"Get Organization","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/organizations/{slug}","href":"/api-reference/2027-01/customer_portal/get-organization"},{"group":"Sessions","pages":[{"title":"Create Customer Session","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-sessions/","href":"/api-reference/2027-01/customer-sessions/create-customer-session"},{"title":"Introspect Customer Session","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/customer-session/introspect","href":"/api-reference/2027-01/customer_portal/introspect-customer-session"},{"title":"Get Authenticated Portal User","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/customer-session/user","href":"/api-reference/2027-01/customer_portal/get-authenticated-portal-user"}]},{"group":"Subscriptions","pages":[{"title":"Get Subscription","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/subscriptions/{id}","href":"/api-reference/2027-01/customer_portal/get-subscription"},{"title":"List Subscriptions","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/subscriptions/","href":"/api-reference/2027-01/customer_portal/list-subscriptions"},{"title":"Update Subscription","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/customer-portal/subscriptions/{id}","href":"/api-reference/2027-01/customer_portal/update-subscription"},{"title":"Cancel Subscription","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/customer-portal/subscriptions/{id}","href":"/api-reference/2027-01/customer_portal/cancel-subscription"}]},{"group":"Orders","pages":[{"title":"Get Order","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/orders/{id}","href":"/api-reference/2027-01/customer_portal/get-order"},{"title":"Update Order","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/customer-portal/orders/{id}","href":"/api-reference/2027-01/customer_portal/update-order"},{"title":"List Orders","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/orders/","href":"/api-reference/2027-01/customer_portal/list-orders"},{"title":"Generate Order Invoice","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-portal/orders/{id}/invoice","href":"/api-reference/2027-01/customer_portal/generate-order-invoice"},{"title":"Get Order Invoice","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/orders/{id}/invoice","href":"/api-reference/2027-01/customer_portal/get-order-invoice"},{"title":"Get Order Receipt","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/orders/{id}/receipt","href":"/api-reference/2027-01/customer_portal/get-order-receipt"}]},{"group":"Benefit Grants","pages":[{"title":"List Benefit Grants","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/benefit-grants/","href":"/api-reference/2027-01/customer_portal/list-benefit-grants"},{"title":"Get Benefit Grant","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/benefit-grants/{id}","href":"/api-reference/2027-01/customer_portal/get-benefit-grant"},{"title":"Update Benefit Grant","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/customer-portal/benefit-grants/{id}","href":"/api-reference/2027-01/customer_portal/update-benefit-grant"}]},{"group":"Customer Meters","pages":[{"title":"List Meters","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/meters/","href":"/api-reference/2027-01/customer_portal/list-meters"},{"title":"Get Customer Meter","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/meters/{id}","href":"/api-reference/2027-01/customer_portal/get-customer-meter"}]},{"group":"License Keys","pages":[{"title":"Validate License Key","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-portal/license-keys/validate","href":"/api-reference/2027-01/customer_portal/validate-license-key"},{"title":"Activate License Key","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-portal/license-keys/activate","href":"/api-reference/2027-01/customer_portal/activate-license-key"},{"title":"Deactivate License Key","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-portal/license-keys/deactivate","href":"/api-reference/2027-01/customer_portal/deactivate-license-key"},{"title":"Get License Key","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/license-keys/{id}","href":"/api-reference/2027-01/customer_portal/get-license-key"},{"title":"List License Keys","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/license-keys/","href":"/api-reference/2027-01/customer_portal/list-license-keys"},{"title":"Rotate License Key","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-portal/license-keys/{id}/rotate","href":"/api-reference/2027-01/customer_portal/rotate-license-key"}]},{"group":"File Downloads","pages":[{"title":"List Downloadables","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/downloadables/","href":"/api-reference/2027-01/customer_portal/list-downloadables"}]},{"group":"Seats","pages":[{"title":"List Seats","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/seats","href":"/api-reference/2027-01/customer_portal/list-seats"},{"title":"Assign Seat","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-portal/seats","href":"/api-reference/2027-01/customer_portal/assign-seat"},{"title":"Revoke Seat","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/customer-portal/seats/{seat_id}","href":"/api-reference/2027-01/customer_portal/revoke-seat"},{"title":"Resend Invitation","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-portal/seats/{seat_id}/resend","href":"/api-reference/2027-01/customer_portal/resend-invitation"},{"title":"List Claimed Subscriptions","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/seats/subscriptions","href":"/api-reference/2027-01/customer_portal/list-claimed-subscriptions"}]},{"group":"Members","pages":[{"title":"List Members","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/members","href":"/api-reference/2027-01/customer_portal/list-members"},{"title":"Add Member","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-portal/members","href":"/api-reference/2027-01/customer_portal/add-member"},{"title":"Update Member","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/customer-portal/members/{id}","href":"/api-reference/2027-01/customer_portal/update-member"},{"title":"Remove Member","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/customer-portal/members/{id}","href":"/api-reference/2027-01/customer_portal/remove-member"}]},{"group":"Payment Methods","pages":[{"title":"List Customer Payment Methods","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/customer-portal/customers/me/payment-methods","href":"/api-reference/2027-01/customer_portal/list-customer-payment-methods"},{"title":"Delete Customer Payment Method","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/customer-portal/customers/me/payment-methods/{id}","href":"/api-reference/2027-01/customer_portal/delete-customer-payment-method"},{"title":"Add Customer Payment Method","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-portal/customers/me/payment-methods","href":"/api-reference/2027-01/customer_portal/add-customer-payment-method"},{"title":"Confirm Customer Payment Method","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/customer-portal/customers/me/payment-methods/confirm","href":"/api-reference/2027-01/customer_portal/confirm-customer-payment-method"}]}]},{"group":"Webhook Events","pages":[{"group":"Customer Events","pages":[{"title":"customer.state_changed","version":null,"deprecated":null,"sidebarTitle":"customer.state_changed","openapi":"/openapi/2027-01.openapi.json webhook customer.state_changed","href":"/api-reference/2027-01/customer_state_changed"},{"title":"customer.created","version":null,"deprecated":null,"sidebarTitle":"customer.created","openapi":"/openapi/2027-01.openapi.json webhook customer.created","href":"/api-reference/2027-01/customer_created"},{"title":"customer.updated","version":null,"deprecated":null,"sidebarTitle":"customer.updated","openapi":"/openapi/2027-01.openapi.json webhook customer.updated","href":"/api-reference/2027-01/customer_updated"},{"title":"customer.deleted","version":null,"deprecated":null,"sidebarTitle":"customer.deleted","openapi":"/openapi/2027-01.openapi.json webhook customer.deleted","href":"/api-reference/2027-01/customer_deleted"}]},{"group":"Billing Events","pages":[{"group":"Checkout","pages":[{"title":"checkout.created","version":null,"deprecated":null,"sidebarTitle":"checkout.created","openapi":"/openapi/2027-01.openapi.json webhook checkout.created","href":"/api-reference/2027-01/checkout_created"},{"title":"checkout.updated","version":null,"deprecated":null,"sidebarTitle":"checkout.updated","openapi":"/openapi/2027-01.openapi.json webhook checkout.updated","href":"/api-reference/2027-01/checkout_updated"},{"title":"checkout.expired","version":null,"deprecated":null,"sidebarTitle":"checkout.expired","openapi":"/openapi/2027-01.openapi.json webhook checkout.expired","href":"/api-reference/2027-01/checkout_expired"}]},{"group":"Subscriptions","pages":[{"title":"subscription.created","version":null,"deprecated":null,"sidebarTitle":"subscription.created","openapi":"/openapi/2027-01.openapi.json webhook subscription.created","href":"/api-reference/2027-01/subscription_created"},{"title":"subscription.active","version":null,"deprecated":null,"sidebarTitle":"subscription.active","openapi":"/openapi/2027-01.openapi.json webhook subscription.active","href":"/api-reference/2027-01/subscription_active"},{"title":"subscription.updated","version":null,"deprecated":null,"sidebarTitle":"subscription.updated","openapi":"/openapi/2027-01.openapi.json webhook subscription.updated","href":"/api-reference/2027-01/subscription_updated"},{"title":"subscription.canceled","version":null,"deprecated":null,"sidebarTitle":"subscription.canceled","openapi":"/openapi/2027-01.openapi.json webhook subscription.canceled","href":"/api-reference/2027-01/subscription_canceled"},{"title":"subscription.uncanceled","version":null,"deprecated":null,"sidebarTitle":"subscription.uncanceled","openapi":"/openapi/2027-01.openapi.json webhook subscription.uncanceled","href":"/api-reference/2027-01/subscription_uncanceled"},{"title":"subscription.cycled","version":null,"deprecated":null,"sidebarTitle":"subscription.cycled","openapi":"/openapi/2027-01.openapi.json webhook subscription.cycled","href":"/api-reference/2027-01/subscription_cycled"},{"title":"subscription.revoked","version":null,"deprecated":null,"sidebarTitle":"subscription.revoked","openapi":"/openapi/2027-01.openapi.json webhook subscription.revoked","href":"/api-reference/2027-01/subscription_revoked"},{"title":"subscription.past_due","version":null,"deprecated":null,"sidebarTitle":"subscription.past_due","openapi":"/openapi/2027-01.openapi.json webhook subscription.past_due","href":"/api-reference/2027-01/subscription_past_due"},{"title":"subscription.paused","version":null,"deprecated":null,"sidebarTitle":"subscription.paused","openapi":"/openapi/2027-01.openapi.json webhook subscription.paused","href":"/api-reference/2027-01/subscription_paused"},{"title":"subscription.resumed","version":null,"deprecated":null,"sidebarTitle":"subscription.resumed","openapi":"/openapi/2027-01.openapi.json webhook subscription.resumed","href":"/api-reference/2027-01/subscription_resumed"},{"title":"subscription.migrated","version":null,"deprecated":null,"sidebarTitle":"subscription.migrated","openapi":"/openapi/2027-01.openapi.json webhook subscription.migrated","href":"/api-reference/2027-01/subscription_migrated"}]},{"group":"Orders","pages":[{"title":"order.created","version":null,"deprecated":null,"sidebarTitle":"order.created","openapi":"/openapi/2027-01.openapi.json webhook order.created","href":"/api-reference/2027-01/order_created"},{"title":"order.paid","version":null,"deprecated":null,"sidebarTitle":"order.paid","openapi":"/openapi/2027-01.openapi.json webhook order.paid","href":"/api-reference/2027-01/order_paid"},{"title":"order.updated","version":null,"deprecated":null,"sidebarTitle":"order.updated","openapi":"/openapi/2027-01.openapi.json webhook order.updated","href":"/api-reference/2027-01/order_updated"},{"title":"order.refunded","version":null,"deprecated":null,"sidebarTitle":"order.refunded","openapi":"/openapi/2027-01.openapi.json webhook order.refunded","href":"/api-reference/2027-01/order_refunded"}]},{"group":"Customer Seats","pages":[{"title":"customer_seat.assigned","version":null,"deprecated":null,"sidebarTitle":"customer_seat.assigned","openapi":"/openapi/2027-01.openapi.json webhook customer_seat.assigned","href":"/api-reference/2027-01/customer_seat_assigned"},{"title":"customer_seat.claimed","version":null,"deprecated":null,"sidebarTitle":"customer_seat.claimed","openapi":"/openapi/2027-01.openapi.json webhook customer_seat.claimed","href":"/api-reference/2027-01/customer_seat_claimed"},{"title":"customer_seat.revoked","version":null,"deprecated":null,"sidebarTitle":"customer_seat.revoked","openapi":"/openapi/2027-01.openapi.json webhook customer_seat.revoked","href":"/api-reference/2027-01/customer_seat_revoked"}]},{"group":"Refunds","pages":[{"title":"refund.created","version":null,"deprecated":null,"sidebarTitle":"refund.created","openapi":"/openapi/2027-01.openapi.json webhook refund.created","href":"/api-reference/2027-01/refund_created"},{"title":"refund.updated","version":null,"deprecated":null,"sidebarTitle":"refund.updated","openapi":"/openapi/2027-01.openapi.json webhook refund.updated","href":"/api-reference/2027-01/refund_updated"}]},{"group":"Benefit Grants","pages":[{"title":"benefit_grant.created","version":null,"deprecated":null,"sidebarTitle":"benefit_grant.created","openapi":"/openapi/2027-01.openapi.json webhook benefit_grant.created","href":"/api-reference/2027-01/benefit_grant_created"},{"title":"benefit_grant.cycled","version":null,"deprecated":null,"sidebarTitle":"benefit_grant.cycled","openapi":"/openapi/2027-01.openapi.json webhook benefit_grant.cycled","href":"/api-reference/2027-01/benefit_grant_cycled"},{"title":"benefit_grant.updated","version":null,"deprecated":null,"sidebarTitle":"benefit_grant.updated","openapi":"/openapi/2027-01.openapi.json webhook benefit_grant.updated","href":"/api-reference/2027-01/benefit_grant_updated"},{"title":"benefit_grant.revoked","version":null,"deprecated":null,"sidebarTitle":"benefit_grant.revoked","openapi":"/openapi/2027-01.openapi.json webhook benefit_grant.revoked","href":"/api-reference/2027-01/benefit_grant_revoked"}]}]},{"group":"Organization Events","pages":[{"group":"Benefits","pages":[{"title":"benefit.created","version":null,"deprecated":null,"sidebarTitle":"benefit.created","openapi":"/openapi/2027-01.openapi.json webhook benefit.created","href":"/api-reference/2027-01/benefit_created"},{"title":"benefit.updated","version":null,"deprecated":null,"sidebarTitle":"benefit.updated","openapi":"/openapi/2027-01.openapi.json webhook benefit.updated","href":"/api-reference/2027-01/benefit_updated"}]},{"group":"Products","pages":[{"title":"product.created","version":null,"deprecated":null,"sidebarTitle":"product.created","openapi":"/openapi/2027-01.openapi.json webhook product.created","href":"/api-reference/2027-01/product_created"},{"title":"product.updated","version":null,"deprecated":null,"sidebarTitle":"product.updated","openapi":"/openapi/2027-01.openapi.json webhook product.updated","href":"/api-reference/2027-01/product_updated"}]},{"group":"Discounts","pages":[{"title":"discount.created","version":null,"deprecated":null,"sidebarTitle":"discount.created","openapi":"/openapi/2027-01.openapi.json webhook discount.created","href":"/api-reference/2027-01/discount_created"},{"title":"discount.updated","version":null,"deprecated":null,"sidebarTitle":"discount.updated","openapi":"/openapi/2027-01.openapi.json webhook discount.updated","href":"/api-reference/2027-01/discount_updated"},{"title":"discount.deleted","version":null,"deprecated":null,"sidebarTitle":"discount.deleted","openapi":"/openapi/2027-01.openapi.json webhook discount.deleted","href":"/api-reference/2027-01/discount_deleted"}]},{"group":"Organization","pages":[{"title":"organization.updated","version":null,"deprecated":null,"sidebarTitle":"organization.updated","openapi":"/openapi/2027-01.openapi.json webhook organization.updated","href":"/api-reference/2027-01/organization_updated"}]}]}]},{"group":"Integrations","pages":[{"group":"OpenID Connect","pages":[{"title":"Authorize","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/oauth2/authorize","href":"/api-reference/2027-01/oauth2/authorize"},{"title":"Request Token","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/oauth2/token","href":"/api-reference/2027-01/oauth2/request-token"},{"title":"Introspect Token","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/oauth2/introspect","href":"/api-reference/2027-01/oauth2/introspect-token"},{"title":"Revoke Token","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/oauth2/revoke","href":"/api-reference/2027-01/oauth2/revoke-token"},{"title":"Get User Info","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/oauth2/userinfo","href":"/api-reference/2027-01/oauth2/get-user-info"},{"title":"Create Client","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/oauth2/register","href":"/api-reference/2027-01/oauth2/create-client"},{"title":"Get Client","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/oauth2/register/{client_id}","href":"/api-reference/2027-01/oauth2/get-client"},{"title":"Update Client","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json put /v1/oauth2/register/{client_id}","href":"/api-reference/2027-01/oauth2/update-client"},{"title":"Delete Client","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/oauth2/register/{client_id}","href":"/api-reference/2027-01/oauth2/delete-client"}]},{"group":"Webhooks","pages":[{"title":"Create Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/webhooks/endpoints","href":"/api-reference/2027-01/webhooks/create-webhook-endpoint"},{"title":"Get Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/webhooks/endpoints/{id}","href":"/api-reference/2027-01/webhooks/get-webhook-endpoint"},{"title":"List Webhook Endpoints","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/webhooks/endpoints","href":"/api-reference/2027-01/webhooks/list-webhook-endpoints"},{"title":"Update Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/webhooks/endpoints/{id}","href":"/api-reference/2027-01/webhooks/update-webhook-endpoint"},{"title":"Delete Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json delete /v1/webhooks/endpoints/{id}","href":"/api-reference/2027-01/webhooks/delete-webhook-endpoint"},{"title":"Get Webhook Endpoint by External ID","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/webhooks/endpoints/external/{external_id}","href":"/api-reference/2027-01/webhooks/get-webhook-endpoint-by-external-id"},{"title":"Reset Webhook Endpoint Secret","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json patch /v1/webhooks/endpoints/{id}/secret","href":"/api-reference/2027-01/webhooks/reset-webhook-endpoint-secret"},{"title":"List Webhook Deliveries","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json get /v1/webhooks/deliveries","href":"/api-reference/2027-01/webhooks/list-webhook-deliveries"},{"title":"Redeliver Webhook Event","deprecated":null,"version":null,"openapi":"/openapi/2027-01.openapi.json post /v1/webhooks/events/{id}/redeliver","href":"/api-reference/2027-01/webhooks/redeliver-webhook-event"}]}]}]}]},{"tab":"Changelog","icon":"signal-stream","pages":[{"title":"Changelog","href":"/changelog/recent"}]},{"tab":"Support","icon":"square-question","pages":[{"title":"Support","href":"/support"}]}]},"basePath":"","title":"List Payments - Polar","buildId":"dpl_eBQnj73Q1gDRVNqNsS3Yt9yPkTEW","deploymentId":"dpl_eBQnj73Q1gDRVNqNsS3Yt9yPkTEW","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-2eIonhLG.js","utils-Bu4fD7MA.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-Dm0-6XnC.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-75RmY7ol.js","snippetPresets-CNg6Wglv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-eOxp8mNS.js","ApiExamples-jSmPd6im.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CVrruHci.js","shallow-CebqfoNv.js","getApiPlaygroundDisplay-D2ytr59n.js","CodeSnippet-BVCHzyUV.js","CodeSnippets-C72k541i.js","getPastedJson-B0F9LVjA.js","icon-CGCgkOos.js","MethodPill-WJKpFOMR.js","DuplicateIcon-Dv5CTyCp.js","createIcon-B8Xc2y5i.js","DynamicMarkdown-CAm7Qzqi.js","SectionHeading-ACCZHDy_.js","axios-vUo_bRtp.js","Markdown-CHuW7TET.js","clsx-BhkiUDTS.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CNS0fiKw.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-D2_8dbQZ.js"]}