Beta: when totals and the metrics' costs were computed. These are present only when a
subscription's current billing period is read (no start_date nor end_date) and its
usage could be priced.
Beta: the sum of the metrics' costs, per currency or credit unit.
Show child attributes
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Meteroid Documentation","colors":{"primary":"#000000","light":"#ffffff","dark":"#000000"},"logo":{"light":"https://mintcdn.com/meteroid/DXZxL5GMStRjxkBm/logo/light.svg?fit=max\u0026auto=format\u0026n=DXZxL5GMStRjxkBm\u0026q=85\u0026s=1fff7e555af3dab03da62c204c63d3c8","dark":"https://mintcdn.com/meteroid/DXZxL5GMStRjxkBm/logo/dark.svg?fit=max\u0026auto=format\u0026n=DXZxL5GMStRjxkBm\u0026q=85\u0026s=15974c7197780816945c5c8ba3a2c9c2","href":"https://meteroid.com"},"favicon":"https://mintcdn.com/meteroid/DXZxL5GMStRjxkBm/favicon.svg?fit=max\u0026auto=format\u0026n=DXZxL5GMStRjxkBm\u0026q=85\u0026s=a4e1cd748df0f10df9a912ee2472503d","appearance":{"default":"dark"},"background":{"color":{"light":"#f7f7f7","dark":"#111111"}},"navbar":{"links":[{"href":"https://meteroid.com/talk-to-us","label":"Talk to us"}],"primary":{"type":"button","label":"Get started","href":"https://app.meteroid.com/registration"}},"footer":{"socials":{"github":"https://github.com/meteroid-oss/meteroid","linkedin":"https://www.linkedin.com/company/meteroid","discord":"https://go.meteroid.com/discord"}},"fonts":{"heading":{"family":"Inter","weight":600},"body":{"family":"Inter","weight":400}},"icons":{"library":"tabler"},"integrations":{"telemetry":{"enabled":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","grok","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"book","href":"https://meteroid.com/blog"},{"anchor":"Talk to us","icon":"message","href":"https://meteroid.com/talk-to-us"},{"anchor":"GitHub","icon":"github","href":"https://go.meteroid.com/github"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"meteroid","hasAudioNarration":false,"actualSubdomain":"meteroid","customDomains":["docs.meteroid.com"],"gitSource":{"type":"github","owner":"meteroid-oss","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aebbe00183182f1b3cea64b","collectionId":"be5bcd96-e80f-4527-938c-b6bd75b0ae25","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aebbe00183182f1b3cea64b"},"entitlements":{},"buildId":"6aebeacc2fc8f1176d0d20df","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":207},{"language":"default","tag":"Docs","count":58},{"language":"default","tag":"webhooks","count":56},{"language":"default","tag":"Plans","count":13},{"language":"default","tag":"Subscriptions","count":12},{"language":"default","tag":"Settings","count":10},{"language":"default","tag":"Customers","count":9},{"language":"default","tag":"Webhook Endpoints","count":9},{"language":"default","tag":"Integrations","count":8},{"language":"default","tag":"Add-ons","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".dark .text-sm,.dark .paragraph-small{color:#9E9E9E}.light .text-sm,.light .paragraph-small{color:#3E3E3E}.dark .sidebar-group a{color:rgba(247, 247, 248, 0.6)!important}.sidebar-group-header{font-size:13px!important;font-weight:600!important;letter-spacing:-0.01em!important;text-transform:none!important}.sidebar-group a{font-size:13px!important;font-weight:400!important;line-height:160%!important;text-decoration:none!important;transition:background-color 0.15s ease, color 0.15s ease!important}.sidebar-group a.bg-primary\\/10,.sidebar-group a[aria-current=\"page\"]{background:rgba(255, 255, 255, 0.06)!important;border-radius:6px!important}.light .sidebar-group a.bg-primary\\/10,.sidebar-group a[aria-current=\"page\"]{background:rgb(0 0 0 / 6%)!important;border-radius:6px!important}.dark\\:hover\\:text-gray-300:hover:is(.dark *){border-radius:6px!important}.dark #topbar-cta-button a{background-color:#ffffff}.dark #topbar-cta-button span{color:#0e0e0e}.dark #navbar,.dark .almond-layout,.dark .almond-layout>div,.dark .almond-layout>div>div{background-color:#111111!important}#search-bar-entry{border-radius:100px!important;padding-right:16px}.home-content-wrapper{max-width:1024px;margin:0 auto;padding-top:6rem;padding-left:2rem;padding-right:2rem}.home-content-wrapper H1{font-size:36px;letter-spacing:-1px;font-weight:500}.dark .home-content-wrapper H1{color:#f3f3f3}.light .home-content-wrapper H1{color:#1e1e1e}.home-content-wrapper H2{font-size:20px;font-weight:500;margin-top:36px;margin-bottom:16px}.dark .home-content-wrapper H2{color:#f3f3f3}.light .home-content-wrapper H2{color:#1e1e1e}.home-content-wrapper a H2{font-size:16px;font-weight:500;margin-top:56px;margin-bottom:8px}.home-content-wrapper a span{font-size:14px!important;font-weight:400}.home-p-description{margin-bottom:16px;margin-top:8px;line-height:160%!important}.home-content-wrapper a{border-radius:6px;font-size:14px}.dark .home-content-wrapper a{background-color:#1d1d1d!important}#navbar [role=\"tablist\"],#navbar ul{justify-content:center!important;flex:1;margin:0 auto!important}.dark .bg-primary\\/10{background-color:#111111}.dark\\:bg-\\[\\#09090B\\]:is(.dark *){--tw-bg-opacity: 1;background-color:#111111}.dark\\:bg-white\\/5:is(.dark *){background-color:rgb(255 255 255 / 8%)}"}],"page":{"pagePath":"api-reference/usage/get-usage-summary","slug":"/api-reference/usage/get-usage-summary","pageMetadata":{"title":"Get usage summary","description":"Retrieve aggregated usage data across all customers for the tenant.","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/usage/summary","href":"/api-reference/usage/get-usage-summary","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve aggregated usage data across all customers for the tenant.\"\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":"Get usage summary","description":"Retrieve aggregated usage data across all customers for the tenant.","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/usage/summary","href":"/api-reference/usage/get-usage-summary","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Usage"],"summary":"Get usage summary","description":"Retrieve aggregated usage data across all customers for the tenant.","operationId":"get_usage_summary","parameters":["3390559e-20c9-4506-a907-828634603d48","18b6aed8-4198-4ee9-b5f3-6fccb6e344f8","47ea31cd-ff11-4ab1-a91c-41714165eb9e"],"responses":{"200":"d0d40f7d-2bfe-4163-9f15-593924c3efda","401":"e9a2b51f-60df-44a7-b9ee-5c728ed00457","429":"314976d1-e161-48ac-bb75-f465caf75cb1","500":"a06125da-d591-44d4-ad04-e23bb1047f9c"},"security":["13bfc9f2-4f41-4097-b18b-308edec90eeb"],"method":"get","type":"path","servers":[],"path":"/api/v1/usage/summary","baseUrlOptions":[],"title":"Get usage summary","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3390559e-20c9-4506-a907-828634603d48":{"name":"start_date","in":"query","required":true,"schema":{"type":"string","format":"date","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cdate>"}},"18b6aed8-4198-4ee9-b5f3-6fccb6e344f8":{"name":"end_date","in":"query","required":true,"schema":{"type":"string","format":"date","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cdate>"}},"47ea31cd-ff11-4ab1-a91c-41714165eb9e":{"name":"metric_id","in":"query","required":false,"schema":{"type":"string","format":"MeteroidId","examples":["bm_7n42DGM5Tflk9n8mt7Fhc7"],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cMeteroidId>"}}},"responses":{"d0d40f7d-2bfe-4163-9f15-593924c3efda":{"description":"Usage summary","content":{"application/json":{"schema":{"type":"object","required":["period_start","period_end","usage"],"properties":{"period_end":{"type":"string","format":"date","isRequired":true,"uniqueKey":"period_end","typeLabel":"string\u003cdate>"},"period_start":{"type":"string","format":"date","isRequired":true,"uniqueKey":"period_start","typeLabel":"string\u003cdate>"},"usage":{"type":"array","items":{"type":"object","required":["metric_id","metric_name","metric_code","total_value","grouped_usage"],"properties":{"grouped_usage":{"type":"array","items":{"type":"object","required":["value","dimensions"],"properties":{"dimensions":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"usage.items.[INDEX].grouped_usage.items.[INDEX].dimensions.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"isRequired":true,"uniqueKey":"usage.items.[INDEX].grouped_usage.items.[INDEX].dimensions","typeLabel":"object"},"value":{"type":"string","format":"decimal","isRequired":true,"uniqueKey":"usage.items.[INDEX].grouped_usage.items.[INDEX].value","typeLabel":"string\u003cdecimal>"}},"uniqueKey":"usage.items.[INDEX].grouped_usage.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"usage.items.[INDEX].grouped_usage","typeLabel":"object[]"},"metric_code":{"type":"string","isRequired":true,"uniqueKey":"usage.items.[INDEX].metric_code","typeLabel":"string"},"metric_id":{"type":"string","format":"MeteroidId","examples":["bm_7n42DGM5Tflk9n8mt7Fhc7"],"isRequired":true,"uniqueKey":"usage.items.[INDEX].metric_id","typeLabel":"string\u003cMeteroidId>"},"metric_name":{"type":"string","isRequired":true,"uniqueKey":"usage.items.[INDEX].metric_name","typeLabel":"string"},"total_value":{"type":"string","format":"decimal","isRequired":true,"uniqueKey":"usage.items.[INDEX].total_value","typeLabel":"string\u003cdecimal>"},"costs":{"oneOf":[{"type":"array","items":{"type":"object","description":"Usage priced as its invoice line prices it, before discounts and credits: tax-inclusive when\nthe subscription's prices are.","required":["amount","currency","unit"],"properties":{"amount":{"type":"string","format":"decimal","isRequired":true,"uniqueKey":"usage.items.[INDEX].costs.oneOf.0.items.[INDEX].amount","typeLabel":"string\u003cdecimal>"},"currency":{"type":"string","description":"A currency code, or a credit unit code when `unit` is `CREDIT_UNIT`.","isRequired":true,"uniqueKey":"usage.items.[INDEX].costs.oneOf.0.items.[INDEX].currency","typeLabel":"string"},"unit":{"type":"string","description":"What a cost is counted in.","enum":["CURRENCY","CREDIT_UNIT"],"isRequired":true,"uniqueKey":"usage.items.[INDEX].costs.oneOf.0.items.[INDEX].unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"usage.items.[INDEX].costs.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Beta: what the metric's usage adds so far to the subscription's next invoice, per currency\nor credit unit; empty while it bills nothing, as during a free trial or once cancelled.","uniqueKey":"usage.items.[INDEX].costs.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Usage priced as its invoice line prices it, before discounts and credits: tax-inclusive when\nthe subscription's prices are.","required":["amount","currency","unit"],"properties":{"amount":{"type":"string","format":"decimal"},"currency":{"type":"string","description":"A currency code, or a credit unit code when `unit` is `CREDIT_UNIT`."},"unit":{"type":"string","description":"What a cost is counted in.","enum":["CURRENCY","CREDIT_UNIT"]}}},"description":"Beta: what the metric's usage adds so far to the subscription's next invoice, per currency\nor credit unit; empty while it bills nothing, as during a free trial or once cancelled.","uniqueKey":"usage.items.[INDEX].costs.oneOf.1","typeLabel":"null"}],"uniqueKey":"usage.items.[INDEX].costs","typeLabel":"object[] | null"}},"uniqueKey":"usage.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"usage","typeLabel":"object[]"},"computed_at":{"oneOf":[{"type":"string","format":"date-time","description":"Beta: when `totals` and the metrics' `costs` were computed. These are present only when a\nsubscription's current billing period is read (no `start_date` nor `end_date`) and its\nusage could be priced.","uniqueKey":"computed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Beta: when `totals` and the metrics' `costs` were computed. These are present only when a\nsubscription's current billing period is read (no `start_date` nor `end_date`) and its\nusage could be priced.","uniqueKey":"computed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"computed_at","typeLabel":"string\u003cdate-time> | null"},"totals":{"oneOf":[{"type":"array","items":{"type":"object","description":"Usage priced as its invoice line prices it, before discounts and credits: tax-inclusive when\nthe subscription's prices are.","required":["amount","currency","unit"],"properties":{"amount":{"type":"string","format":"decimal","isRequired":true,"uniqueKey":"totals.oneOf.0.items.[INDEX].amount","typeLabel":"string\u003cdecimal>"},"currency":{"type":"string","description":"A currency code, or a credit unit code when `unit` is `CREDIT_UNIT`.","isRequired":true,"uniqueKey":"totals.oneOf.0.items.[INDEX].currency","typeLabel":"string"},"unit":{"type":"string","description":"What a cost is counted in.","enum":["CURRENCY","CREDIT_UNIT"],"isRequired":true,"uniqueKey":"totals.oneOf.0.items.[INDEX].unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"totals.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Beta: the sum of the metrics' `costs`, per currency or credit unit.","uniqueKey":"totals.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Usage priced as its invoice line prices it, before discounts and credits: tax-inclusive when\nthe subscription's prices are.","required":["amount","currency","unit"],"properties":{"amount":{"type":"string","format":"decimal"},"currency":{"type":"string","description":"A currency code, or a credit unit code when `unit` is `CREDIT_UNIT`."},"unit":{"type":"string","description":"What a cost is counted in.","enum":["CURRENCY","CREDIT_UNIT"]}}},"description":"Beta: the sum of the metrics' `costs`, per currency or credit unit.","uniqueKey":"totals.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"period_end":"2023-12-25","period_start":"2023-12-25","usage":[{"grouped_usage":[{"dimensions":{},"value":"\u003cstring>"}],"metric_code":"\u003cstring>","metric_id":"bm_7n42DGM5Tflk9n8mt7Fhc7","metric_name":"\u003cstring>","total_value":"\u003cstring>","costs":[{"amount":"\u003cstring>","currency":"\u003cstring>","unit":"CURRENCY"}]}],"computed_at":"2023-11-07T05:31:56Z","totals":[{"amount":"\u003cstring>","currency":"\u003cstring>","unit":"CURRENCY"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"e9a2b51f-60df-44a7-b9ee-5c728ed00457":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["BAD_REQUEST","NOT_FOUND","CONFLICT","FORBIDDEN","UNAUTHORIZED","TOKEN_EXPIRED","TOO_MANY_REQUESTS","INTERNAL_SERVER_ERROR"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"314976d1-e161-48ac-bb75-f465caf75cb1":{"description":"Too many requests","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["BAD_REQUEST","NOT_FOUND","CONFLICT","FORBIDDEN","UNAUTHORIZED","TOKEN_EXPIRED","TOO_MANY_REQUESTS","INTERNAL_SERVER_ERROR"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"a06125da-d591-44d4-ad04-e23bb1047f9c":{"description":"Internal error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["BAD_REQUEST","NOT_FOUND","CONFLICT","FORBIDDEN","UNAUTHORIZED","TOKEN_EXPIRED","TOO_MANY_REQUESTS","INTERNAL_SERVER_ERROR"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"13bfc9f2-4f41-4097-b18b-308edec90eeb":{"bearer_auth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer_auth"}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearer_auth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer_auth","name":"Authorization"}],"title":"bearer_auth"}]},"originalFileLocation":"https://api.meteroid.com/api-docs/openapi.json"},"subdomain":"meteroid","siteName":"Meteroid Documentation","title":"Get usage summary - Meteroid Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T02:32:51.974Z","originalFileLocation":"api-reference/usage/get-usage-summary.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=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve aggregated usage data across all customers for the tenant.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Meteroid Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/meteroid/vMTyDzO5Zoa0hJk0/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/meteroid/vMTyDzO5Zoa0hJk0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/meteroid/vMTyDzO5Zoa0hJk0/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/meteroid/vMTyDzO5Zoa0hJk0/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/meteroid/vMTyDzO5Zoa0hJk0/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/meteroid/vMTyDzO5Zoa0hJk0/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/meteroid/vMTyDzO5Zoa0hJk0/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/meteroid/vMTyDzO5Zoa0hJk0/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/meteroid/vMTyDzO5Zoa0hJk0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get usage summary - Meteroid Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve aggregated usage data across all customers for the tenant.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Meteroid Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.meteroid.com/api-reference/usage/get-usage-summary\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://meteroid.mintlify.app/_mintlify/api/og/v2?division=Usage\u0026amp;title=Get+usage+summary\u0026amp;description=Retrieve+aggregated+usage+data+across+all+customers+for+the+tenant.\u0026amp;theme=748199f25fbb529687f98b1e\u0026amp;signature=f121a4afbf16b532a75b3b94203ff3c060dd0a4ab8e0131390595e8420d7bc89\">\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=\"Get usage summary - Meteroid Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve aggregated usage data across all customers for the tenant.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://meteroid.mintlify.app/_mintlify/api/og/v2?division=Usage\u0026amp;title=Get+usage+summary\u0026amp;description=Retrieve+aggregated+usage+data+across+all+customers+for+the+tenant.\u0026amp;theme=748199f25fbb529687f98b1e\u0026amp;signature=f121a4afbf16b532a75b3b94203ff3c060dd0a4ab8e0131390595e8420d7bc89\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/meteroid/vMTyDzO5Zoa0hJk0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Meteroid Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.meteroid.com/api-reference/usage/get-usage-summary\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/usage/get-usage-summary.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.meteroid.com/#organization\",\"name\":\"Meteroid Documentation\",\"url\":\"https://docs.meteroid.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/meteroid/DXZxL5GMStRjxkBm/logo/light.svg?fit=max\u0026auto=format\u0026n=DXZxL5GMStRjxkBm\u0026q=85\u0026s=1fff7e555af3dab03da62c204c63d3c8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.meteroid.com#website\",\"name\":\"Meteroid Documentation\",\"url\":\"https://docs.meteroid.com\",\"publisher\":{\"@id\":\"https://docs.meteroid.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.meteroid.com/api-reference/usage/get-usage-summary#webpage\",\"url\":\"https://docs.meteroid.com/api-reference/usage/get-usage-summary\",\"name\":\"Get usage summary\",\"description\":\"Retrieve aggregated usage data across all customers for the tenant.\",\"dateModified\":\"2026-11-05T02:32:51.974Z\",\"isPartOf\":{\"@id\":\"https://docs.meteroid.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.meteroid.com/api-reference/usage/get-usage-summary#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.meteroid.com/api-reference/usage/get-usage-summary#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Usage\",\"item\":\"https://docs.meteroid.com/api-reference/usage/get-customer-usage\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get usage summary\",\"item\":\"https://docs.meteroid.com/api-reference/usage/get-usage-summary\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.meteroid.com/api-reference/usage/get-usage-summary#apireference\",\"headline\":\"Get usage summary\",\"name\":\"Get usage summary\",\"description\":\"Retrieve aggregated usage data across all customers for the tenant.\",\"url\":\"https://docs.meteroid.com/api-reference/usage/get-usage-summary\",\"mainEntityOfPage\":{\"@id\":\"https://docs.meteroid.com/api-reference/usage/get-usage-summary#webpage\"},\"dateModified\":\"2026-11-05T02:32:51.974Z\",\"publisher\":{\"@id\":\"https://docs.meteroid.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.meteroid.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Meteroid Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Meteroid Documentation","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"book","href":"https://meteroid.com/blog"},{"anchor":"Talk to us","icon":"message","href":"https://meteroid.com/talk-to-us"},{"anchor":"GitHub","icon":"github","href":"https://go.meteroid.com/github"}]},"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/home"}]},{"tab":"API Reference","groups":[{"group":"Add-ons","pages":[{"title":"List add-ons","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/addons","href":"/api-reference/add-ons/list-add-ons"},{"title":"Create an add-on","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/addons","href":"/api-reference/add-ons/create-an-add-on"},{"title":"Get add-on details","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/addons/{addon_id}","href":"/api-reference/add-ons/get-add-on-details"},{"title":"Update an add-on","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/addons/{addon_id}","href":"/api-reference/add-ons/update-an-add-on"},{"title":"Archive an add-on","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/addons/{addon_id}/archive","href":"/api-reference/add-ons/archive-an-add-on"},{"title":"List add-on entitlements","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/addons/{addon_id}/entitlements","href":"/api-reference/add-ons/list-add-on-entitlements"},{"title":"Create add-on entitlements","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/addons/{addon_id}/entitlements","href":"/api-reference/add-ons/create-add-on-entitlements"},{"title":"Unarchive an add-on","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/addons/{addon_id}/unarchive","href":"/api-reference/add-ons/unarchive-an-add-on"}]},{"group":"Batch Jobs","pages":[{"title":"List batch jobs","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/batch-jobs","href":"/api-reference/batch-jobs/list-batch-jobs"},{"title":"Get batch job detail","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/batch-jobs/{batch_job_id}","href":"/api-reference/batch-jobs/get-batch-job-detail"},{"title":"List batch job failures","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/batch-jobs/{batch_job_id}/failures","href":"/api-reference/batch-jobs/list-batch-job-failures"}]},{"group":"Checkout Sessions","pages":[{"title":"List checkout sessions","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/checkout-sessions","href":"/api-reference/checkout-sessions/list-checkout-sessions"},{"title":"Create a checkout session","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/checkout-sessions","href":"/api-reference/checkout-sessions/create-a-checkout-session"},{"title":"Get a checkout session by ID","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/checkout-sessions/{id}","href":"/api-reference/checkout-sessions/get-a-checkout-session-by-id"},{"title":"Cancel a checkout session","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/checkout-sessions/{id}/cancel","href":"/api-reference/checkout-sessions/cancel-a-checkout-session"}]},{"group":"Connect","pages":[{"title":"List connected accounts","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/connected-accounts","href":"/api-reference/connect/list-connected-accounts"},{"title":"Create connected account","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/connected-accounts","href":"/api-reference/connect/create-connected-account"},{"title":"Get connected account","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/connected-accounts/{id}","href":"/api-reference/connect/get-connected-account"},{"title":"Disconnect account","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json delete /api/v1/connected-accounts/{id}","href":"/api-reference/connect/disconnect-account"},{"title":"Create onboarding link","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/connected-accounts/{id}/onboarding","href":"/api-reference/connect/create-onboarding-link"}]},{"group":"Coupons","pages":[{"title":"List coupons","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/coupons","href":"/api-reference/coupons/list-coupons"},{"title":"Create a coupon","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/coupons","href":"/api-reference/coupons/create-a-coupon"},{"title":"Get coupon details","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/coupons/{coupon_id}","href":"/api-reference/coupons/get-coupon-details"},{"title":"Update a coupon","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/coupons/{coupon_id}","href":"/api-reference/coupons/update-a-coupon"},{"title":"Archive a coupon","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/coupons/{coupon_id}/archive","href":"/api-reference/coupons/archive-a-coupon"},{"title":"Disable a coupon","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/coupons/{coupon_id}/disable","href":"/api-reference/coupons/disable-a-coupon"},{"title":"Enable a coupon","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/coupons/{coupon_id}/enable","href":"/api-reference/coupons/enable-a-coupon"},{"title":"Unarchive a coupon","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/coupons/{coupon_id}/unarchive","href":"/api-reference/coupons/unarchive-a-coupon"}]},{"group":"Credit Notes","pages":[{"title":"List credit notes","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/credit-notes","href":"/api-reference/credit-notes/list-credit-notes"},{"title":"Get credit note","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/credit-notes/{credit_note_id}","href":"/api-reference/credit-notes/get-credit-note"},{"title":"Update credit note custom properties","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/credit-notes/{credit_note_id}/custom-properties","href":"/api-reference/credit-notes/update-credit-note-custom-properties"},{"title":"Get apiv1credit notes download","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/credit-notes/{credit_note_id}/download","href":"/api-reference/credit-notes/get-apiv1credit-notes-download"},{"title":"Download credit note e-invoice XML","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/credit-notes/{credit_note_id}/xml","href":"/api-reference/credit-notes/download-credit-note-e-invoice-xml"}]},{"group":"Credit units","pages":[{"title":"List credit units","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/credit-units","href":"/api-reference/credit-units/list-credit-units"},{"title":"Create a credit unit","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/credit-units","href":"/api-reference/credit-units/create-a-credit-unit"},{"title":"Get a credit unit","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/credit-units/{id}","href":"/api-reference/credit-units/get-a-credit-unit"},{"title":"Update a credit unit","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/credit-units/{id}","href":"/api-reference/credit-units/update-a-credit-unit"},{"title":"List a credit unit's selling prices","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/credit-units/{id}/prices","href":"/api-reference/credit-units/list-a-credit-units-selling-prices"},{"title":"Set a credit unit's selling price","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json put /api/v1/credit-units/{id}/prices/{currency}","href":"/api-reference/credit-units/set-a-credit-units-selling-price"},{"title":"Remove a credit unit's selling price","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json delete /api/v1/credit-units/{id}/prices/{currency}","href":"/api-reference/credit-units/remove-a-credit-units-selling-price"}]},{"group":"Custom Properties","pages":[{"title":"List custom property definitions","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/custom-property-definitions","href":"/api-reference/custom-properties/list-custom-property-definitions"},{"title":"Create a custom property definition","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/custom-property-definitions","href":"/api-reference/custom-properties/create-a-custom-property-definition"},{"title":"Get a custom property definition","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/custom-property-definitions/{id}","href":"/api-reference/custom-properties/get-a-custom-property-definition"},{"title":"Update a custom property definition","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json put /api/v1/custom-property-definitions/{id}","href":"/api-reference/custom-properties/update-a-custom-property-definition"},{"title":"Archive a custom property definition","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json delete /api/v1/custom-property-definitions/{id}","href":"/api-reference/custom-properties/archive-a-custom-property-definition"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/customers","href":"/api-reference/customers/list-customers"},{"title":"Create customer","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/customers","href":"/api-reference/customers/create-customer"},{"title":"Get customer","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/customers/{id_or_alias}","href":"/api-reference/customers/get-customer"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json put /api/v1/customers/{id_or_alias}","href":"/api-reference/customers/update-customer"},{"title":"Archive a customer","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json delete /api/v1/customers/{id_or_alias}","href":"/api-reference/customers/archive-a-customer"},{"title":"Patch customer","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/customers/{id_or_alias}","href":"/api-reference/customers/patch-customer"},{"title":"List customer entitlements","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/customers/{id_or_alias}/entitlements","href":"/api-reference/customers/list-customer-entitlements"},{"title":"Generate a portal token for a customer","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/customers/{id_or_alias}/portal-token","href":"/api-reference/customers/generate-a-portal-token-for-a-customer"},{"title":"Restore an archived customer","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/customers/{id_or_alias}/unarchive","href":"/api-reference/customers/restore-an-archived-customer"}]},{"group":"Budgets","pages":[{"title":"List budgets","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/customers/{id_or_alias}/budgets","href":"/api-reference/budgets/list-budgets"},{"title":"Create a budget","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/customers/{id_or_alias}/budgets","href":"/api-reference/budgets/create-a-budget"},{"title":"Update a budget","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/customers/{id_or_alias}/budgets/{budget_id}","href":"/api-reference/budgets/update-a-budget"},{"title":"Archive a budget","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/customers/{id_or_alias}/budgets/{budget_id}/archive","href":"/api-reference/budgets/archive-a-budget"}]},{"group":"Credits","pages":[{"title":"List credit grants","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/customers/{id_or_alias}/credit-grants","href":"/api-reference/credits/list-credit-grants"},{"title":"Create a credit grant","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/customers/{id_or_alias}/credit-grants","href":"/api-reference/credits/create-a-credit-grant"},{"title":"List credit ledger entries","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/customers/{id_or_alias}/credit-ledger","href":"/api-reference/credits/list-credit-ledger-entries"},{"title":"Create a top-up","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/customers/{id_or_alias}/top-ups","href":"/api-reference/credits/create-a-top-up"},{"title":"List wallets","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/customers/{id_or_alias}/wallets","href":"/api-reference/credits/list-wallets"},{"title":"Check wallet access","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/customers/{id_or_alias}/wallets/check","href":"/api-reference/credits/check-wallet-access"},{"title":"Configure a wallet","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/customers/{id_or_alias}/wallets/{currency}","href":"/api-reference/credits/configure-a-wallet"}]},{"group":"Checks","pages":[{"title":"Check customer entitlement","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/customers/{id_or_alias}/entitlements/{feature_id_or_code}/check","href":"/api-reference/checks/check-customer-entitlement"}]},{"group":"Entitlements","pages":[{"title":"Get entitlement details","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/entitlements/{entitlement_id}","href":"/api-reference/entitlements/get-entitlement-details"},{"title":"Delete an entitlement","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json delete /api/v1/entitlements/{entitlement_id}","href":"/api-reference/entitlements/delete-an-entitlement"},{"title":"Update an entitlement","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/entitlements/{entitlement_id}","href":"/api-reference/entitlements/update-an-entitlement"}]},{"group":"Events","pages":[{"title":"Ingest events","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/events/ingest","href":"/api-reference/events/ingest-events"}]},{"group":"Features","pages":[{"title":"List features","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/features","href":"/api-reference/features/list-features"},{"title":"Create a feature","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/features","href":"/api-reference/features/create-a-feature"},{"title":"Get feature details","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/features/{id_or_code}","href":"/api-reference/features/get-feature-details"},{"title":"Update a feature","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/features/{id_or_code}","href":"/api-reference/features/update-a-feature"},{"title":"Archive a feature","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/features/{id_or_code}/archive","href":"/api-reference/features/archive-a-feature"},{"title":"Unarchive a feature","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/features/{id_or_code}/unarchive","href":"/api-reference/features/unarchive-a-feature"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get invoice","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/invoices/{invoice_id}","href":"/api-reference/invoices/get-invoice"},{"title":"Update invoice custom properties","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/invoices/{invoice_id}/custom-properties","href":"/api-reference/invoices/update-invoice-custom-properties"},{"title":"Download invoice PDF","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/invoices/{invoice_id}/download","href":"/api-reference/invoices/download-invoice-pdf"},{"title":"Refresh invoice","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/invoices/{invoice_id}/refresh","href":"/api-reference/invoices/refresh-invoice"},{"title":"Download invoice e-invoice XML","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/invoices/{invoice_id}/xml","href":"/api-reference/invoices/download-invoice-e-invoice-xml"}]},{"group":"Licenses","pages":[{"title":"List licenses","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/licenses","href":"/api-reference/licenses/list-licenses"},{"title":"Issue a license","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/licenses","href":"/api-reference/licenses/issue-a-license"},{"title":"Get a license","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/licenses/{license_id}","href":"/api-reference/licenses/get-a-license"},{"title":"Get a license's activation code","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/licenses/{license_id}/activation-code","href":"/api-reference/licenses/get-a-licenses-activation-code"},{"title":"Issue an offline license","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/licenses/{license_id}/offline","href":"/api-reference/licenses/issue-an-offline-license"},{"title":"Revoke a license","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/licenses/{license_id}/revoke","href":"/api-reference/licenses/revoke-a-license"},{"title":"Get the licensing signing keys","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/licensing/signing-keys","href":"/api-reference/licenses/get-the-licensing-signing-keys"}]},{"group":"Metrics","pages":[{"title":"List billable metrics","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/metrics","href":"/api-reference/metrics/list-billable-metrics"},{"title":"Create a billable metric","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/metrics","href":"/api-reference/metrics/create-a-billable-metric"},{"title":"Get metric details","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/metrics/{metric_id}","href":"/api-reference/metrics/get-metric-details"},{"title":"Update a billable metric","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/metrics/{metric_id}","href":"/api-reference/metrics/update-a-billable-metric"},{"title":"Archive a billable metric","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/metrics/{metric_id}/archive","href":"/api-reference/metrics/archive-a-billable-metric"},{"title":"Unarchive a billable metric","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/metrics/{metric_id}/unarchive","href":"/api-reference/metrics/unarchive-a-billable-metric"}]},{"group":"OAuth Apps","pages":[{"title":"List OAuth apps","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/oauth-apps","href":"/api-reference/oauth-apps/list-oauth-apps"},{"title":"Create OAuth app","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/oauth-apps","href":"/api-reference/oauth-apps/create-oauth-app"},{"title":"Get OAuth app","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/oauth-apps/{id}","href":"/api-reference/oauth-apps/get-oauth-app"},{"title":"Delete OAuth app","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json delete /api/v1/oauth-apps/{id}","href":"/api-reference/oauth-apps/delete-oauth-app"},{"title":"Rotate client secret","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/oauth-apps/{id}/rotate","href":"/api-reference/oauth-apps/rotate-client-secret"}]},{"group":"OAuth","pages":[{"title":"Introspect token","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/oauth/introspect","href":"/api-reference/oauth/introspect-token"},{"title":"Revoke token","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/oauth/revoke","href":"/api-reference/oauth/revoke-token"},{"title":"Exchange tokens","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/oauth/token","href":"/api-reference/oauth/exchange-tokens"}]},{"group":"Plans","pages":[{"title":"List plan version entitlements","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/plan-versions/{plan_version_id}/entitlements","href":"/api-reference/plans/list-plan-version-entitlements"},{"title":"Create plan version entitlements","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/plan-versions/{plan_version_id}/entitlements","href":"/api-reference/plans/create-plan-version-entitlements"},{"title":"List plans","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/plans","href":"/api-reference/plans/list-plans"},{"title":"Create a plan","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/plans","href":"/api-reference/plans/create-a-plan"},{"title":"Set or replace the plan-level minimum commitment for a draft plan version.","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json put /api/v1/plans/versions/{plan_version_id}/minimum","href":"/api-reference/plans/set-or-replace-the-plan-level-minimum-commitment-for-a-draft-plan-version"},{"title":"Remove the plan-level minimum commitment for a draft plan version.","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json delete /api/v1/plans/versions/{plan_version_id}/minimum","href":"/api-reference/plans/remove-the-plan-level-minimum-commitment-for-a-draft-plan-version"},{"title":"Get plan details","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/plans/{plan_id}","href":"/api-reference/plans/get-plan-details"},{"title":"Replace a plan","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json put /api/v1/plans/{plan_id}","href":"/api-reference/plans/replace-a-plan"},{"title":"Update plan metadata","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/plans/{plan_id}","href":"/api-reference/plans/update-plan-metadata"},{"title":"Archive a plan","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/plans/{plan_id}/archive","href":"/api-reference/plans/archive-a-plan"},{"title":"Publish a draft plan version","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/plans/{plan_id}/publish","href":"/api-reference/plans/publish-a-draft-plan-version"},{"title":"Unarchive a plan","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/plans/{plan_id}/unarchive","href":"/api-reference/plans/unarchive-a-plan"},{"title":"List plan versions","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/plans/{plan_id}/versions","href":"/api-reference/plans/list-plan-versions"}]},{"group":"Product Families","pages":[{"title":"List product families","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/product_families","href":"/api-reference/product-families/list-product-families"},{"title":"Create product family","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/product_families","href":"/api-reference/product-families/create-product-family"},{"title":"Get product family","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/product_families/{id_or_alias}","href":"/api-reference/product-families/get-product-family"}]},{"group":"Products","pages":[{"title":"List products","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/products","href":"/api-reference/products/list-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/products","href":"/api-reference/products/create-a-product"},{"title":"Get product details","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/products/{product_id}","href":"/api-reference/products/get-product-details"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/products/{product_id}","href":"/api-reference/products/update-a-product"},{"title":"Archive a product","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/products/{product_id}/archive","href":"/api-reference/products/archive-a-product"},{"title":"List product entitlements","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/products/{product_id}/entitlements","href":"/api-reference/products/list-product-entitlements"},{"title":"Create product entitlements","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/products/{product_id}/entitlements","href":"/api-reference/products/create-product-entitlements"},{"title":"Unarchive a product","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/products/{product_id}/unarchive","href":"/api-reference/products/unarchive-a-product"}]},{"group":"Subscriptions","pages":[{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/subscriptions","href":"/api-reference/subscriptions/list-subscriptions"},{"title":"Create subscription","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/subscriptions","href":"/api-reference/subscriptions/create-subscription"},{"title":"Get subscription details","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/subscriptions/{subscription_id}","href":"/api-reference/subscriptions/get-subscription-details"},{"title":"Update subscription","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/subscriptions/{subscription_id}","href":"/api-reference/subscriptions/update-subscription"},{"title":"Cancel subscription","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/subscriptions/{subscription_id}/cancel","href":"/api-reference/subscriptions/cancel-subscription"},{"title":"List subscription entitlements","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/subscriptions/{subscription_id}/entitlements","href":"/api-reference/subscriptions/list-subscription-entitlements"},{"title":"Get subscription summary","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/subscriptions/{subscription_id}/summary","href":"/api-reference/subscriptions/get-subscription-summary"}]},{"group":"Usage","pages":[{"title":"Get customer usage","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/usage/customer/{customer_id}","href":"/api-reference/usage/get-customer-usage"},{"title":"Get unattributed usage","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/usage/customer/{customer_id}/unattributed","href":"/api-reference/usage/get-unattributed-usage"},{"title":"Get subscription usage","description":"Retrieve aggregated usage data for a subscription's usage-based components.\nIf start_date/end_date are omitted, defaults to the current billing period, and the response\nthen carries the running total (beta): what each metric's usage adds so far to the next invoice,\nand what they add up to, before discounts and credits. That reading is shared for up to 30\nseconds (see `computed_at`). Counts towards the usage cost reads' rate limit.","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/usage/subscription/{subscription_id}","href":"/api-reference/usage/get-subscription-usage"},{"title":"Get usage summary","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/usage/summary","href":"/api-reference/usage/get-usage-summary"}]},{"group":"Usage costs","pages":[{"title":"List a customer's usage costs over time","description":"A customer's usage of one billable metric and what it costs, per hour, day or month, optionally\nsplit by an event property, summed across the subscriptions that bill it. Buckets are cut at UTC\nboundaries and only cover the customer's billing periods. Per-unit and matrix pricing give exact\ncosts. For pricing that depends on the whole period's usage (tiered, volume, package, capacity),\na bucket's cost is what it adds to the period's price so far and `exact` is false. The range is\nat most 93 days.\n\nBeta: the request and response shapes of this endpoint may change before general availability.","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/usage/customer/{customer_id}/costs","href":"/api-reference/usage-costs/list-a-customers-usage-costs-over-time"},{"title":"List a customer's usage events with their cost","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/usage/customer/{customer_id}/events","href":"/api-reference/usage-costs/list-a-customers-usage-events-with-their-cost"},{"title":"List a subscription's usage costs over time","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/usage/subscription/{subscription_id}/costs","href":"/api-reference/usage-costs/list-a-subscriptions-usage-costs-over-time"},{"title":"List a subscription's usage events with their cost","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/usage/subscription/{subscription_id}/events","href":"/api-reference/usage-costs/list-a-subscriptions-usage-events-with-their-cost"}]},{"group":"Webhook Endpoints","pages":[{"title":"Resend a webhook delivery","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/webhooks/deliveries/{delivery_id}/resend","href":"/api-reference/webhook-endpoints/resend-a-webhook-delivery"},{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/webhooks/endpoints","href":"/api-reference/webhook-endpoints/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/webhooks/endpoints","href":"/api-reference/webhook-endpoints/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/webhooks/endpoints/{endpoint_id}","href":"/api-reference/webhook-endpoints/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json delete /api/v1/webhooks/endpoints/{endpoint_id}","href":"/api-reference/webhook-endpoints/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json patch /api/v1/webhooks/endpoints/{endpoint_id}","href":"/api-reference/webhook-endpoints/update-a-webhook-endpoint"},{"title":"List deliveries for a webhook endpoint","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/webhooks/endpoints/{endpoint_id}/deliveries","href":"/api-reference/webhook-endpoints/list-deliveries-for-a-webhook-endpoint"},{"title":"Rotate a webhook endpoint secret","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json post /api/v1/webhooks/endpoints/{endpoint_id}/rotate-secret","href":"/api-reference/webhook-endpoints/rotate-a-webhook-endpoint-secret"},{"title":"Reveal a webhook endpoint secret","deprecated":null,"version":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json get /api/v1/webhooks/endpoints/{endpoint_id}/secret","href":"/api-reference/webhook-endpoints/reveal-a-webhook-endpoint-secret"}]},{"group":"webhooks","pages":[{"title":"Addonarchived webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook addon.archived","href":"/api-reference/webhooks/addonarchived-webhook"},{"title":"Addoncreated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook addon.created","href":"/api-reference/webhooks/addoncreated-webhook"},{"title":"Addonupdated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook addon.updated","href":"/api-reference/webhooks/addonupdated-webhook"},{"title":"Budgetexceeded webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook budget.exceeded","href":"/api-reference/webhooks/budgetexceeded-webhook"},{"title":"Budgetthreshold reached webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook budget.threshold_reached","href":"/api-reference/webhooks/budgetthreshold_reached-webhook"},{"title":"Couponarchived webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook coupon.archived","href":"/api-reference/webhooks/couponarchived-webhook"},{"title":"Couponcreated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook coupon.created","href":"/api-reference/webhooks/couponcreated-webhook"},{"title":"Couponupdated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook coupon.updated","href":"/api-reference/webhooks/couponupdated-webhook"},{"title":"Credit grantexpired webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook credit_grant.expired","href":"/api-reference/webhooks/credit_grantexpired-webhook"},{"title":"Credit notecreated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook credit_note.created","href":"/api-reference/webhooks/credit_notecreated-webhook"},{"title":"Credit notefinalized webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook credit_note.finalized","href":"/api-reference/webhooks/credit_notefinalized-webhook"},{"title":"Credit notevoided webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook credit_note.voided","href":"/api-reference/webhooks/credit_notevoided-webhook"},{"title":"Customercreated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook customer.created","href":"/api-reference/webhooks/customercreated-webhook"},{"title":"Entitlementlimit reached webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook entitlement.limit_reached","href":"/api-reference/webhooks/entitlementlimit_reached-webhook"},{"title":"Entitlementtoo many groups webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook entitlement.too_many_groups","href":"/api-reference/webhooks/entitlementtoo_many_groups-webhook"},{"title":"Entitlementusage threshold reached webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook entitlement.usage_threshold_reached","href":"/api-reference/webhooks/entitlementusage_threshold_reached-webhook"},{"title":"Invoiceaccounting pdf generated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook invoice.accounting_pdf_generated","href":"/api-reference/webhooks/invoiceaccounting_pdf_generated-webhook"},{"title":"Invoiceclosed webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook invoice.closed","href":"/api-reference/webhooks/invoiceclosed-webhook"},{"title":"Invoiceconsolidated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook invoice.consolidated","href":"/api-reference/webhooks/invoiceconsolidated-webhook"},{"title":"Invoicecreated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook invoice.created","href":"/api-reference/webhooks/invoicecreated-webhook"},{"title":"Invoicedeleted webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook invoice.deleted","href":"/api-reference/webhooks/invoicedeleted-webhook"},{"title":"Invoicefinalized webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook invoice.finalized","href":"/api-reference/webhooks/invoicefinalized-webhook"},{"title":"Invoicepaid webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook invoice.paid","href":"/api-reference/webhooks/invoicepaid-webhook"},{"title":"Invoicevoided webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook invoice.voided","href":"/api-reference/webhooks/invoicevoided-webhook"},{"title":"Metricarchived webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook metric.archived","href":"/api-reference/webhooks/metricarchived-webhook"},{"title":"Metriccreated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook metric.created","href":"/api-reference/webhooks/metriccreated-webhook"},{"title":"Metricupdated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook metric.updated","href":"/api-reference/webhooks/metricupdated-webhook"},{"title":"Paymentfailed webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook payment.failed","href":"/api-reference/webhooks/paymentfailed-webhook"},{"title":"Paymentreinstated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook payment.reinstated","href":"/api-reference/webhooks/paymentreinstated-webhook"},{"title":"Paymentreversed webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook payment.reversed","href":"/api-reference/webhooks/paymentreversed-webhook"},{"title":"Planarchived webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook plan.archived","href":"/api-reference/webhooks/planarchived-webhook"},{"title":"Plancreated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook plan.created","href":"/api-reference/webhooks/plancreated-webhook"},{"title":"Planpublished webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook plan.published","href":"/api-reference/webhooks/planpublished-webhook"},{"title":"Productarchived webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook product.archived","href":"/api-reference/webhooks/productarchived-webhook"},{"title":"Productcreated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook product.created","href":"/api-reference/webhooks/productcreated-webhook"},{"title":"Productupdated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook product.updated","href":"/api-reference/webhooks/productupdated-webhook"},{"title":"Quoteaccepted webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook quote.accepted","href":"/api-reference/webhooks/quoteaccepted-webhook"},{"title":"Quoteconverted webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook quote.converted","href":"/api-reference/webhooks/quoteconverted-webhook"},{"title":"Refundfailed webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook refund.failed","href":"/api-reference/webhooks/refundfailed-webhook"},{"title":"Refundissued webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook refund.issued","href":"/api-reference/webhooks/refundissued-webhook"},{"title":"Refundsettled webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook refund.settled","href":"/api-reference/webhooks/refundsettled-webhook"},{"title":"Subscriptioncancelled webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook subscription.cancelled","href":"/api-reference/webhooks/subscriptioncancelled-webhook"},{"title":"Subscriptioncreated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook subscription.created","href":"/api-reference/webhooks/subscriptioncreated-webhook"},{"title":"Subscriptionended webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook subscription.ended","href":"/api-reference/webhooks/subscriptionended-webhook"},{"title":"Subscriptionupdated webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook subscription.updated","href":"/api-reference/webhooks/subscriptionupdated-webhook"},{"title":"Walletauto top up cap reached webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook wallet.auto_top_up_cap_reached","href":"/api-reference/webhooks/walletauto_top_up_cap_reached-webhook"},{"title":"Walletauto top up consent changed webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook wallet.auto_top_up_consent_changed","href":"/api-reference/webhooks/walletauto_top_up_consent_changed-webhook"},{"title":"Walletauto top up failed webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook wallet.auto_top_up_failed","href":"/api-reference/webhooks/walletauto_top_up_failed-webhook"},{"title":"Walletauto top up suspended webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook wallet.auto_top_up_suspended","href":"/api-reference/webhooks/walletauto_top_up_suspended-webhook"},{"title":"Walletbalance low webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook wallet.balance_low","href":"/api-reference/webhooks/walletbalance_low-webhook"},{"title":"Walletcredit recovered webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook wallet.credit_recovered","href":"/api-reference/webhooks/walletcredit_recovered-webhook"},{"title":"Walletcredit unrecovered webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook wallet.credit_unrecovered","href":"/api-reference/webhooks/walletcredit_unrecovered-webhook"},{"title":"Walletdebited webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook wallet.debited","href":"/api-reference/webhooks/walletdebited-webhook"},{"title":"Walletdepleted webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook wallet.depleted","href":"/api-reference/webhooks/walletdepleted-webhook"},{"title":"Walletfunded webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook wallet.funded","href":"/api-reference/webhooks/walletfunded-webhook"},{"title":"Walletrecovered webhook","version":null,"deprecated":null,"openapi":"https://api.meteroid.com/api-docs/openapi.json webhook wallet.recovered","href":"/api-reference/webhooks/walletrecovered-webhook"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/product-update"}]}]},"basePath":"","title":"Get usage summary - Meteroid Documentation","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}