{"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/customer_state_changed","slug":"/api-reference/2026-10/customer_state_changed","pageMetadata":{"title":"customer.state_changed","description":"Sent when a customer state has changed.\n\nIt's triggered when:\n\n* Customer is created, updated or deleted.\n* A subscription is created or updated.\n* A benefit is granted or revoked.\n\n**Discord \u0026 Slack support:** Basic","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","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 li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Sent when a customer state has changed.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"It’s triggered when:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Customer is created, updated or deleted.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"A subscription is created or updated.\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"A benefit is granted or revoked.\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Discord \u0026 Slack support:\"\n }), \" Basic\"]\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":"customer.state_changed","description":"Sent when a customer state has changed.\n\nIt's triggered when:\n\n* Customer is created, updated or deleted.\n* A subscription is created or updated.\n* A benefit is granted or revoked.\n\n**Discord \u0026 Slack support:** Basic","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"customer_state_changed","description":"Sent when a customer state has changed.\n\nIt's triggered when:\n\n* Customer is created, updated or deleted.\n* A subscription is created or updated.\n* A benefit is granted or revoked.\n\n**Discord \u0026 Slack support:** Basic","operationId":"_endpointcustomer_state_changed_post","requestBody":"a4ad8e27-4d4f-43b3-939c-b2834ebe88da","responses":{"200":"8ae8a146-7e49-45eb-ab75-67dd10f86d83","422":"abd857aa-1723-4ebc-a572-33f24f6f9e0c"},"x-mint":{"metadata":{"title":"customer.state_changed","sidebarTitle":"customer.state_changed"}},"method":"post","type":"webhook","servers":["0a3cfd4b-9634-4505-9004-41aa566b6b35","81edcbdc-9117-4d62-9bcc-a4eb8c29ac19"],"security":[],"path":"customer.state_changed","baseUrlOptions":["https://api.polar.sh","https://sandbox-api.polar.sh"],"title":"customer_state_changed","codeSamples":[],"requiredOnlyExamples":false,"requestExamples":[{"language":"json","filename":"Example","code":"{\n \"type\": \"customer.state_changed\",\n \"timestamp\": \"2026-01-01T00:00:00.000000Z\",\n \"api_version\": \"\u003cstring>\",\n \"data\": {\n \"id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n \"created_at\": \"2026-01-01T00:00:00.000000Z\",\n \"modified_at\": \"2026-01-01T00:00:00.000000Z\",\n \"metadata\": {},\n \"email\": \"customer@example.com\",\n \"email_verified\": true,\n \"type\": \"individual\",\n \"name\": \"John Doe\",\n \"billing_name\": \"John Doe\",\n \"billing_address\": {\n \"country\": \"US\",\n \"line1\": \"\u003cstring>\",\n \"line2\": \"\u003cstring>\",\n \"postal_code\": \"\u003cstring>\",\n \"city\": \"\u003cstring>\",\n \"state\": \"\u003cstring>\"\n },\n \"tax_id\": {\n \"[0]\": \"\u003cstring>\"\n },\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"deleted_at\": \"2026-01-01T00:00:00.000000Z\",\n \"first_user_event_at\": \"2026-01-01T00:00:00.000000Z\",\n \"avatar_url\": \"https://www.gravatar.com/avatar/xxx?d=404\",\n \"active_subscriptions\": [\n {\n \"id\": \"e5149aae-e521-42b9-b24c-abb3d71eea2e\",\n \"created_at\": \"2026-01-01T00:00:00.000000Z\",\n \"modified_at\": \"2026-01-01T00:00:00.000000Z\",\n \"metadata\": {},\n \"status\": \"active\",\n \"amount\": 1000,\n \"currency\": \"usd\",\n \"current_period_start\": \"2025-02-03T13:37:00Z\",\n \"current_period_end\": \"2025-03-03T13:37:00Z\",\n \"trial_start\": \"2025-02-03T13:37:00Z\",\n \"trial_end\": \"2025-03-03T13:37:00Z\",\n \"cancel_at_period_end\": false,\n \"canceled_at\": null,\n \"started_at\": \"2025-01-03T13:37:00Z\",\n \"ends_at\": null,\n \"product_id\": \"d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23\",\n \"discount_id\": null,\n \"seats\": null,\n \"units\": null,\n \"meters\": [\n {\n \"created_at\": \"2026-01-01T00:00:00.000000Z\",\n \"modified_at\": \"2026-01-01T00:00:00.000000Z\",\n \"id\": \"\u003cstring>\",\n \"consumed_units\": 25,\n \"credited_units\": 100,\n \"amount\": 0,\n \"meter_id\": \"d498a884-e2cd-4d3e-8002-f536468a8b22\"\n }\n ],\n \"custom_field_data\": {}\n }\n ],\n \"granted_benefits\": [\n {\n \"id\": \"d322132c-a9d0-4e0d-b8d3-d81ad021a3a9\",\n \"created_at\": \"2026-01-01T00:00:00.000000Z\",\n \"modified_at\": \"2026-01-01T00:00:00.000000Z\",\n \"granted_at\": \"2025-01-03T13:37:00Z\",\n \"benefit_id\": \"397a17aa-15cf-4cb4-9333-18040203cf98\",\n \"benefit_type\": \"custom\",\n \"benefit_metadata\": {\n \"key\": \"value\"\n },\n \"properties\": {\n \"account_id\": \"\u003cstring>\",\n \"guild_id\": \"\u003cstring>\",\n \"role_id\": \"\u003cstring>\",\n \"granted_account_id\": \"\u003cstring>\"\n }\n }\n ],\n \"active_meters\": [\n {\n \"id\": \"\u003cstring>\",\n \"created_at\": \"2026-01-01T00:00:00.000000Z\",\n \"modified_at\": \"2026-01-01T00:00:00.000000Z\",\n \"meter_id\": \"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n \"consumed_units\": 25,\n \"credited_units\": 100,\n \"balance\": 75\n }\n ],\n \"external_id\": \"usr_1337\",\n \"locale\": \"\u003cstring>\",\n \"default_payment_method_id\": \"\u003cstring>\"\n }\n}"}],"requestExampleType":"webhook","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"type":{"type":"string","const":"customer.state_changed","title":"Type","examples":["customer.state_changed"],"isRequired":true,"uniqueKey":"type","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","examples":["2026-01-01T00:00:00.000000Z"],"isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"api_version":{"type":"string","title":"Api Version","isRequired":true,"uniqueKey":"api_version","typeLabel":"string"},"data":{"oneOf":[{"type":"object","title":"CustomerStateIndividual","description":"A customer along with additional state information:\n\n* Active subscriptions\n* Granted benefits\n* Active meters","required":["id","created_at","modified_at","metadata","email","email_verified","type","name","billing_name","billing_address","tax_id","organization_id","deleted_at","first_user_event_at","avatar_url","active_subscriptions","granted_benefits","active_meters"],"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the customer.","examples":["992fae2a-2a17-4b7a-8d9e-e287cf90131b"],"isRequired":true,"uniqueKey":"data.oneOf.0.id","typeLabel":"string\u003cuuid4>"},"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":"data.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":"data.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":"data.oneOf.0.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.modified_at","typeLabel":"string\u003cdate-time> | null"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"data.oneOf.0.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"data.oneOf.0.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.oneOf.0.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"data.oneOf.0.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"data.oneOf.0.metadata","typeLabel":"object"},"email":{"type":"string","title":"Email","description":"The email address of the customer. This must be unique within the organization.","examples":["customer@example.com"],"isRequired":true,"uniqueKey":"data.oneOf.0.email","typeLabel":"string"},"email_verified":{"type":"boolean","title":"Email Verified","description":"Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.","examples":[true],"isRequired":true,"uniqueKey":"data.oneOf.0.email_verified","typeLabel":"boolean"},"type":{"type":"string","const":"individual","title":"Type","description":"The type of customer.","examples":["individual"],"isRequired":true,"uniqueKey":"data.oneOf.0.type","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","description":"The name of the customer.","example":"John Doe","isRequired":true,"uniqueKey":"data.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"The name of the customer.","example":"John Doe","isRequired":true,"uniqueKey":"data.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.name","typeLabel":"string | null"},"billing_name":{"oneOf":[{"type":"string","title":"Billing Name","description":"The name that should appear on the customer's invoices. Falls back to the customer name when not explicitly set.","example":"John Doe","isRequired":true,"uniqueKey":"data.oneOf.0.billing_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Billing Name","description":"The name that should appear on the customer's invoices. Falls back to the customer name when not explicitly set.","example":"John Doe","isRequired":true,"uniqueKey":"data.oneOf.0.billing_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.billing_name","typeLabel":"string | null"},"billing_address":{"oneOf":[{"type":"object","title":"Address","required":["country"],"properties":{"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"title":"CountryAlpha2","examples":["US","SE","FR"],"x-speakeasy-enums":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"isRequired":true,"uniqueKey":"data.oneOf.0.billing_address.oneOf.0.country","typeLabel":"enum\u003cstring>"},"line1":{"oneOf":[{"type":"string","title":"Line1","uniqueKey":"data.oneOf.0.billing_address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line1","uniqueKey":"data.oneOf.0.billing_address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.billing_address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","title":"Line2","uniqueKey":"data.oneOf.0.billing_address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line2","uniqueKey":"data.oneOf.0.billing_address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.billing_address.oneOf.0.line2","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","uniqueKey":"data.oneOf.0.billing_address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postal Code","uniqueKey":"data.oneOf.0.billing_address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.billing_address.oneOf.0.postal_code","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","title":"City","uniqueKey":"data.oneOf.0.billing_address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","uniqueKey":"data.oneOf.0.billing_address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.billing_address.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","uniqueKey":"data.oneOf.0.billing_address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","uniqueKey":"data.oneOf.0.billing_address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.billing_address.oneOf.0.state","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.oneOf.0.billing_address.oneOf.0","typeLabel":"Address · object"},{"type":"null","isRequired":true,"uniqueKey":"data.oneOf.0.billing_address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.billing_address","typeLabel":"Address · object | null"},"tax_id":{"oneOf":[{"type":"object","title":"Tax Id","properties":{"[0]":{"type":"string","uniqueKey":"data.oneOf.0.tax_id.oneOf.0.[0]","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.oneOf.0.tax_id.oneOf.0","typeLabel":"Tax Id · object"},{"type":"null","title":"Tax Id","isRequired":true,"uniqueKey":"data.oneOf.0.tax_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.tax_id","typeLabel":"Tax Id · object | null"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the customer.","examples":["1dbfc517-0bbf-4301-9ba8-555ca42b9737"],"isRequired":true,"uniqueKey":"data.oneOf.0.organization_id","typeLabel":"string\u003cuuid4>"},"deleted_at":{"oneOf":[{"type":"string","title":"Deleted At","description":"Timestamp for when the customer was soft deleted.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"data.oneOf.0.deleted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Deleted At","description":"Timestamp for when the customer was soft deleted.","isRequired":true,"uniqueKey":"data.oneOf.0.deleted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.deleted_at","typeLabel":"string\u003cdate-time> | null"},"first_user_event_at":{"oneOf":[{"type":"string","title":"First User Event At","description":"Timestamp of the first event ingested for this customer. Can predate `created_at`, and is null if no event was ever ingested.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"data.oneOf.0.first_user_event_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"First User Event At","description":"Timestamp of the first event ingested for this customer. Can predate `created_at`, and is null if no event was ever ingested.","isRequired":true,"uniqueKey":"data.oneOf.0.first_user_event_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.first_user_event_at","typeLabel":"string\u003cdate-time> | null"},"avatar_url":{"oneOf":[{"type":"string","title":"Avatar Url","example":"https://www.gravatar.com/avatar/xxx?d=404","isRequired":true,"uniqueKey":"data.oneOf.0.avatar_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Avatar Url","example":"https://www.gravatar.com/avatar/xxx?d=404","isRequired":true,"uniqueKey":"data.oneOf.0.avatar_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.avatar_url","typeLabel":"string | null"},"active_subscriptions":{"items":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the subscription.","examples":["e5149aae-e521-42b9-b24c-abb3d71eea2e"],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"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":"data.oneOf.0.active_subscriptions.items.[INDEX].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":"data.oneOf.0.active_subscriptions.items.[INDEX].modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].modified_at","typeLabel":"string\u003cdate-time> | null"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].metadata","typeLabel":"object"},"status":{"type":"string","enum":["active","trialing"],"title":"Status","examples":["active","trialing"],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","title":"Amount","description":"The amount of the subscription.","examples":[1000],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].amount","typeLabel":"integer"},"currency":{"type":"string","title":"Currency","description":"The currency of the subscription.","examples":["usd"],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].currency","typeLabel":"string"},"recurring_interval":{"type":"string","enum":["day","week","month","year"],"title":"RecurringInterval","description":"The interval at which the subscription recurs.","isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].recurring_interval","typeLabel":"enum\u003cstring>"},"current_period_start":{"type":"string","format":"date-time","title":"Current Period Start","description":"The start timestamp of the current billing period.","examples":["2025-02-03T13:37:00Z"],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].current_period_start","typeLabel":"string\u003cdate-time>"},"current_period_end":{"type":"string","format":"date-time","title":"Current Period End","description":"The end timestamp of the current billing period.","examples":["2025-03-03T13:37:00Z"],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].current_period_end","typeLabel":"string\u003cdate-time>"},"trial_start":{"oneOf":[{"type":"string","title":"Trial Start","description":"The start timestamp of the trial period, if any.","format":"date-time","example":"2025-02-03T13:37:00Z","isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].trial_start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Trial Start","description":"The start timestamp of the trial period, if any.","example":"2025-02-03T13:37:00Z","isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].trial_start.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].trial_start","typeLabel":"string\u003cdate-time> | null"},"trial_end":{"oneOf":[{"type":"string","title":"Trial End","description":"The end timestamp of the trial period, if any.","format":"date-time","example":"2025-03-03T13:37:00Z","isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].trial_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Trial End","description":"The end timestamp of the trial period, if any.","example":"2025-03-03T13:37:00Z","isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].trial_end.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].trial_end","typeLabel":"string\u003cdate-time> | null"},"cancel_at_period_end":{"type":"boolean","title":"Cancel At Period End","description":"Whether the subscription will be canceled at the end of the current period.","examples":[false],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].cancel_at_period_end","typeLabel":"boolean"},"canceled_at":{"oneOf":[{"type":"string","title":"Canceled At","description":"The timestamp when the subscription was canceled. The subscription might still be active if `cancel_at_period_end` is `true`.","format":"date-time","example":null,"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].canceled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Canceled At","description":"The timestamp when the subscription was canceled. The subscription might still be active if `cancel_at_period_end` is `true`.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].canceled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].canceled_at","typeLabel":"string\u003cdate-time> | null"},"started_at":{"oneOf":[{"type":"string","title":"Started At","description":"The timestamp when the subscription started.","format":"date-time","example":"2025-01-03T13:37:00Z","isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Started At","description":"The timestamp when the subscription started.","example":"2025-01-03T13:37:00Z","isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].started_at","typeLabel":"string\u003cdate-time> | null"},"ends_at":{"oneOf":[{"type":"string","title":"Ends At","description":"The timestamp when the subscription will end.","format":"date-time","example":null,"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Ends At","description":"The timestamp when the subscription will end.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].ends_at","typeLabel":"string\u003cdate-time> | null"},"product_id":{"type":"string","format":"uuid4","title":"Product Id","description":"The ID of the subscribed product.","examples":["d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23"],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].product_id","typeLabel":"string\u003cuuid4>"},"discount_id":{"oneOf":[{"type":"string","title":"Discount Id","description":"The ID of the applied discount, if any.","format":"uuid4","example":null,"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].discount_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Discount Id","description":"The ID of the applied discount, if any.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].discount_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].discount_id","typeLabel":"string\u003cuuid4> | null"},"seats":{"oneOf":[{"type":"integer","title":"Seats","description":"The number of seats for seat-based subscriptions. None for non-seat subscriptions.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].seats.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Seats","description":"The number of seats for seat-based subscriptions. None for non-seat subscriptions.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].seats.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].seats","typeLabel":"integer | null"},"units":{"oneOf":[{"type":"integer","title":"Units","description":"The number of units for unit-based subscriptions. None for non-unit subscriptions.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].units.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Units","description":"The number of units for unit-based subscriptions. None for non-unit subscriptions.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].units.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].units","typeLabel":"integer | null"},"meters":{"items":{"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":"data.oneOf.0.active_subscriptions.items.[INDEX].meters.items.[INDEX].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":"data.oneOf.0.active_subscriptions.items.[INDEX].meters.items.[INDEX].modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].meters.items.[INDEX].modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].meters.items.[INDEX].modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].meters.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"consumed_units":{"type":"number","title":"Consumed Units","description":"The number of consumed units so far in this billing period.","examples":[25],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].meters.items.[INDEX].consumed_units","typeLabel":"number"},"credited_units":{"type":"integer","title":"Credited Units","description":"The number of credited units so far in this billing period.","examples":[100],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].meters.items.[INDEX].credited_units","typeLabel":"integer"},"amount":{"type":"integer","title":"Amount","description":"The amount due in cents so far in this billing period.","examples":[0],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].meters.items.[INDEX].amount","typeLabel":"integer"},"meter_id":{"type":"string","format":"uuid4","title":"Meter Id","description":"The ID of the meter.","examples":["d498a884-e2cd-4d3e-8002-f536468a8b22"],"isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].meters.items.[INDEX].meter_id","typeLabel":"string\u003cuuid4>"}},"type":"object","required":["created_at","modified_at","id","consumed_units","credited_units","amount","meter_id"],"title":"CustomerStateSubscriptionMeter","description":"Current consumption and spending for a subscription meter.","uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].meters.items.[INDEX]","typeLabel":"CustomerStateSubscriptionMeter · object"},"type":"array","title":"Meters","description":"List of meters associated with the subscription.","isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].meters","typeLabel":"CustomerStateSubscriptionMeter · object[]"},"custom_field_data":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].custom_field_data.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].custom_field_data.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"boolean","uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].custom_field_data.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","format":"date-time","example":"2026-01-01T00:00:00.000000Z","uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].custom_field_data.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"null","uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].custom_field_data.additionalProperties.oneOf.4","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].custom_field_data.additionalProperties","typeLabel":"string | integer | boolean | string\u003cdate-time> | null"},"type":"object","title":"Custom Field Data","description":"Key-value object storing custom field values.","uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX].custom_field_data","typeLabel":"Custom Field Data · object"}},"type":"object","required":["id","created_at","modified_at","metadata","status","amount","currency","recurring_interval","current_period_start","current_period_end","trial_start","trial_end","cancel_at_period_end","canceled_at","started_at","ends_at","product_id","discount_id","seats","units","meters"],"title":"CustomerStateSubscription","description":"An active customer subscription.","uniqueKey":"data.oneOf.0.active_subscriptions.items.[INDEX]","typeLabel":"CustomerStateSubscription · object"},"type":"array","title":"Active Subscriptions","description":"The customer's active subscriptions.","isRequired":true,"uniqueKey":"data.oneOf.0.active_subscriptions","typeLabel":"CustomerStateSubscription · object[]"},"granted_benefits":{"items":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the grant.","examples":["d322132c-a9d0-4e0d-b8d3-d81ad021a3a9"],"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"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":"data.oneOf.0.granted_benefits.items.[INDEX].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":"data.oneOf.0.granted_benefits.items.[INDEX].modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].modified_at","typeLabel":"string\u003cdate-time> | null"},"granted_at":{"type":"string","format":"date-time","title":"Granted At","description":"The timestamp when the benefit was granted.","examples":["2025-01-03T13:37:00Z"],"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].granted_at","typeLabel":"string\u003cdate-time>"},"benefit_id":{"type":"string","format":"uuid4","title":"Benefit Id","description":"The ID of the benefit concerned by this grant.","examples":["397a17aa-15cf-4cb4-9333-18040203cf98"],"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].benefit_id","typeLabel":"string\u003cuuid4>"},"benefit_type":{"type":"string","enum":["custom","discord","github_repository","downloadables","license_keys","meter_credit","feature_flag","slack_shared_channel"],"title":"BenefitType","description":"The type of the benefit concerned by this grant.","examples":["custom"],"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].benefit_type","typeLabel":"enum\u003cstring>"},"benefit_metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].benefit_metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].benefit_metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].benefit_metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].benefit_metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].benefit_metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","description":"The metadata of the benefit concerned by this grant.","examples":[{"key":"value"}],"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].benefit_metadata","typeLabel":"object"},"properties":{"oneOf":[{"type":"object","title":"BenefitGrantDiscordProperties","properties":{"account_id":{"oneOf":[{"type":"string","title":"Account Id","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.0.account_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Account Id","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.0.account_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.0.account_id","typeLabel":"string | null"},"guild_id":{"type":"string","title":"Guild Id","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.0.guild_id","typeLabel":"string"},"role_id":{"type":"string","title":"Role Id","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.0.role_id","typeLabel":"string"},"granted_account_id":{"type":"string","title":"Granted Account Id","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.0.granted_account_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.0","typeLabel":"BenefitGrantDiscordProperties · object"},{"type":"object","title":"BenefitGrantGitHubRepositoryProperties","properties":{"account_id":{"oneOf":[{"type":"string","title":"Account Id","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.1.account_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Account Id","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.1.account_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.1.account_id","typeLabel":"string | null"},"repository_owner":{"type":"string","title":"Repository Owner","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.1.repository_owner","typeLabel":"string"},"repository_name":{"type":"string","title":"Repository Name","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.1.repository_name","typeLabel":"string"},"permission":{"type":"string","enum":["pull","triage","push","maintain","admin"],"title":"Permission","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.1.permission","typeLabel":"enum\u003cstring>"},"granted_account_id":{"type":"string","title":"Granted Account Id","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.1.granted_account_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.1","typeLabel":"BenefitGrantGitHubRepositoryProperties · object"},{"type":"object","title":"BenefitGrantDownloadablesProperties","properties":{"files":{"items":{"type":"string","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.2.files.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Files","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.2.files","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.2","typeLabel":"BenefitGrantDownloadablesProperties · object"},{"type":"object","title":"BenefitGrantLicenseKeysProperties","properties":{"user_provided_key":{"type":"string","title":"User Provided Key","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.3.user_provided_key","typeLabel":"string"},"license_key_id":{"type":"string","title":"License Key Id","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.3.license_key_id","typeLabel":"string"},"display_key":{"type":"string","title":"Display Key","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.3.display_key","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.3","typeLabel":"BenefitGrantLicenseKeysProperties · object"},{"type":"object","title":"BenefitGrantCustomProperties","properties":{},"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.4","typeLabel":"BenefitGrantCustomProperties · object"},{"type":"object","title":"BenefitGrantFeatureFlagProperties","properties":{},"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.5","typeLabel":"BenefitGrantFeatureFlagProperties · object"},{"type":"object","title":"BenefitGrantSlackSharedChannelProperties","properties":{"invited_email":{"type":"string","title":"Invited Email","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.6.invited_email","typeLabel":"string"},"channel_id":{"type":"string","title":"Channel Id","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.6.channel_id","typeLabel":"string"},"channel_name":{"type":"string","title":"Channel Name","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.6.channel_name","typeLabel":"string"},"invite_id":{"type":"string","title":"Invite Id","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.6.invite_id","typeLabel":"string"},"invite_url":{"type":"string","title":"Invite Url","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.6.invite_url","typeLabel":"string"},"connected_team_id":{"type":"string","title":"Connected Team Id","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.6.connected_team_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties.oneOf.6","typeLabel":"BenefitGrantSlackSharedChannelProperties · object"}],"isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX].properties","typeLabel":"BenefitGrantDiscordProperties · object | BenefitGrantGitHubRepositoryProperties · object | BenefitGrantDownloadablesProperties · object | BenefitGrantLicenseKeysProperties · object | BenefitGrantCustomProperties · object | BenefitGrantFeatureFlagProperties · object | BenefitGrantSlackSharedChannelProperties · object"}},"type":"object","required":["id","created_at","modified_at","granted_at","benefit_id","benefit_type","benefit_metadata","properties"],"title":"CustomerStateBenefitGrant","description":"An active benefit grant for a customer.","uniqueKey":"data.oneOf.0.granted_benefits.items.[INDEX]","typeLabel":"CustomerStateBenefitGrant · object"},"type":"array","title":"Granted Benefits","description":"The customer's active benefit grants.","isRequired":true,"uniqueKey":"data.oneOf.0.granted_benefits","typeLabel":"CustomerStateBenefitGrant · object[]"},"active_meters":{"items":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"data.oneOf.0.active_meters.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"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":"data.oneOf.0.active_meters.items.[INDEX].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":"data.oneOf.0.active_meters.items.[INDEX].modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"data.oneOf.0.active_meters.items.[INDEX].modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.active_meters.items.[INDEX].modified_at","typeLabel":"string\u003cdate-time> | null"},"meter_id":{"type":"string","format":"uuid4","title":"Meter Id","description":"The ID of the meter.","examples":["d498a884-e2cd-4d3e-8002-f536468a8b22"],"isRequired":true,"uniqueKey":"data.oneOf.0.active_meters.items.[INDEX].meter_id","typeLabel":"string\u003cuuid4>"},"consumed_units":{"type":"number","title":"Consumed Units","description":"The number of consumed units.","examples":[25],"isRequired":true,"uniqueKey":"data.oneOf.0.active_meters.items.[INDEX].consumed_units","typeLabel":"number"},"credited_units":{"type":"integer","title":"Credited Units","description":"The number of credited units.","examples":[100],"isRequired":true,"uniqueKey":"data.oneOf.0.active_meters.items.[INDEX].credited_units","typeLabel":"integer"},"balance":{"type":"number","title":"Balance","description":"The balance of the meter, i.e. the difference between credited and consumed units.","examples":[75],"isRequired":true,"uniqueKey":"data.oneOf.0.active_meters.items.[INDEX].balance","typeLabel":"number"}},"type":"object","required":["id","created_at","modified_at","meter_id","consumed_units","credited_units","balance"],"title":"CustomerStateMeter","description":"An active meter for a customer, with latest consumed and credited units.","uniqueKey":"data.oneOf.0.active_meters.items.[INDEX]","typeLabel":"CustomerStateMeter · object"},"type":"array","title":"Active Meters","description":"The customer's active meters.","isRequired":true,"uniqueKey":"data.oneOf.0.active_meters","typeLabel":"CustomerStateMeter · object[]"},"external_id":{"oneOf":[{"type":"string","title":"External Id","description":"The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.","example":"usr_1337","uniqueKey":"data.oneOf.0.external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Id","description":"The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.","example":"usr_1337","uniqueKey":"data.oneOf.0.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.external_id","typeLabel":"string | null"},"locale":{"oneOf":[{"type":"string","title":"Locale","uniqueKey":"data.oneOf.0.locale.oneOf.0","typeLabel":"string"},{"type":"null","title":"Locale","uniqueKey":"data.oneOf.0.locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.locale","typeLabel":"string | null"},"default_payment_method_id":{"oneOf":[{"type":"string","title":"Default Payment Method Id","description":"The ID of the customer's default payment method, if any. Use the payment methods endpoint to retrieve its details.","format":"uuid4","uniqueKey":"data.oneOf.0.default_payment_method_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Default Payment Method Id","description":"The ID of the customer's default payment method, if any. Use the payment methods endpoint to retrieve its details.","uniqueKey":"data.oneOf.0.default_payment_method_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.default_payment_method_id","typeLabel":"string\u003cuuid4> | null"}},"isRequired":true,"uniqueKey":"data.oneOf.0","typeLabel":"CustomerStateIndividual · object"},{"type":"object","title":"CustomerStateTeam","description":"A team customer along with additional state information:\n\n* Active subscriptions\n* Granted benefits\n* Active meters","required":["id","created_at","modified_at","metadata","email_verified","type","name","billing_name","billing_address","tax_id","organization_id","deleted_at","first_user_event_at","avatar_url","active_subscriptions","granted_benefits","active_meters"],"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the customer.","examples":["992fae2a-2a17-4b7a-8d9e-e287cf90131b"],"isRequired":true,"uniqueKey":"data.oneOf.1.id","typeLabel":"string\u003cuuid4>"},"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":"data.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":"data.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":"data.oneOf.1.modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.modified_at","typeLabel":"string\u003cdate-time> | null"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.1.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"data.oneOf.1.metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"data.oneOf.1.metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.oneOf.1.metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"data.oneOf.1.metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"data.oneOf.1.metadata","typeLabel":"object"},"email_verified":{"type":"boolean","title":"Email Verified","description":"Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.","examples":[true],"isRequired":true,"uniqueKey":"data.oneOf.1.email_verified","typeLabel":"boolean"},"type":{"type":"string","const":"team","title":"Type","description":"The type of customer. Team customers can have multiple members.","examples":["team"],"isRequired":true,"uniqueKey":"data.oneOf.1.type","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","description":"The name of the customer.","example":"John Doe","isRequired":true,"uniqueKey":"data.oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"The name of the customer.","example":"John Doe","isRequired":true,"uniqueKey":"data.oneOf.1.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.name","typeLabel":"string | null"},"billing_name":{"oneOf":[{"type":"string","title":"Billing Name","description":"The name that should appear on the customer's invoices. Falls back to the customer name when not explicitly set.","example":"John Doe","isRequired":true,"uniqueKey":"data.oneOf.1.billing_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Billing Name","description":"The name that should appear on the customer's invoices. Falls back to the customer name when not explicitly set.","example":"John Doe","isRequired":true,"uniqueKey":"data.oneOf.1.billing_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.billing_name","typeLabel":"string | null"},"billing_address":{"oneOf":[{"type":"object","title":"Address","required":["country"],"properties":{"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"title":"CountryAlpha2","examples":["US","SE","FR"],"x-speakeasy-enums":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"isRequired":true,"uniqueKey":"data.oneOf.1.billing_address.oneOf.0.country","typeLabel":"enum\u003cstring>"},"line1":{"oneOf":[{"type":"string","title":"Line1","uniqueKey":"data.oneOf.1.billing_address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line1","uniqueKey":"data.oneOf.1.billing_address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.billing_address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","title":"Line2","uniqueKey":"data.oneOf.1.billing_address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Line2","uniqueKey":"data.oneOf.1.billing_address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.billing_address.oneOf.0.line2","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","title":"Postal Code","uniqueKey":"data.oneOf.1.billing_address.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postal Code","uniqueKey":"data.oneOf.1.billing_address.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.billing_address.oneOf.0.postal_code","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","title":"City","uniqueKey":"data.oneOf.1.billing_address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","uniqueKey":"data.oneOf.1.billing_address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.billing_address.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","uniqueKey":"data.oneOf.1.billing_address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","uniqueKey":"data.oneOf.1.billing_address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.billing_address.oneOf.0.state","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.oneOf.1.billing_address.oneOf.0","typeLabel":"Address · object"},{"type":"null","isRequired":true,"uniqueKey":"data.oneOf.1.billing_address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.billing_address","typeLabel":"Address · object | null"},"tax_id":{"oneOf":[{"type":"object","title":"Tax Id","properties":{"[0]":{"type":"string","uniqueKey":"data.oneOf.1.tax_id.oneOf.0.[0]","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.oneOf.1.tax_id.oneOf.0","typeLabel":"Tax Id · object"},{"type":"null","title":"Tax Id","isRequired":true,"uniqueKey":"data.oneOf.1.tax_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.tax_id","typeLabel":"Tax Id · object | null"},"organization_id":{"type":"string","format":"uuid4","title":"Organization Id","description":"The ID of the organization owning the customer.","examples":["1dbfc517-0bbf-4301-9ba8-555ca42b9737"],"isRequired":true,"uniqueKey":"data.oneOf.1.organization_id","typeLabel":"string\u003cuuid4>"},"deleted_at":{"oneOf":[{"type":"string","title":"Deleted At","description":"Timestamp for when the customer was soft deleted.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"data.oneOf.1.deleted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Deleted At","description":"Timestamp for when the customer was soft deleted.","isRequired":true,"uniqueKey":"data.oneOf.1.deleted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.deleted_at","typeLabel":"string\u003cdate-time> | null"},"first_user_event_at":{"oneOf":[{"type":"string","title":"First User Event At","description":"Timestamp of the first event ingested for this customer. Can predate `created_at`, and is null if no event was ever ingested.","format":"date-time","example":"2026-01-01T00:00:00.000000Z","isRequired":true,"uniqueKey":"data.oneOf.1.first_user_event_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"First User Event At","description":"Timestamp of the first event ingested for this customer. Can predate `created_at`, and is null if no event was ever ingested.","isRequired":true,"uniqueKey":"data.oneOf.1.first_user_event_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.first_user_event_at","typeLabel":"string\u003cdate-time> | null"},"avatar_url":{"oneOf":[{"type":"string","title":"Avatar Url","example":"https://www.gravatar.com/avatar/xxx?d=404","isRequired":true,"uniqueKey":"data.oneOf.1.avatar_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Avatar Url","example":"https://www.gravatar.com/avatar/xxx?d=404","isRequired":true,"uniqueKey":"data.oneOf.1.avatar_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.avatar_url","typeLabel":"string | null"},"active_subscriptions":{"items":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the subscription.","examples":["e5149aae-e521-42b9-b24c-abb3d71eea2e"],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"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":"data.oneOf.1.active_subscriptions.items.[INDEX].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":"data.oneOf.1.active_subscriptions.items.[INDEX].modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].modified_at","typeLabel":"string\u003cdate-time> | null"},"metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].metadata","typeLabel":"object"},"status":{"type":"string","enum":["active","trialing"],"title":"Status","examples":["active","trialing"],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","title":"Amount","description":"The amount of the subscription.","examples":[1000],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].amount","typeLabel":"integer"},"currency":{"type":"string","title":"Currency","description":"The currency of the subscription.","examples":["usd"],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].currency","typeLabel":"string"},"recurring_interval":{"type":"string","enum":["day","week","month","year"],"title":"RecurringInterval","description":"The interval at which the subscription recurs.","isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].recurring_interval","typeLabel":"enum\u003cstring>"},"current_period_start":{"type":"string","format":"date-time","title":"Current Period Start","description":"The start timestamp of the current billing period.","examples":["2025-02-03T13:37:00Z"],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].current_period_start","typeLabel":"string\u003cdate-time>"},"current_period_end":{"type":"string","format":"date-time","title":"Current Period End","description":"The end timestamp of the current billing period.","examples":["2025-03-03T13:37:00Z"],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].current_period_end","typeLabel":"string\u003cdate-time>"},"trial_start":{"oneOf":[{"type":"string","title":"Trial Start","description":"The start timestamp of the trial period, if any.","format":"date-time","example":"2025-02-03T13:37:00Z","isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].trial_start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Trial Start","description":"The start timestamp of the trial period, if any.","example":"2025-02-03T13:37:00Z","isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].trial_start.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].trial_start","typeLabel":"string\u003cdate-time> | null"},"trial_end":{"oneOf":[{"type":"string","title":"Trial End","description":"The end timestamp of the trial period, if any.","format":"date-time","example":"2025-03-03T13:37:00Z","isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].trial_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Trial End","description":"The end timestamp of the trial period, if any.","example":"2025-03-03T13:37:00Z","isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].trial_end.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].trial_end","typeLabel":"string\u003cdate-time> | null"},"cancel_at_period_end":{"type":"boolean","title":"Cancel At Period End","description":"Whether the subscription will be canceled at the end of the current period.","examples":[false],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].cancel_at_period_end","typeLabel":"boolean"},"canceled_at":{"oneOf":[{"type":"string","title":"Canceled At","description":"The timestamp when the subscription was canceled. The subscription might still be active if `cancel_at_period_end` is `true`.","format":"date-time","example":null,"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].canceled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Canceled At","description":"The timestamp when the subscription was canceled. The subscription might still be active if `cancel_at_period_end` is `true`.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].canceled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].canceled_at","typeLabel":"string\u003cdate-time> | null"},"started_at":{"oneOf":[{"type":"string","title":"Started At","description":"The timestamp when the subscription started.","format":"date-time","example":"2025-01-03T13:37:00Z","isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Started At","description":"The timestamp when the subscription started.","example":"2025-01-03T13:37:00Z","isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].started_at","typeLabel":"string\u003cdate-time> | null"},"ends_at":{"oneOf":[{"type":"string","title":"Ends At","description":"The timestamp when the subscription will end.","format":"date-time","example":null,"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Ends At","description":"The timestamp when the subscription will end.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].ends_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].ends_at","typeLabel":"string\u003cdate-time> | null"},"product_id":{"type":"string","format":"uuid4","title":"Product Id","description":"The ID of the subscribed product.","examples":["d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23"],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].product_id","typeLabel":"string\u003cuuid4>"},"discount_id":{"oneOf":[{"type":"string","title":"Discount Id","description":"The ID of the applied discount, if any.","format":"uuid4","example":null,"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].discount_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Discount Id","description":"The ID of the applied discount, if any.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].discount_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].discount_id","typeLabel":"string\u003cuuid4> | null"},"seats":{"oneOf":[{"type":"integer","title":"Seats","description":"The number of seats for seat-based subscriptions. None for non-seat subscriptions.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].seats.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Seats","description":"The number of seats for seat-based subscriptions. None for non-seat subscriptions.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].seats.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].seats","typeLabel":"integer | null"},"units":{"oneOf":[{"type":"integer","title":"Units","description":"The number of units for unit-based subscriptions. None for non-unit subscriptions.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].units.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Units","description":"The number of units for unit-based subscriptions. None for non-unit subscriptions.","example":null,"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].units.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].units","typeLabel":"integer | null"},"meters":{"items":{"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":"data.oneOf.1.active_subscriptions.items.[INDEX].meters.items.[INDEX].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":"data.oneOf.1.active_subscriptions.items.[INDEX].meters.items.[INDEX].modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].meters.items.[INDEX].modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].meters.items.[INDEX].modified_at","typeLabel":"string\u003cdate-time> | null"},"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].meters.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"consumed_units":{"type":"number","title":"Consumed Units","description":"The number of consumed units so far in this billing period.","examples":[25],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].meters.items.[INDEX].consumed_units","typeLabel":"number"},"credited_units":{"type":"integer","title":"Credited Units","description":"The number of credited units so far in this billing period.","examples":[100],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].meters.items.[INDEX].credited_units","typeLabel":"integer"},"amount":{"type":"integer","title":"Amount","description":"The amount due in cents so far in this billing period.","examples":[0],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].meters.items.[INDEX].amount","typeLabel":"integer"},"meter_id":{"type":"string","format":"uuid4","title":"Meter Id","description":"The ID of the meter.","examples":["d498a884-e2cd-4d3e-8002-f536468a8b22"],"isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].meters.items.[INDEX].meter_id","typeLabel":"string\u003cuuid4>"}},"type":"object","required":["created_at","modified_at","id","consumed_units","credited_units","amount","meter_id"],"title":"CustomerStateSubscriptionMeter","description":"Current consumption and spending for a subscription meter.","uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].meters.items.[INDEX]","typeLabel":"CustomerStateSubscriptionMeter · object"},"type":"array","title":"Meters","description":"List of meters associated with the subscription.","isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].meters","typeLabel":"CustomerStateSubscriptionMeter · object[]"},"custom_field_data":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].custom_field_data.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].custom_field_data.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"boolean","uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].custom_field_data.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"string","format":"date-time","example":"2026-01-01T00:00:00.000000Z","uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].custom_field_data.additionalProperties.oneOf.3","typeLabel":"string\u003cdate-time>"},{"type":"null","uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].custom_field_data.additionalProperties.oneOf.4","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].custom_field_data.additionalProperties","typeLabel":"string | integer | boolean | string\u003cdate-time> | null"},"type":"object","title":"Custom Field Data","description":"Key-value object storing custom field values.","uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX].custom_field_data","typeLabel":"Custom Field Data · object"}},"type":"object","required":["id","created_at","modified_at","metadata","status","amount","currency","recurring_interval","current_period_start","current_period_end","trial_start","trial_end","cancel_at_period_end","canceled_at","started_at","ends_at","product_id","discount_id","seats","units","meters"],"title":"CustomerStateSubscription","description":"An active customer subscription.","uniqueKey":"data.oneOf.1.active_subscriptions.items.[INDEX]","typeLabel":"CustomerStateSubscription · object"},"type":"array","title":"Active Subscriptions","description":"The customer's active subscriptions.","isRequired":true,"uniqueKey":"data.oneOf.1.active_subscriptions","typeLabel":"CustomerStateSubscription · object[]"},"granted_benefits":{"items":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the grant.","examples":["d322132c-a9d0-4e0d-b8d3-d81ad021a3a9"],"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"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":"data.oneOf.1.granted_benefits.items.[INDEX].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":"data.oneOf.1.granted_benefits.items.[INDEX].modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].modified_at","typeLabel":"string\u003cdate-time> | null"},"granted_at":{"type":"string","format":"date-time","title":"Granted At","description":"The timestamp when the benefit was granted.","examples":["2025-01-03T13:37:00Z"],"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].granted_at","typeLabel":"string\u003cdate-time>"},"benefit_id":{"type":"string","format":"uuid4","title":"Benefit Id","description":"The ID of the benefit concerned by this grant.","examples":["397a17aa-15cf-4cb4-9333-18040203cf98"],"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].benefit_id","typeLabel":"string\u003cuuid4>"},"benefit_type":{"type":"string","enum":["custom","discord","github_repository","downloadables","license_keys","meter_credit","feature_flag","slack_shared_channel"],"title":"BenefitType","description":"The type of the benefit concerned by this grant.","examples":["custom"],"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].benefit_type","typeLabel":"enum\u003cstring>"},"benefit_metadata":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].benefit_metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].benefit_metadata.additionalProperties.oneOf.1","typeLabel":"integer"},{"type":"number","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].benefit_metadata.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].benefit_metadata.additionalProperties.oneOf.3","typeLabel":"boolean"}],"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].benefit_metadata.additionalProperties","typeLabel":"string | integer | number | boolean"},"type":"object","description":"The metadata of the benefit concerned by this grant.","examples":[{"key":"value"}],"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].benefit_metadata","typeLabel":"object"},"properties":{"oneOf":[{"type":"object","title":"BenefitGrantDiscordProperties","properties":{"account_id":{"oneOf":[{"type":"string","title":"Account Id","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.0.account_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Account Id","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.0.account_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.0.account_id","typeLabel":"string | null"},"guild_id":{"type":"string","title":"Guild Id","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.0.guild_id","typeLabel":"string"},"role_id":{"type":"string","title":"Role Id","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.0.role_id","typeLabel":"string"},"granted_account_id":{"type":"string","title":"Granted Account Id","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.0.granted_account_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.0","typeLabel":"BenefitGrantDiscordProperties · object"},{"type":"object","title":"BenefitGrantGitHubRepositoryProperties","properties":{"account_id":{"oneOf":[{"type":"string","title":"Account Id","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.1.account_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Account Id","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.1.account_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.1.account_id","typeLabel":"string | null"},"repository_owner":{"type":"string","title":"Repository Owner","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.1.repository_owner","typeLabel":"string"},"repository_name":{"type":"string","title":"Repository Name","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.1.repository_name","typeLabel":"string"},"permission":{"type":"string","enum":["pull","triage","push","maintain","admin"],"title":"Permission","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.1.permission","typeLabel":"enum\u003cstring>"},"granted_account_id":{"type":"string","title":"Granted Account Id","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.1.granted_account_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.1","typeLabel":"BenefitGrantGitHubRepositoryProperties · object"},{"type":"object","title":"BenefitGrantDownloadablesProperties","properties":{"files":{"items":{"type":"string","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.2.files.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Files","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.2.files","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.2","typeLabel":"BenefitGrantDownloadablesProperties · object"},{"type":"object","title":"BenefitGrantLicenseKeysProperties","properties":{"user_provided_key":{"type":"string","title":"User Provided Key","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.3.user_provided_key","typeLabel":"string"},"license_key_id":{"type":"string","title":"License Key Id","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.3.license_key_id","typeLabel":"string"},"display_key":{"type":"string","title":"Display Key","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.3.display_key","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.3","typeLabel":"BenefitGrantLicenseKeysProperties · object"},{"type":"object","title":"BenefitGrantCustomProperties","properties":{},"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.4","typeLabel":"BenefitGrantCustomProperties · object"},{"type":"object","title":"BenefitGrantFeatureFlagProperties","properties":{},"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.5","typeLabel":"BenefitGrantFeatureFlagProperties · object"},{"type":"object","title":"BenefitGrantSlackSharedChannelProperties","properties":{"invited_email":{"type":"string","title":"Invited Email","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.6.invited_email","typeLabel":"string"},"channel_id":{"type":"string","title":"Channel Id","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.6.channel_id","typeLabel":"string"},"channel_name":{"type":"string","title":"Channel Name","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.6.channel_name","typeLabel":"string"},"invite_id":{"type":"string","title":"Invite Id","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.6.invite_id","typeLabel":"string"},"invite_url":{"type":"string","title":"Invite Url","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.6.invite_url","typeLabel":"string"},"connected_team_id":{"type":"string","title":"Connected Team Id","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.6.connected_team_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties.oneOf.6","typeLabel":"BenefitGrantSlackSharedChannelProperties · object"}],"isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX].properties","typeLabel":"BenefitGrantDiscordProperties · object | BenefitGrantGitHubRepositoryProperties · object | BenefitGrantDownloadablesProperties · object | BenefitGrantLicenseKeysProperties · object | BenefitGrantCustomProperties · object | BenefitGrantFeatureFlagProperties · object | BenefitGrantSlackSharedChannelProperties · object"}},"type":"object","required":["id","created_at","modified_at","granted_at","benefit_id","benefit_type","benefit_metadata","properties"],"title":"CustomerStateBenefitGrant","description":"An active benefit grant for a customer.","uniqueKey":"data.oneOf.1.granted_benefits.items.[INDEX]","typeLabel":"CustomerStateBenefitGrant · object"},"type":"array","title":"Granted Benefits","description":"The customer's active benefit grants.","isRequired":true,"uniqueKey":"data.oneOf.1.granted_benefits","typeLabel":"CustomerStateBenefitGrant · object[]"},"active_meters":{"items":{"properties":{"id":{"type":"string","format":"uuid4","title":"Id","description":"The ID of the object.","isRequired":true,"uniqueKey":"data.oneOf.1.active_meters.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"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":"data.oneOf.1.active_meters.items.[INDEX].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":"data.oneOf.1.active_meters.items.[INDEX].modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Modified At","description":"Last modification timestamp of the object.","isRequired":true,"uniqueKey":"data.oneOf.1.active_meters.items.[INDEX].modified_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.active_meters.items.[INDEX].modified_at","typeLabel":"string\u003cdate-time> | null"},"meter_id":{"type":"string","format":"uuid4","title":"Meter Id","description":"The ID of the meter.","examples":["d498a884-e2cd-4d3e-8002-f536468a8b22"],"isRequired":true,"uniqueKey":"data.oneOf.1.active_meters.items.[INDEX].meter_id","typeLabel":"string\u003cuuid4>"},"consumed_units":{"type":"number","title":"Consumed Units","description":"The number of consumed units.","examples":[25],"isRequired":true,"uniqueKey":"data.oneOf.1.active_meters.items.[INDEX].consumed_units","typeLabel":"number"},"credited_units":{"type":"integer","title":"Credited Units","description":"The number of credited units.","examples":[100],"isRequired":true,"uniqueKey":"data.oneOf.1.active_meters.items.[INDEX].credited_units","typeLabel":"integer"},"balance":{"type":"number","title":"Balance","description":"The balance of the meter, i.e. the difference between credited and consumed units.","examples":[75],"isRequired":true,"uniqueKey":"data.oneOf.1.active_meters.items.[INDEX].balance","typeLabel":"number"}},"type":"object","required":["id","created_at","modified_at","meter_id","consumed_units","credited_units","balance"],"title":"CustomerStateMeter","description":"An active meter for a customer, with latest consumed and credited units.","uniqueKey":"data.oneOf.1.active_meters.items.[INDEX]","typeLabel":"CustomerStateMeter · object"},"type":"array","title":"Active Meters","description":"The customer's active meters.","isRequired":true,"uniqueKey":"data.oneOf.1.active_meters","typeLabel":"CustomerStateMeter · object[]"},"external_id":{"oneOf":[{"type":"string","title":"External Id","description":"The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.","example":"usr_1337","uniqueKey":"data.oneOf.1.external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Id","description":"The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.","example":"usr_1337","uniqueKey":"data.oneOf.1.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.external_id","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","description":"The email address of the customer. This must be unique within the organization.","example":"customer@example.com","uniqueKey":"data.oneOf.1.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","description":"The email address of the customer. This must be unique within the organization.","example":"customer@example.com","uniqueKey":"data.oneOf.1.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.email","typeLabel":"string | null"},"locale":{"oneOf":[{"type":"string","title":"Locale","uniqueKey":"data.oneOf.1.locale.oneOf.0","typeLabel":"string"},{"type":"null","title":"Locale","uniqueKey":"data.oneOf.1.locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.locale","typeLabel":"string | null"},"default_payment_method_id":{"oneOf":[{"type":"string","title":"Default Payment Method Id","description":"The ID of the customer's default payment method, if any. Use the payment methods endpoint to retrieve its details.","format":"uuid4","uniqueKey":"data.oneOf.1.default_payment_method_id.oneOf.0","typeLabel":"string\u003cuuid4>"},{"type":"null","title":"Default Payment Method Id","description":"The ID of the customer's default payment method, if any. Use the payment methods endpoint to retrieve its details.","uniqueKey":"data.oneOf.1.default_payment_method_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.default_payment_method_id","typeLabel":"string\u003cuuid4> | null"}},"isRequired":true,"uniqueKey":"data.oneOf.1","typeLabel":"CustomerStateTeam · object"}],"isRequired":true,"uniqueKey":"data","typeLabel":"CustomerStateIndividual · object | CustomerStateTeam · object"}},"type":"object","required":["type","timestamp","api_version","data"],"title":"WebhookCustomerStateChangedPayload","description":"Sent when a customer state has changed.\n\nIt's triggered when:\n\n* Customer is created, updated or deleted.\n* A subscription is created or updated.\n* A benefit is granted or revoked.\n\n**Discord \u0026 Slack support:** Basic","uniqueKey":"","typeLabel":"WebhookCustomerStateChangedPayload · object"},"examples":{"Example":{"title":"Example","value":{"type":"customer.state_changed","timestamp":"2026-01-01T00:00:00.000000Z","api_version":"\u003cstring>","data":{"id":"992fae2a-2a17-4b7a-8d9e-e287cf90131b","created_at":"2026-01-01T00:00:00.000000Z","modified_at":"2026-01-01T00:00:00.000000Z","metadata":{},"email":"customer@example.com","email_verified":true,"type":"individual","name":"John Doe","billing_name":"John Doe","billing_address":{"country":"US","line1":"\u003cstring>","line2":"\u003cstring>","postal_code":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>"},"tax_id":{"[0]":"\u003cstring>"},"organization_id":"1dbfc517-0bbf-4301-9ba8-555ca42b9737","deleted_at":"2026-01-01T00:00:00.000000Z","first_user_event_at":"2026-01-01T00:00:00.000000Z","avatar_url":"https://www.gravatar.com/avatar/xxx?d=404","active_subscriptions":[{"id":"e5149aae-e521-42b9-b24c-abb3d71eea2e","created_at":"2026-01-01T00:00:00.000000Z","modified_at":"2026-01-01T00:00:00.000000Z","metadata":{},"status":"active","amount":1000,"currency":"usd","current_period_start":"2025-02-03T13:37:00Z","current_period_end":"2025-03-03T13:37:00Z","trial_start":"2025-02-03T13:37:00Z","trial_end":"2025-03-03T13:37:00Z","cancel_at_period_end":false,"canceled_at":null,"started_at":"2025-01-03T13:37:00Z","ends_at":null,"product_id":"d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23","discount_id":null,"seats":null,"units":null,"meters":[{"created_at":"2026-01-01T00:00:00.000000Z","modified_at":"2026-01-01T00:00:00.000000Z","id":"\u003cstring>","consumed_units":25,"credited_units":100,"amount":0,"meter_id":"d498a884-e2cd-4d3e-8002-f536468a8b22"}],"custom_field_data":{}}],"granted_benefits":[{"id":"d322132c-a9d0-4e0d-b8d3-d81ad021a3a9","created_at":"2026-01-01T00:00:00.000000Z","modified_at":"2026-01-01T00:00:00.000000Z","granted_at":"2025-01-03T13:37:00Z","benefit_id":"397a17aa-15cf-4cb4-9333-18040203cf98","benefit_type":"custom","benefit_metadata":{"key":"value"},"properties":{"account_id":"\u003cstring>","guild_id":"\u003cstring>","role_id":"\u003cstring>","granted_account_id":"\u003cstring>"}}],"active_meters":[{"id":"\u003cstring>","created_at":"2026-01-01T00:00:00.000000Z","modified_at":"2026-01-01T00:00:00.000000Z","meter_id":"d498a884-e2cd-4d3e-8002-f536468a8b22","consumed_units":25,"credited_units":100,"balance":75}],"external_id":"usr_1337","locale":"\u003cstring>","default_payment_method_id":"\u003cstring>"}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"8ae8a146-7e49-45eb-ab75-67dd10f86d83":{"description":"Successful Response","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"abd857aa-1723-4ebc-a572-33f24f6f9e0c":{"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":{},"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"}}},"originalFileLocation":"openapi/2026-10.openapi.json"},"subdomain":"polar","siteName":"Polar","title":"customer.state_changed - Polar","navMaps":{"firstHrefInVersion":{"2026-04":{"href":"/api-reference/2026-04/customer_state_changed","matchLevel":1},"2026-10":{"href":"/api-reference/2026-10/customer_state_changed","matchLevel":0},"2027-01":{"href":"/api-reference/2027-01/customer_state_changed","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-10-19T15:30:39.625Z","originalFileLocation":"api-reference/2026-10/customer_state_changed.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=\"Sent when a customer state has changed. It\u0026#x27;s triggered when: Customer is created, updated or deleted. A subscription is created or updated. * A benefit is granted or revoked. Discord \u0026amp; Slack support: Basic\">\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=\"customer.state_changed - Polar\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sent when a customer state has changed. It\u0026#x27;s triggered when: Customer is created, updated or deleted. A subscription is created or updated. * A benefit is granted or revoked. Discord \u0026amp; Slack support: Basic\">\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/customer_state_changed\">\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=\"customer.state_changed - Polar\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sent when a customer state has changed. It\u0026#x27;s triggered when: Customer is created, updated or deleted. A subscription is created or updated. * A benefit is granted or revoked. Discord \u0026amp; Slack support: Basic\">\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/customer_state_changed\">\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/customer_state_changed.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/customer_state_changed#webpage\",\"url\":\"https://polar.sh/docs/api-reference/2026-10/customer_state_changed\",\"name\":\"customer.state_changed\",\"description\":\"Sent when a customer state has changed. It's triggered when: Customer is created, updated or deleted. A subscription is created or updated. * A benefit is granted or revoked. Discord \u0026 Slack support: Basic\",\"dateModified\":\"2026-10-19T15:30:39.625Z\",\"isPartOf\":{\"@id\":\"https://polar.sh/docs#website\"},\"breadcrumb\":{\"@id\":\"https://polar.sh/docs/api-reference/2026-10/customer_state_changed#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://polar.sh/docs/api-reference/2026-10/customer_state_changed#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Polar\",\"item\":\"https://polar.sh/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"customer.state_changed\",\"item\":\"https://polar.sh/docs/api-reference/2026-10/customer_state_changed\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://polar.sh/docs/api-reference/2026-10/customer_state_changed#apireference\",\"headline\":\"customer.state_changed\",\"name\":\"customer.state_changed\",\"description\":\"Sent when a customer state has changed. It's triggered when: Customer is created, updated or deleted. A subscription is created or updated. * A benefit is granted or revoked. Discord \u0026 Slack support: Basic\",\"url\":\"https://polar.sh/docs/api-reference/2026-10/customer_state_changed\",\"mainEntityOfPage\":{\"@id\":\"https://polar.sh/docs/api-reference/2026-10/customer_state_changed#webpage\"},\"image\":\"https://polar.sh/assets/brand/polar_og.jpg\",\"dateModified\":\"2026-10-19T15:30:39.625Z\",\"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/customer_state_changed"}]},{"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","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","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","description":"Delete a payment method from the authenticated customer.","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","description":"Sent when a new customer is created.\n\nA customer can be created:\n\n* After a successful checkout.\n* Programmatically via the API.\n\n**Discord \u0026 Slack support:** Basic","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/customer_state_changed"}]}]},{"tab":"Changelog","icon":"signal-stream","pages":[{"title":"Changelog","href":"/changelog/recent"}]},{"tab":"Support","icon":"square-question","pages":[{"title":"Support","href":"/support"}]}]},"title":"customer.state_changed - 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"]}