{"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":""},"chroma":{"liveDeploymentHistoryId":"6ada209b67b3b5d0ad9b9edc","collectionId":"dc2af58a-3120-4f5d-81d6-da0d31a07760","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada209b67b3b5d0ad9b9edc"},"feedback":{"edits":true,"thumbs":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ada209b67b3b5d0ad9b9edc","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":521},{"language":"default","tag":"Core API","count":287},{"language":"default","tag":"Docs","count":124},{"language":"default","tag":"Webhook Events","count":117},{"language":"default","tag":"Billing Events","count":81},{"language":"default","tag":"Customer Portal API","count":81},{"language":"default","tag":"Subscriptions","count":65},{"language":"default","tag":"Integrate","count":60},{"language":"default","tag":"Features","count":57},{"language":"default","tag":"Orders","count":48}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@polar.sh"}},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".chat-assistant-floating-input:is(.dark *)::before,.dark\\:bg-background-dark:is(.dark *){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:#fff;border:1px solid #e4e4e7;border-radius:1.25rem}.migration-coexistence__tree{max-width:28rem;margin:0 auto}.migration-coexistence__node{padding:.75rem .875rem;background:#fafafa;border:1px solid #e4e4e7;border-radius:.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:.8125rem;font-weight:700}.migration-coexistence__note{display:block;margin-top:.125rem;color:#71717a;font-size:.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:.875rem;line-height:1.55;text-align:center}.migration-switch{margin:1.5rem 0;overflow:hidden;background:#fff;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:.75rem 1rem;background:#fafafa;border-bottom:1px solid #e4e4e7;color:#18181b;font-size:.8125rem;font-weight:700}.migration-switch__header span:nth-child(2){color:#71717a;font-size:.6875rem;font-weight:600;letter-spacing:.06em;text-align:center;text-transform:uppercase}.migration-switch__header span:last-child{text-align:right}.migration-switch__row{min-height:4rem;padding:.75rem 1rem;color:#52525b;font-size:.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__caption,.dark .migration-coexistence__note{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:.8125rem}.migration-switch__header,.migration-switch__row{grid-template-columns:minmax(0,1fr) 2.5rem minmax(0,1fr);padding-right:.75rem;padding-left:.75rem}}@media (prefers-reduced-motion:reduce){.migration-coexistence__dot{display:none}}"}],"page":{"pagePath":"api-reference/2026-10/events/ingest-events","slug":"/api-reference/2026-10/events/ingest-events","pageMetadata":{"title":"Ingest Events","description":"Ingest batch of events.\n\n**Scopes**: `events:write`","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/events/ingest","href":"/api-reference/2026-10/events/ingest-events","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: \"Ingest batch of events.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Scopes\"\n }), \": \", _jsx(_components.code, {\n children: \"events:write\"\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":"Ingest Events","description":"Ingest batch of events.\n\n**Scopes**: `events:write`","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/events/ingest","href":"/api-reference/2026-10/events/ingest-events","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["events","public"],"summary":"Ingest Events","description":"Ingest batch of events.\n\n**Scopes**: `events:write`","operationId":"events:ingest","requestBody":"779855ff-8a8a-4eb6-a2d3-b7ddd5a6b74d","responses":{"200":"facaae10-2931-406e-b1b7-8ec375b441f0","422":"53346b84-ef31-4945-b078-c278722493e7"},"security":["dad319ce-7f9f-43f7-9e2d-7d0fca17c5c5","70414754-efb3-4f1e-b127-7aedbfb81601","fca0b23c-547d-4acd-95fe-cae2560c3a2c"],"x-polar-allowed-subjects":["Organization","User"],"x-speakeasy-group":"events","x-speakeasy-name-override":"ingest","x-codeSamples":[{"lang":"python","source":"from polar.v2026_10 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.events.ingest(\n events=[{'timestamp': '2026-01-01T00:00:00.000000Z',\n 'name': 'string',\n 'customer_id': '00000000-0000-4000-8000-000000000000'}],\n)\nprint(response)\n"},{"lang":"typescript","source":"import { createPolar } from \"@polar-sh/sdk/2026-10\";\n\nconst polar = createPolar({\n accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.events.ingest(\n {\n \"events\": [\n {\n \"timestamp\": \"2026-01-01T00:00:00.000000Z\",\n \"name\": \"string\",\n \"customer_id\": \"00000000-0000-4000-8000-000000000000\"\n }\n ]\n },\n);\nconsole.log(response);\n"}],"method":"post","type":"path","servers":["0a3cfd4b-9634-4505-9004-41aa566b6b35","81edcbdc-9117-4d62-9bcc-a4eb8c29ac19"],"path":"/v1/events/ingest","baseUrlOptions":["https://api.polar.sh","https://sandbox-api.polar.sh"],"title":"Ingest Events","codeSamples":[{"lang":"python","source":"from polar.v2026_10 import Polar\n\npolar = Polar(\"polar_oat_xxx\")\n\nresponse = polar.events.ingest(\n events=[{'timestamp': '2026-01-01T00:00:00.000000Z',\n 'name': 'string',\n 'customer_id': '00000000-0000-4000-8000-000000000000'}],\n)\nprint(response)\n"},{"lang":"typescript","source":"import { createPolar } from \"@polar-sh/sdk/2026-10\";\n\nconst polar = createPolar({\n accessToken: \"polar_oat_xxx\",\n});\n\nconst response = await polar.events.ingest(\n {\n \"events\": [\n {\n \"timestamp\": \"2026-01-01T00:00:00.000000Z\",\n \"name\": \"string\",\n \"customer_id\": \"00000000-0000-4000-8000-000000000000\"\n }\n ]\n },\n);\nconsole.log(response);\n"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"events":{"items":{"oneOf":[{"type":"object","title":"EventCreateCustomer","required":["name","customer_id"],"properties":{"name":{"type":"string","maxLength":128,"title":"Name","description":"The name of the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.name","typeLabel":"string"},"customer_id":{"type":"string","format":"uuid4","title":"Customer Id","description":"ID of the customer in your Polar organization associated with the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.customer_id","typeLabel":"string\u003cuuid4>"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"The timestamp of the event.","examples":["2026-01-01T00:00:00.000000Z"],"uniqueKey":"events.items.[INDEX].oneOf.0.timestamp","typeLabel":"string\u003cdate-time>"},"organization_id":{"oneOf":[{"type":"string","title":"Organization Id","description":"The organization ID.","format":"uuid4","example":"1dbfc517-0bbf-4301-9ba8-555ca42b9737","uniqueKey":"events.items.[INDEX].oneOf.0.organization_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Organization Id","description":"The ID of the organization owning the event. **Required unless you use an organization token.**","uniqueKey":"events.items.[INDEX].oneOf.0.organization_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].oneOf.0.organization_id","typeLabel":"string\u003cuuid4> | null"},"external_id":{"oneOf":[{"type":"string","title":"External Id","description":"Your unique identifier for this event. Useful for deduplication and parent-child relationships.","uniqueKey":"events.items.[INDEX].oneOf.0.external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Id","description":"Your unique identifier for this event. Useful for deduplication and parent-child relationships.","uniqueKey":"events.items.[INDEX].oneOf.0.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].oneOf.0.external_id","typeLabel":"string | null"},"parent_id":{"oneOf":[{"type":"string","title":"Parent Id","description":"The ID of the parent event. Can be either a Polar event ID (UUID) or an external event ID.","uniqueKey":"events.items.[INDEX].oneOf.0.parent_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent Id","description":"The ID of the parent event. Can be either a Polar event ID (UUID) or an external event ID.","uniqueKey":"events.items.[INDEX].oneOf.0.parent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].oneOf.0.parent_id","typeLabel":"string | null"},"metadata":{"properties":{"_cost":{"properties":{"amount":{"oneOf":[{"type":"number","title":"Amount","description":"The amount in cents.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.metadata._cost.amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Amount","description":"The amount in cents.","pattern":"^(?!^[-+.]*$)[+-]?0*(?:\\d{0,5}|(?=[\\d.]{1,18}0*$)\\d{0,5}\\.\\d{0,12}0*$)","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.metadata._cost.amount.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.metadata._cost.amount","typeLabel":"number | string"},"currency":{"type":"string","pattern":"usd","title":"Currency","description":"The currency. Currently, only `usd` is supported.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.metadata._cost.currency","typeLabel":"string"}},"type":"object","required":["amount","currency"],"title":"CostMetadata","uniqueKey":"events.items.[INDEX].oneOf.0.metadata._cost","typeLabel":"CostMetadata · object"},"_llm":{"properties":{"vendor":{"type":"string","title":"Vendor","description":"The vendor of the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.metadata._llm.vendor","typeLabel":"string"},"model":{"type":"string","title":"Model","description":"The model used for the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.metadata._llm.model","typeLabel":"string"},"input_tokens":{"type":"integer","title":"Input Tokens","description":"The number of LLM input tokens used for the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.metadata._llm.input_tokens","typeLabel":"integer"},"output_tokens":{"type":"integer","title":"Output Tokens","description":"The number of LLM output tokens used for the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.metadata._llm.output_tokens","typeLabel":"integer"},"total_tokens":{"type":"integer","title":"Total Tokens","description":"The total number of LLM tokens used for the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.metadata._llm.total_tokens","typeLabel":"integer"},"prompt":{"oneOf":[{"type":"string","title":"Prompt","description":"The LLM prompt used for the event.","uniqueKey":"events.items.[INDEX].oneOf.0.metadata._llm.prompt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Prompt","description":"The LLM prompt used for the event.","uniqueKey":"events.items.[INDEX].oneOf.0.metadata._llm.prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].oneOf.0.metadata._llm.prompt","typeLabel":"string | null"},"response":{"oneOf":[{"type":"string","title":"Response","description":"The LLM response used for the event.","uniqueKey":"events.items.[INDEX].oneOf.0.metadata._llm.response.oneOf.0","typeLabel":"string"},{"type":"null","title":"Response","description":"The LLM response used for the event.","uniqueKey":"events.items.[INDEX].oneOf.0.metadata._llm.response.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].oneOf.0.metadata._llm.response","typeLabel":"string | null"},"cached_input_tokens":{"type":"integer","title":"Cached Input Tokens","description":"The number of LLM cached tokens that were used for the event.","uniqueKey":"events.items.[INDEX].oneOf.0.metadata._llm.cached_input_tokens","typeLabel":"integer"}},"type":"object","required":["vendor","model","input_tokens","output_tokens","total_tokens"],"title":"LLMMetadata","uniqueKey":"events.items.[INDEX].oneOf.0.metadata._llm","typeLabel":"LLMMetadata · object"}},"additionalProperties":{"oneOf":[{"type":"string","maxLength":500,"minLength":1,"uniqueKey":"events.items.[INDEX].oneOf.0.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"events.items.[INDEX].oneOf.0.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"events.items.[INDEX].oneOf.0.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"events.items.[INDEX].oneOf.0.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"events.items.[INDEX].oneOf.0.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","title":"EventMetadataInput","description":"Key-value object allowing you to store additional information about the event. Some keys like `_llm` are structured data that are handled specially by Polar.\n\nThe key must be a string with a maximum length of **40 characters**.\nThe value must be either:\n\n* A string with a maximum length of **500 characters**\n* An integer\n* A floating-point number\n* A boolean\n\nYou can store up to **50 key-value pairs**.","uniqueKey":"events.items.[INDEX].oneOf.0.metadata","typeLabel":"EventMetadataInput · object"},"member_id":{"oneOf":[{"type":"string","title":"Member Id","description":"ID of the member within the customer's organization who performed the action. Used for member-level attribution in B2B.","format":"uuid4","uniqueKey":"events.items.[INDEX].oneOf.0.member_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Member Id","description":"ID of the member within the customer's organization who performed the action. Used for member-level attribution in B2B.","uniqueKey":"events.items.[INDEX].oneOf.0.member_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].oneOf.0.member_id","typeLabel":"string\u003cuuid4> | null"}},"uniqueKey":"events.items.[INDEX].oneOf.0","typeLabel":"EventCreateCustomer · object"},{"type":"object","title":"EventCreateExternalCustomer","required":["name","external_customer_id"],"properties":{"name":{"type":"string","maxLength":128,"title":"Name","description":"The name of the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.name","typeLabel":"string"},"external_customer_id":{"type":"string","title":"External Customer Id","description":"ID of the customer in your system associated with the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.external_customer_id","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"The timestamp of the event.","examples":["2026-01-01T00:00:00.000000Z"],"uniqueKey":"events.items.[INDEX].oneOf.1.timestamp","typeLabel":"string\u003cdate-time>"},"organization_id":{"oneOf":[{"type":"string","title":"Organization Id","description":"The organization ID.","format":"uuid4","example":"1dbfc517-0bbf-4301-9ba8-555ca42b9737","uniqueKey":"events.items.[INDEX].oneOf.1.organization_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Organization Id","description":"The ID of the organization owning the event. **Required unless you use an organization token.**","uniqueKey":"events.items.[INDEX].oneOf.1.organization_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].oneOf.1.organization_id","typeLabel":"string\u003cuuid4> | null"},"external_id":{"oneOf":[{"type":"string","title":"External Id","description":"Your unique identifier for this event. Useful for deduplication and parent-child relationships.","uniqueKey":"events.items.[INDEX].oneOf.1.external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Id","description":"Your unique identifier for this event. Useful for deduplication and parent-child relationships.","uniqueKey":"events.items.[INDEX].oneOf.1.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].oneOf.1.external_id","typeLabel":"string | null"},"parent_id":{"oneOf":[{"type":"string","title":"Parent Id","description":"The ID of the parent event. Can be either a Polar event ID (UUID) or an external event ID.","uniqueKey":"events.items.[INDEX].oneOf.1.parent_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent Id","description":"The ID of the parent event. Can be either a Polar event ID (UUID) or an external event ID.","uniqueKey":"events.items.[INDEX].oneOf.1.parent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].oneOf.1.parent_id","typeLabel":"string | null"},"metadata":{"properties":{"_cost":{"properties":{"amount":{"oneOf":[{"type":"number","title":"Amount","description":"The amount in cents.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.metadata._cost.amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Amount","description":"The amount in cents.","pattern":"^(?!^[-+.]*$)[+-]?0*(?:\\d{0,5}|(?=[\\d.]{1,18}0*$)\\d{0,5}\\.\\d{0,12}0*$)","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.metadata._cost.amount.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.metadata._cost.amount","typeLabel":"number | string"},"currency":{"type":"string","pattern":"usd","title":"Currency","description":"The currency. Currently, only `usd` is supported.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.metadata._cost.currency","typeLabel":"string"}},"type":"object","required":["amount","currency"],"title":"CostMetadata","uniqueKey":"events.items.[INDEX].oneOf.1.metadata._cost","typeLabel":"CostMetadata · object"},"_llm":{"properties":{"vendor":{"type":"string","title":"Vendor","description":"The vendor of the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.metadata._llm.vendor","typeLabel":"string"},"model":{"type":"string","title":"Model","description":"The model used for the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.metadata._llm.model","typeLabel":"string"},"input_tokens":{"type":"integer","title":"Input Tokens","description":"The number of LLM input tokens used for the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.metadata._llm.input_tokens","typeLabel":"integer"},"output_tokens":{"type":"integer","title":"Output Tokens","description":"The number of LLM output tokens used for the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.metadata._llm.output_tokens","typeLabel":"integer"},"total_tokens":{"type":"integer","title":"Total Tokens","description":"The total number of LLM tokens used for the event.","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.metadata._llm.total_tokens","typeLabel":"integer"},"prompt":{"oneOf":[{"type":"string","title":"Prompt","description":"The LLM prompt used for the event.","uniqueKey":"events.items.[INDEX].oneOf.1.metadata._llm.prompt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Prompt","description":"The LLM prompt used for the event.","uniqueKey":"events.items.[INDEX].oneOf.1.metadata._llm.prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].oneOf.1.metadata._llm.prompt","typeLabel":"string | null"},"response":{"oneOf":[{"type":"string","title":"Response","description":"The LLM response used for the event.","uniqueKey":"events.items.[INDEX].oneOf.1.metadata._llm.response.oneOf.0","typeLabel":"string"},{"type":"null","title":"Response","description":"The LLM response used for the event.","uniqueKey":"events.items.[INDEX].oneOf.1.metadata._llm.response.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].oneOf.1.metadata._llm.response","typeLabel":"string | null"},"cached_input_tokens":{"type":"integer","title":"Cached Input Tokens","description":"The number of LLM cached tokens that were used for the event.","uniqueKey":"events.items.[INDEX].oneOf.1.metadata._llm.cached_input_tokens","typeLabel":"integer"}},"type":"object","required":["vendor","model","input_tokens","output_tokens","total_tokens"],"title":"LLMMetadata","uniqueKey":"events.items.[INDEX].oneOf.1.metadata._llm","typeLabel":"LLMMetadata · object"}},"additionalProperties":{"oneOf":[{"type":"string","maxLength":500,"minLength":1,"uniqueKey":"events.items.[INDEX].oneOf.1.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"events.items.[INDEX].oneOf.1.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"events.items.[INDEX].oneOf.1.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"events.items.[INDEX].oneOf.1.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"events.items.[INDEX].oneOf.1.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","title":"EventMetadataInput","description":"Key-value object allowing you to store additional information about the event. Some keys like `_llm` are structured data that are handled specially by Polar.\n\nThe key must be a string with a maximum length of **40 characters**.\nThe value must be either:\n\n* A string with a maximum length of **500 characters**\n* An integer\n* A floating-point number\n* A boolean\n\nYou can store up to **50 key-value pairs**.","uniqueKey":"events.items.[INDEX].oneOf.1.metadata","typeLabel":"EventMetadataInput · object"},"external_member_id":{"oneOf":[{"type":"string","title":"External Member Id","description":"ID of the member in your system within the customer's organization who performed the action. Used for member-level attribution in B2B.","uniqueKey":"events.items.[INDEX].oneOf.1.external_member_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Member Id","description":"ID of the member in your system within the customer's organization who performed the action. Used for member-level attribution in B2B.","uniqueKey":"events.items.[INDEX].oneOf.1.external_member_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].oneOf.1.external_member_id","typeLabel":"string | null"}},"uniqueKey":"events.items.[INDEX].oneOf.1","typeLabel":"EventCreateExternalCustomer · object"}],"uniqueKey":"events.items.[INDEX]","typeLabel":"EventCreateCustomer · object | EventCreateExternalCustomer · object"},"type":"array","title":"Events","description":"List of events to ingest.","isRequired":true,"uniqueKey":"events","typeLabel":"(EventCreateCustomer · object | EventCreateExternalCustomer · object)[]"}},"type":"object","required":["events"],"title":"EventsIngest","uniqueKey":"","typeLabel":"EventsIngest · object"},"examples":{"Example":{"title":"Example","value":{"events":[{"name":"\u003cstring>","customer_id":"\u003cstring>","timestamp":"2026-01-01T00:00:00.000000Z","organization_id":"1dbfc517-0bbf-4301-9ba8-555ca42b9737","external_id":"\u003cstring>","parent_id":"\u003cstring>","metadata":{},"member_id":"\u003cstring>"}]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"facaae10-2931-406e-b1b7-8ec375b441f0":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"inserted":{"type":"integer","title":"Inserted","description":"Number of events inserted.","isRequired":true,"uniqueKey":"inserted","typeLabel":"integer"},"duplicates":{"type":"integer","title":"Duplicates","description":"Number of duplicate events skipped.","default":0,"uniqueKey":"duplicates","typeLabel":"integer"}},"type":"object","required":["inserted"],"title":"EventsIngestResponse","uniqueKey":"","typeLabel":"EventsIngestResponse · object"},"examples":{"Example":{"title":"Example","value":{"inserted":123,"duplicates":0}}},"exampleType":"generated"}},"exampleType":"generated"},"53346b84-ef31-4945-b078-c278722493e7":{"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":{"dad319ce-7f9f-43f7-9e2d-7d0fca17c5c5":{"oidc":{"type":"openIdConnect","openIdConnectUrl":"/.well-known/openid-configuration","scopes":["events:write"],"schemeName":"oidc"}},"70414754-efb3-4f1e-b127-7aedbfb81601":{"pat":{"type":"http","description":"You can generate a **Personal Access Token** from your [settings](https://polar.sh/settings).","scheme":"bearer","scopes":["events:write"],"schemeName":"pat"}},"fca0b23c-547d-4acd-95fe-cae2560c3a2c":{"oat":{"type":"http","description":"You can generate an **Organization Access Token** from your organization's settings.","scheme":"bearer","scopes":["events:write"],"schemeName":"oat"}}},"servers":{"0a3cfd4b-9634-4505-9004-41aa566b6b35":{"url":"https://api.polar.sh","description":"Production environment","x-speakeasy-server-id":"production","x-polar-environment":"production"},"81edcbdc-9117-4d62-9bcc-a4eb8c29ac19":{"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":["events:write"],"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":["events:write"],"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/2026-10.openapi.json"},"subdomain":"polar","siteName":"Polar","title":"Ingest Events - Polar","navMaps":{"firstHrefInVersion":{"2026-04":{"href":"/api-reference/2026-04/events/ingest-events","matchLevel":1},"2026-10":{"href":"/api-reference/2026-10/events/ingest-events","matchLevel":0},"2027-01":{"href":"/api-reference/2027-01/events/ingest-events","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-10-19T15:30:38.982Z","originalFileLocation":"api-reference/2026-10/events/ingest-events.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=\"Ingest batch of events. Scopes: events:write\">\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=\"Ingest Events - Polar\">\u003cmeta data-mint-head property=\"og:description\" content=\"Ingest batch of events. Scopes: events:write\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Polar\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://polar.sh/docs/api-reference/2026-10/events/ingest-events\">\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=\"Ingest Events - Polar\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Ingest batch of events. Scopes: events:write\">\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/2026-10/events/ingest-events\">\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/2026-10/events/ingest-events.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/2026-10/events/ingest-events#webpage\",\"url\":\"https://polar.sh/docs/api-reference/2026-10/events/ingest-events\",\"name\":\"Ingest Events\",\"description\":\"Ingest batch of events. Scopes: events:write\",\"dateModified\":\"2026-10-19T15:30:38.982Z\",\"isPartOf\":{\"@id\":\"https://polar.sh/docs#website\"},\"breadcrumb\":{\"@id\":\"https://polar.sh/docs/api-reference/2026-10/events/ingest-events#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://polar.sh/docs/api-reference/2026-10/events/ingest-events#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core API\",\"item\":\"https://polar.sh/docs/api-reference/2026-10/checkouts/create-checkout-session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Ingest Events\",\"item\":\"https://polar.sh/docs/api-reference/2026-10/events/ingest-events\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://polar.sh/docs/api-reference/2026-10/events/ingest-events#apireference\",\"headline\":\"Ingest Events\",\"name\":\"Ingest Events\",\"description\":\"Ingest batch of events. Scopes: events:write\",\"url\":\"https://polar.sh/docs/api-reference/2026-10/events/ingest-events\",\"mainEntityOfPage\":{\"@id\":\"https://polar.sh/docs/api-reference/2026-10/events/ingest-events#webpage\"},\"image\":\"https://polar.sh/assets/brand/polar_og.jpg\",\"dateModified\":\"2026-10-19T15:30:38.982Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Polar","nav":{"global":null,"tabs":[{"tab":"Docs","icon":"compass","pages":[{"title":"Docs","href":"/introduction"}]},{"tab":"API Reference","icon":"rectangle-terminal","versions":[{"version":"2026-04","tag":"Deprecated","pages":[{"title":"2026-04","href":"/api-reference/2026-04/events/ingest-events"}]},{"version":"2026-10","default":true,"tag":"Current","groups":[{"group":"General","pages":[{"title":"API Overview","sidebarTitle":"Introduction","href":"/api-reference/2026-10/introduction"},{"title":"API Versioning","sidebarTitle":"Versioning","href":"/api-reference/2026-10/versioning"}]},{"group":"Core API","pages":[{"group":"Checkout","pages":[{"title":"Create Checkout Session","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/checkouts/","href":"/api-reference/2026-10/checkouts/create-checkout-session"},{"title":"Get Checkout Session","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/checkouts/{id}","href":"/api-reference/2026-10/checkouts/get-checkout-session"},{"title":"List Checkout Sessions","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/checkouts/","href":"/api-reference/2026-10/checkouts/list-checkout-sessions"},{"title":"Update Checkout Session","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/checkouts/{id}","href":"/api-reference/2026-10/checkouts/update-checkout-session"},{"title":"Get Checkout Session from Client","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/checkouts/client/{client_secret}","href":"/api-reference/2026-10/checkouts/get-checkout-session-from-client"},{"title":"Update Checkout Session from Client","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/checkouts/client/{client_secret}","href":"/api-reference/2026-10/checkouts/update-checkout-session-from-client"},{"title":"Confirm Checkout Session from Client","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/checkouts/client/{client_secret}/confirm","href":"/api-reference/2026-10/checkouts/confirm-checkout-session-from-client"}]},{"group":"Checkout Links","pages":[{"title":"Create Checkout Link","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/checkout-links/","href":"/api-reference/2026-10/checkout-links/create-checkout-link"},{"title":"Get Checkout Link","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/checkout-links/{id}","href":"/api-reference/2026-10/checkout-links/get-checkout-link"},{"title":"List Checkout Links","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/checkout-links/","href":"/api-reference/2026-10/checkout-links/list-checkout-links"},{"title":"Update Checkout Link","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/checkout-links/{id}","href":"/api-reference/2026-10/checkout-links/update-checkout-link"},{"title":"Delete Checkout Link","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/checkout-links/{id}","href":"/api-reference/2026-10/checkout-links/delete-checkout-link"}]},{"group":"Custom Checkout Fields","pages":[{"title":"Create Custom Field","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/custom-fields/","href":"/api-reference/2026-10/custom-fields/create-custom-field"},{"title":"Get Custom Field","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/custom-fields/{id}","href":"/api-reference/2026-10/custom-fields/get-custom-field"},{"title":"List Custom Fields","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/custom-fields/","href":"/api-reference/2026-10/custom-fields/list-custom-fields"},{"title":"Update Custom Field","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/custom-fields/{id}","href":"/api-reference/2026-10/custom-fields/update-custom-field"},{"title":"Delete Custom Field","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/custom-fields/{id}","href":"/api-reference/2026-10/custom-fields/delete-custom-field"}]},{"group":"Customers","pages":[{"title":"Get Customer State","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/{id}/state","href":"/api-reference/2026-10/customers/get-customer-state"},{"title":"Get Customer State by External ID","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/external/{external_id}/state","href":"/api-reference/2026-10/customers/get-customer-state-by-external-id"},{"title":"List Customers","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/","href":"/api-reference/2026-10/customers/list-customers"},{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customers/","href":"/api-reference/2026-10/customers/create-customer"},{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/{id}","href":"/api-reference/2026-10/customers/get-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/customers/{id}","href":"/api-reference/2026-10/customers/update-customer"},{"title":"Delete Customer","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/customers/{id}","href":"/api-reference/2026-10/customers/delete-customer"},{"title":"Get Customer by External ID","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/external/{external_id}","href":"/api-reference/2026-10/customers/get-customer-by-external-id"},{"title":"Update Customer by External ID","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/customers/external/{external_id}","href":"/api-reference/2026-10/customers/update-customer-by-external-id"},{"title":"Delete Customer by External ID","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/customers/external/{external_id}","href":"/api-reference/2026-10/customers/delete-customer-by-external-id"},{"title":"List Customer Payment Methods","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/{id}/payment-methods","href":"/api-reference/2026-10/customers/list-customer-payment-methods"},{"title":"List Customer Payment Methods by External ID","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/external/{external_id}/payment-methods","href":"/api-reference/2026-10/customers/list-customer-payment-methods-by-external-id"}]},{"group":"Subscriptions","pages":[{"title":"Get Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/subscriptions/{id}","href":"/api-reference/2026-10/subscriptions/get-subscription"},{"title":"List Subscriptions","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/subscriptions/","href":"/api-reference/2026-10/subscriptions/list-subscriptions"},{"title":"Create Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/subscriptions/","href":"/api-reference/2026-10/subscriptions/create-subscription"},{"title":"Update Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/subscriptions/{id}","href":"/api-reference/2026-10/subscriptions/update-subscription"},{"title":"Revoke Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/subscriptions/{id}","href":"/api-reference/2026-10/subscriptions/revoke-subscription"}]},{"group":"Orders","pages":[{"title":"Get Order","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/orders/{id}","href":"/api-reference/2026-10/orders/get-order"},{"title":"Update Order","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/orders/{id}","href":"/api-reference/2026-10/orders/update-order"},{"title":"List Orders","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/orders/","href":"/api-reference/2026-10/orders/list-orders"},{"title":"Generate Order Invoice","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/orders/{id}/invoice","href":"/api-reference/2026-10/orders/generate-order-invoice"},{"title":"Get Order Invoice","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/orders/{id}/invoice","href":"/api-reference/2026-10/orders/get-order-invoice"},{"title":"Get Order Receipt","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/orders/{id}/receipt","href":"/api-reference/2026-10/orders/get-order-receipt"}]},{"group":"Discounts","pages":[{"title":"Get Discount","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/discounts/{id}","href":"/api-reference/2026-10/discounts/get-discount"},{"title":"List Discounts","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/discounts/","href":"/api-reference/2026-10/discounts/list-discounts"},{"title":"Create Discount","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/discounts/","href":"/api-reference/2026-10/discounts/create-discount"},{"title":"Update Discount","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/discounts/{id}","href":"/api-reference/2026-10/discounts/update-discount"},{"title":"Delete Discount","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/discounts/{id}","href":"/api-reference/2026-10/discounts/delete-discount"}]},{"group":"Refunds","pages":[{"title":"Create Refund","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/refunds/","href":"/api-reference/2026-10/refunds/create-refund"},{"title":"List Refunds","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/refunds/","href":"/api-reference/2026-10/refunds/list-refunds"}]},{"group":"Products","pages":[{"title":"Get Product","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/products/{id}","href":"/api-reference/2026-10/products/get-product"},{"title":"List Products","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/products/","href":"/api-reference/2026-10/products/list-products"},{"title":"Create Product","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/products/","href":"/api-reference/2026-10/products/create-product"},{"title":"Update Product","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/products/{id}","href":"/api-reference/2026-10/products/update-product"},{"title":"Delete Product","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/products/{id}","href":"/api-reference/2026-10/products/delete-product"},{"title":"Update Product Benefits","description":"Update benefits granted by a product.\n\n**Scopes**: `products:write`","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/products/{id}/benefits","href":"/api-reference/2026-10/products/update-product-benefits"}]},{"group":"Events","pages":[{"title":"Ingest Events","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/events/ingest","href":"/api-reference/2026-10/events/ingest-events"},{"title":"Get Event","description":"Get an event by ID.\n\n**Scopes**: `events:read` `events:write`","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/events/{id}","href":"/api-reference/2026-10/events/get-event"},{"title":"List Events","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/events/","href":"/api-reference/2026-10/events/list-events"}]},{"group":"Meters","pages":[{"title":"Create Meter","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/meters/","href":"/api-reference/2026-10/meters/create-meter"},{"title":"Get Meter","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/meters/{id}","href":"/api-reference/2026-10/meters/get-meter"},{"title":"List Meters","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/meters/","href":"/api-reference/2026-10/meters/list-meters"},{"title":"Update Meter","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/meters/{id}","href":"/api-reference/2026-10/meters/update-meter"},{"title":"Get Meter Quantities","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/meters/{id}/quantities","href":"/api-reference/2026-10/meters/get-meter-quantities"}]},{"group":"Benefits","pages":[{"title":"Create Benefit","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/benefits/","href":"/api-reference/2026-10/benefits/create-benefit"},{"title":"Get Benefit","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/benefits/{id}","href":"/api-reference/2026-10/benefits/get-benefit"},{"title":"List Benefits","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/benefits/","href":"/api-reference/2026-10/benefits/list-benefits"},{"title":"List Benefit Grants","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/benefits/{id}/grants","href":"/api-reference/2026-10/benefits/list-benefit-grants"},{"title":"Update Benefit","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/benefits/{id}","href":"/api-reference/2026-10/benefits/update-benefit"},{"title":"Delete Benefit","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/benefits/{id}","href":"/api-reference/2026-10/benefits/delete-benefit"}]},{"group":"Customer Meters","pages":[{"title":"Get Customer Meter","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-meters/{id}","href":"/api-reference/2026-10/customer_meters/get-customer-meter"},{"title":"List Customer Meters","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-meters/","href":"/api-reference/2026-10/customer_meters/list-customer-meters"}]},{"group":"License Keys","pages":[{"title":"Get License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/license-keys/{id}","href":"/api-reference/2026-10/license_keys/get-license-key"},{"title":"List License Keys","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/license-keys/","href":"/api-reference/2026-10/license_keys/list-license-keys"},{"title":"Update License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/license-keys/{id}","href":"/api-reference/2026-10/license_keys/update-license-key"},{"title":"Get Activation","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/license-keys/{id}/activations/{activation_id}","href":"/api-reference/2026-10/license_keys/get-activation"},{"title":"Validate License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/license-keys/validate","href":"/api-reference/2026-10/license_keys/validate-license-key"},{"title":"Activate License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/license-keys/activate","href":"/api-reference/2026-10/license_keys/activate-license-key"},{"title":"Deactivate License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/license-keys/deactivate","href":"/api-reference/2026-10/license_keys/deactivate-license-key"}]},{"group":"Members","pages":[{"title":"List Members","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/{id}/members","href":"/api-reference/2026-10/customers/list-members"},{"title":"List Members by Customer External ID","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customers/external/{external_id}/members","href":"/api-reference/2026-10/customers/list-members-by-customer-external-id"}]},{"group":"Customer Seats","pages":[{"title":"Assign Seat","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-seats","href":"/api-reference/2026-10/customer-seats/assign-seat"},{"title":"List Seats","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-seats","href":"/api-reference/2026-10/customer-seats/list-seats"},{"title":"Revoke Seat","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/customer-seats/{seat_id}","href":"/api-reference/2026-10/customer-seats/revoke-seat"},{"title":"Resend Invitation","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-seats/{seat_id}/resend","href":"/api-reference/2026-10/customer-seats/resend-invitation"},{"title":"Get Claim Info","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-seats/claim/{invitation_token}","href":"/api-reference/2026-10/customer-seats/get-claim-info"},{"title":"Claim Seat","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-seats/claim","href":"/api-reference/2026-10/customer-seats/claim-seat"}]},{"group":"Files","pages":[{"title":"Create File","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/files/","href":"/api-reference/2026-10/files/create-file"},{"title":"List Files","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/files/","href":"/api-reference/2026-10/files/list-files"},{"title":"Update File","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/files/{id}","href":"/api-reference/2026-10/files/update-file"},{"title":"Delete File","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/files/{id}","href":"/api-reference/2026-10/files/delete-file"},{"title":"Complete File Upload","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/files/{id}/uploaded","href":"/api-reference/2026-10/files/complete-file-upload"}]},{"group":"Organizations","pages":[{"title":"Get Organization","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/organizations/{id}","href":"/api-reference/2026-10/organizations/get-organization"},{"title":"List Organizations","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/organizations/","href":"/api-reference/2026-10/organizations/list-organizations"},{"title":"Create Organization","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/organizations/","href":"/api-reference/2026-10/organizations/create-organization"},{"title":"Update Organization","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/organizations/{id}","href":"/api-reference/2026-10/organizations/update-organization"}]},{"group":"Metrics","pages":[{"title":"Get Metrics","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/metrics/","href":"/api-reference/2026-10/metrics/get-metrics"},{"title":"Get Metrics Limits","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/metrics/limits","href":"/api-reference/2026-10/metrics/get-metrics-limits"}]}]},{"group":"Customer Portal API","pages":[{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/customers/me","href":"/api-reference/2026-10/customer_portal/get-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/customer-portal/customers/me","href":"/api-reference/2026-10/customer_portal/update-customer"},{"title":"Get Organization","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/organizations/{slug}","href":"/api-reference/2026-10/customer_portal/get-organization"},{"group":"Sessions","pages":[{"title":"Create Customer Session","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-sessions/","href":"/api-reference/2026-10/customer-sessions/create-customer-session"}]},{"group":"Subscriptions","pages":[{"title":"Get Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/subscriptions/{id}","href":"/api-reference/2026-10/customer_portal/get-subscription"},{"title":"List Subscriptions","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/subscriptions/","href":"/api-reference/2026-10/customer_portal/list-subscriptions"},{"title":"Update Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/customer-portal/subscriptions/{id}","href":"/api-reference/2026-10/customer_portal/update-subscription"},{"title":"Cancel Subscription","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/customer-portal/subscriptions/{id}","href":"/api-reference/2026-10/customer_portal/cancel-subscription"}]},{"group":"Orders","pages":[{"title":"Get Order","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/orders/{id}","href":"/api-reference/2026-10/customer_portal/get-order"},{"title":"Update Order","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/customer-portal/orders/{id}","href":"/api-reference/2026-10/customer_portal/update-order"},{"title":"List Orders","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/orders/","href":"/api-reference/2026-10/customer_portal/list-orders"},{"title":"Generate Order Invoice","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-portal/orders/{id}/invoice","href":"/api-reference/2026-10/customer_portal/generate-order-invoice"},{"title":"Get Order Invoice","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/orders/{id}/invoice","href":"/api-reference/2026-10/customer_portal/get-order-invoice"},{"title":"Get Order Receipt","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/orders/{id}/receipt","href":"/api-reference/2026-10/customer_portal/get-order-receipt"}]},{"group":"License Keys","pages":[{"title":"Validate License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-portal/license-keys/validate","href":"/api-reference/2026-10/customer_portal/validate-license-key"},{"title":"Activate License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-portal/license-keys/activate","href":"/api-reference/2026-10/customer_portal/activate-license-key"},{"title":"Deactivate License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-portal/license-keys/deactivate","href":"/api-reference/2026-10/customer_portal/deactivate-license-key"},{"title":"Get License Key","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/license-keys/{id}","href":"/api-reference/2026-10/customer_portal/get-license-key"},{"title":"List License Keys","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/license-keys/","href":"/api-reference/2026-10/customer_portal/list-license-keys"}]},{"group":"File Downloads","pages":[{"title":"List Downloadables","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/downloadables/","href":"/api-reference/2026-10/customer_portal/list-downloadables"}]},{"group":"Seats","pages":[{"title":"List Seats","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/seats","href":"/api-reference/2026-10/customer_portal/list-seats"},{"title":"Assign Seat","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-portal/seats","href":"/api-reference/2026-10/customer_portal/assign-seat"},{"title":"Revoke Seat","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/customer-portal/seats/{seat_id}","href":"/api-reference/2026-10/customer_portal/revoke-seat"},{"title":"Resend Invitation","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/customer-portal/seats/{seat_id}/resend","href":"/api-reference/2026-10/customer_portal/resend-invitation"},{"title":"List Claimed Subscriptions","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/seats/subscriptions","href":"/api-reference/2026-10/customer_portal/list-claimed-subscriptions"}]},{"group":"Payment Methods","pages":[{"title":"List Customer Payment Methods","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/customer-portal/customers/me/payment-methods","href":"/api-reference/2026-10/customer_portal/list-customer-payment-methods"},{"title":"Delete Customer Payment Method","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/customer-portal/customers/me/payment-methods/{id}","href":"/api-reference/2026-10/customer_portal/delete-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/2026-10.openapi.json webhook customer.state_changed","href":"/api-reference/2026-10/customer_state_changed"},{"title":"customer.created","version":null,"deprecated":null,"sidebarTitle":"customer.created","openapi":"/openapi/2026-10.openapi.json webhook customer.created","href":"/api-reference/2026-10/customer_created"},{"title":"customer.updated","version":null,"deprecated":null,"sidebarTitle":"customer.updated","openapi":"/openapi/2026-10.openapi.json webhook customer.updated","href":"/api-reference/2026-10/customer_updated"},{"title":"customer.deleted","version":null,"deprecated":null,"sidebarTitle":"customer.deleted","openapi":"/openapi/2026-10.openapi.json webhook customer.deleted","href":"/api-reference/2026-10/customer_deleted"}]},{"group":"Billing Events","pages":[{"group":"Checkout","pages":[{"title":"checkout.created","version":null,"deprecated":null,"sidebarTitle":"checkout.created","openapi":"/openapi/2026-10.openapi.json webhook checkout.created","href":"/api-reference/2026-10/checkout_created"},{"title":"checkout.updated","version":null,"deprecated":null,"sidebarTitle":"checkout.updated","openapi":"/openapi/2026-10.openapi.json webhook checkout.updated","href":"/api-reference/2026-10/checkout_updated"},{"title":"checkout.expired","version":null,"deprecated":null,"sidebarTitle":"checkout.expired","openapi":"/openapi/2026-10.openapi.json webhook checkout.expired","href":"/api-reference/2026-10/checkout_expired"}]},{"group":"Subscriptions","pages":[{"title":"subscription.created","version":null,"deprecated":null,"sidebarTitle":"subscription.created","openapi":"/openapi/2026-10.openapi.json webhook subscription.created","href":"/api-reference/2026-10/subscription_created"},{"title":"subscription.active","version":null,"deprecated":null,"sidebarTitle":"subscription.active","openapi":"/openapi/2026-10.openapi.json webhook subscription.active","href":"/api-reference/2026-10/subscription_active"},{"title":"subscription.updated","version":null,"deprecated":null,"sidebarTitle":"subscription.updated","openapi":"/openapi/2026-10.openapi.json webhook subscription.updated","href":"/api-reference/2026-10/subscription_updated"},{"title":"subscription.canceled","version":null,"deprecated":null,"sidebarTitle":"subscription.canceled","openapi":"/openapi/2026-10.openapi.json webhook subscription.canceled","href":"/api-reference/2026-10/subscription_canceled"},{"title":"subscription.uncanceled","version":null,"deprecated":null,"sidebarTitle":"subscription.uncanceled","openapi":"/openapi/2026-10.openapi.json webhook subscription.uncanceled","href":"/api-reference/2026-10/subscription_uncanceled"},{"title":"subscription.cycled","version":null,"deprecated":null,"sidebarTitle":"subscription.cycled","openapi":"/openapi/2026-10.openapi.json webhook subscription.cycled","href":"/api-reference/2026-10/subscription_cycled"},{"title":"subscription.revoked","version":null,"deprecated":null,"sidebarTitle":"subscription.revoked","openapi":"/openapi/2026-10.openapi.json webhook subscription.revoked","href":"/api-reference/2026-10/subscription_revoked"},{"title":"subscription.past_due","version":null,"deprecated":null,"sidebarTitle":"subscription.past_due","openapi":"/openapi/2026-10.openapi.json webhook subscription.past_due","href":"/api-reference/2026-10/subscription_past_due"},{"title":"subscription.paused","version":null,"deprecated":null,"sidebarTitle":"subscription.paused","openapi":"/openapi/2026-10.openapi.json webhook subscription.paused","href":"/api-reference/2026-10/subscription_paused"},{"title":"subscription.resumed","version":null,"deprecated":null,"sidebarTitle":"subscription.resumed","openapi":"/openapi/2026-10.openapi.json webhook subscription.resumed","href":"/api-reference/2026-10/subscription_resumed"},{"title":"subscription.migrated","version":null,"deprecated":null,"sidebarTitle":"subscription.migrated","openapi":"/openapi/2026-10.openapi.json webhook subscription.migrated","href":"/api-reference/2026-10/subscription_migrated"}]},{"group":"Orders","pages":[{"title":"order.created","version":null,"deprecated":null,"sidebarTitle":"order.created","openapi":"/openapi/2026-10.openapi.json webhook order.created","href":"/api-reference/2026-10/order_created"},{"title":"order.paid","version":null,"deprecated":null,"sidebarTitle":"order.paid","openapi":"/openapi/2026-10.openapi.json webhook order.paid","href":"/api-reference/2026-10/order_paid"},{"title":"order.updated","version":null,"deprecated":null,"sidebarTitle":"order.updated","openapi":"/openapi/2026-10.openapi.json webhook order.updated","href":"/api-reference/2026-10/order_updated"},{"title":"order.refunded","version":null,"deprecated":null,"sidebarTitle":"order.refunded","openapi":"/openapi/2026-10.openapi.json webhook order.refunded","href":"/api-reference/2026-10/order_refunded"}]},{"group":"Customer Seats","pages":[{"title":"customer_seat.assigned","version":null,"deprecated":null,"sidebarTitle":"customer_seat.assigned","openapi":"/openapi/2026-10.openapi.json webhook customer_seat.assigned","href":"/api-reference/2026-10/customer_seat_assigned"},{"title":"customer_seat.claimed","version":null,"deprecated":null,"sidebarTitle":"customer_seat.claimed","openapi":"/openapi/2026-10.openapi.json webhook customer_seat.claimed","href":"/api-reference/2026-10/customer_seat_claimed"},{"title":"customer_seat.revoked","version":null,"deprecated":null,"sidebarTitle":"customer_seat.revoked","openapi":"/openapi/2026-10.openapi.json webhook customer_seat.revoked","href":"/api-reference/2026-10/customer_seat_revoked"}]},{"group":"Refunds","pages":[{"title":"refund.created","version":null,"deprecated":null,"sidebarTitle":"refund.created","openapi":"/openapi/2026-10.openapi.json webhook refund.created","href":"/api-reference/2026-10/refund_created"},{"title":"refund.updated","version":null,"deprecated":null,"sidebarTitle":"refund.updated","openapi":"/openapi/2026-10.openapi.json webhook refund.updated","href":"/api-reference/2026-10/refund_updated"}]},{"group":"Benefit Grants","pages":[{"title":"benefit_grant.created","version":null,"deprecated":null,"sidebarTitle":"benefit_grant.created","openapi":"/openapi/2026-10.openapi.json webhook benefit_grant.created","href":"/api-reference/2026-10/benefit_grant_created"},{"title":"benefit_grant.cycled","version":null,"deprecated":null,"sidebarTitle":"benefit_grant.cycled","openapi":"/openapi/2026-10.openapi.json webhook benefit_grant.cycled","href":"/api-reference/2026-10/benefit_grant_cycled"},{"title":"benefit_grant.updated","version":null,"deprecated":null,"sidebarTitle":"benefit_grant.updated","openapi":"/openapi/2026-10.openapi.json webhook benefit_grant.updated","href":"/api-reference/2026-10/benefit_grant_updated"},{"title":"benefit_grant.revoked","version":null,"deprecated":null,"sidebarTitle":"benefit_grant.revoked","openapi":"/openapi/2026-10.openapi.json webhook benefit_grant.revoked","href":"/api-reference/2026-10/benefit_grant_revoked"}]}]},{"group":"Organization Events","pages":[{"group":"Benefits","pages":[{"title":"benefit.created","version":null,"deprecated":null,"sidebarTitle":"benefit.created","openapi":"/openapi/2026-10.openapi.json webhook benefit.created","href":"/api-reference/2026-10/benefit_created"},{"title":"benefit.updated","version":null,"deprecated":null,"sidebarTitle":"benefit.updated","openapi":"/openapi/2026-10.openapi.json webhook benefit.updated","href":"/api-reference/2026-10/benefit_updated"}]},{"group":"Products","pages":[{"title":"product.created","version":null,"deprecated":null,"sidebarTitle":"product.created","openapi":"/openapi/2026-10.openapi.json webhook product.created","href":"/api-reference/2026-10/product_created"},{"title":"product.updated","version":null,"deprecated":null,"sidebarTitle":"product.updated","openapi":"/openapi/2026-10.openapi.json webhook product.updated","href":"/api-reference/2026-10/product_updated"}]},{"group":"Discounts","pages":[{"title":"discount.created","version":null,"deprecated":null,"sidebarTitle":"discount.created","openapi":"/openapi/2026-10.openapi.json webhook discount.created","href":"/api-reference/2026-10/discount_created"},{"title":"discount.updated","version":null,"deprecated":null,"sidebarTitle":"discount.updated","openapi":"/openapi/2026-10.openapi.json webhook discount.updated","href":"/api-reference/2026-10/discount_updated"},{"title":"discount.deleted","version":null,"deprecated":null,"sidebarTitle":"discount.deleted","openapi":"/openapi/2026-10.openapi.json webhook discount.deleted","href":"/api-reference/2026-10/discount_deleted"}]},{"group":"Organization","pages":[{"title":"organization.updated","version":null,"deprecated":null,"sidebarTitle":"organization.updated","openapi":"/openapi/2026-10.openapi.json webhook organization.updated","href":"/api-reference/2026-10/organization_updated"}]}]}]},{"group":"Integrations","pages":[{"group":"OpenID Connect","pages":[{"title":"Authorize","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/oauth2/authorize","href":"/api-reference/2026-10/oauth2/authorize"},{"title":"Request Token","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/oauth2/token","href":"/api-reference/2026-10/oauth2/request-token"},{"title":"Introspect Token","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/oauth2/introspect","href":"/api-reference/2026-10/oauth2/introspect-token"},{"title":"Revoke Token","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/oauth2/revoke","href":"/api-reference/2026-10/oauth2/revoke-token"},{"title":"Get User Info","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/oauth2/userinfo","href":"/api-reference/2026-10/oauth2/get-user-info"}]},{"group":"Webhooks","pages":[{"title":"Create Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json post /v1/webhooks/endpoints","href":"/api-reference/2026-10/webhooks/create-webhook-endpoint"},{"title":"Get Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/webhooks/endpoints/{id}","href":"/api-reference/2026-10/webhooks/get-webhook-endpoint"},{"title":"List Webhook Endpoints","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json get /v1/webhooks/endpoints","href":"/api-reference/2026-10/webhooks/list-webhook-endpoints"},{"title":"Update Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json patch /v1/webhooks/endpoints/{id}","href":"/api-reference/2026-10/webhooks/update-webhook-endpoint"},{"title":"Delete Webhook Endpoint","deprecated":null,"version":null,"openapi":"/openapi/2026-10.openapi.json delete /v1/webhooks/endpoints/{id}","href":"/api-reference/2026-10/webhooks/delete-webhook-endpoint"}]}]}]},{"version":"2027-01","tag":"Next","pages":[{"title":"2027-01","href":"/api-reference/2027-01/events/ingest-events"}]}]},{"tab":"Changelog","icon":"signal-stream","pages":[{"title":"Changelog","href":"/changelog/recent"}]},{"tab":"Support","icon":"square-question","pages":[{"title":"Support","href":"/support"}]}]},"title":"Ingest Events - Polar","buildId":"dpl_BtCp1ySSRiZuC61kdwjLNfcZF9iT","deploymentId":"dpl_BtCp1ySSRiZuC61kdwjLNfcZF9iT","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-BwGMKaJA.js","utils-DlantaNs.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-bU1lWMyL.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-atrzX1N-.js","snippetPresets-Dm5t-KF3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-DHr1JptQ.js","ApiExamples-Cz42QzGy.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CLWnFKQE.js","shallow-DjOyfhxF.js","getApiPlaygroundDisplay-J2CVUWQR.js","CodeSnippet-emM-BzLU.js","CodeSnippets-DbUDosch.js","getPastedJson-D8Zg6YHf.js","icon-BDdk7KSm.js","MethodPill-C61Dtple.js","DuplicateIcon-42opbpVe.js","createIcon-BciRFb7M.js","DynamicMarkdown-CSxQrJZZ.js","SectionHeading-EqAWqlH3.js","axios-vUo_bRtp.js","Markdown-C6VtGA2B.js","clsx-CQdVN3oC.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DusJ_COf.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-D7F55uem.js"]}