Your plan usage for one window, as Settings · Usage in the dashboard shows it: each metric’s count against its included quota and overage fee. Defaults to the current window; periods lists every window.
Subtotal Connector tool: get_usageYour plan usage for one window, the same figures as Settings · Usage in the dashboard: connections, purchases, events, MCP queries and API requests, each counted the way invoicing counts it and shown against your plan’s included amount and overage fee. An included of null means unlimited.The current window is the default. periods lists every window, newest first, including earlier plans’; pass one’s start as period_start to read it, with its plan_id if two plans’ windows share that start.Call it with your API key, or with a Subtotal Connector OAuth token that includes usage:read. A token without it receives 403 insufficient_scope. Partner app tokens don’t include it.
Partner OAuth: send Authorization: Bearer <access_token>, an OAuth access token from Subtotal's authorization server with the scope this endpoint needs.
Every usage window, newest first: the current plan's, then earlier plans'. Pass one's start as period_start to read it.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Subtotal Docs","colors":{"primary":"#912DA8","light":"#DB41FF","dark":"#DB41FF"},"logo":{"light":"https://mintcdn.com/typecastleinc/d5UA7eGR6OP4SNAc/logo/light.svg?fit=max\u0026auto=format\u0026n=d5UA7eGR6OP4SNAc\u0026q=85\u0026s=92869634e0f56df8f5c3f380760324ec","dark":"https://mintcdn.com/typecastleinc/d5UA7eGR6OP4SNAc/logo/dark.svg?fit=max\u0026auto=format\u0026n=d5UA7eGR6OP4SNAc\u0026q=85\u0026s=76ecea195cf070d328c0efb8742bc3d4","href":"https://docs.subtotal.com/home"},"favicon":"https://mintcdn.com/typecastleinc/d5UA7eGR6OP4SNAc/favicon.svg?fit=max\u0026auto=format\u0026n=d5UA7eGR6OP4SNAc\u0026q=85\u0026s=7d18531f4733de8a41bc1685f086204f","appearance":{"default":"light"},"background":{"color":{"light":"#FFFFFF","dark":"#21002A"}},"navbar":{"links":[{"href":"https://subtotal.com/contact","label":"Contact sales"}],"primary":{"type":"button","label":"Sign in","href":"https://dashboard.subtotal.com"}},"footer":{"socials":{"x":"https://x.com/Subtotal","github":"https://github.com/subtotal","linkedin":"https://www.linkedin.com/company/SubtotalInc"}},"fonts":{"family":"Goalking","weight":400,"source":"fonts/Goalking-Rg.woff2","format":"woff2"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"typecastleinc","hasAudioNarration":false,"actualSubdomain":"typecastleinc","customDomains":["docs.subtotal.com","subtotal.com"],"gitSource":{"type":"github","owner":"subtotal","repo":"subtotal-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfb3d2689cef566e3e1600","collectionId":"2d98a3ee-61c2-4931-9e38-076743f92531","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfb3d2689cef566e3e1600"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adfb52a5ee4aab77583bcfd","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Documentation","count":58},{"language":"default","tag":"API Reference","count":34},{"language":"default","tag":"Apps","count":22},{"language":"default","tag":"Products","count":21},{"language":"default","tag":"Developers","count":10},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Connections","count":7},{"language":"default","tag":"Product groups","count":5},{"language":"default","tag":"Event simulator","count":4},{"language":"default","tag":"Connector","count":4}]},"assistantConfig":{},"basePath":"","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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"meta-purchase-flow.css","content":"#meta-purchase-flow{container:meta-purchase-flow/inline-size}#meta-purchase-flow .meta-flow-track{display:grid;gap:8px}#meta-purchase-flow .meta-flow-stage{display:grid;grid-template-columns:48px minmax(0,1fr);gap:4px 16px;align-content:start;padding:16px;min-width:0}#meta-purchase-flow .meta-flow-icon{grid-row:span 2;display:flex;align-items:center;justify-content:center;width:48px;height:48px;border-radius:12px}#meta-purchase-flow .meta-flow-title{font-size:14px;font-weight:500;line-height:24px}#meta-purchase-flow .meta-flow-detail{font-size:14px;line-height:22px}#meta-purchase-flow .meta-flow-arrow{display:flex;justify-content:center;width:48px;margin-left:16px;transform:rotate(90deg)}@container meta-purchase-flow (min-width: 640px){#meta-purchase-flow .meta-flow-track{grid-template-columns:minmax(0,1fr) 16px minmax(0,1fr) 16px minmax(0,1fr);gap:12px}#meta-purchase-flow .meta-flow-stage{grid-template-columns:minmax(0,1fr);grid-template-rows:48px 24px auto;justify-items:center;gap:12px;text-align:center}#meta-purchase-flow .meta-flow-icon{grid-row:auto}#meta-purchase-flow .meta-flow-arrow{width:16px;height:16px;margin:32px 0 0;transform:none}}"},{"filePath":"subtotal-brand.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhGq3-OXg.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhPq3-OXg.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhIq3-OXg.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhEq3-OXg.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhFq3-OXg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhLq38.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhGq3-OXg.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhPq3-OXg.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhIq3-OXg.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhEq3-OXg.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhFq3-OXg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Roboto Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/robotomono/v31/L0x5DF4xlVMF-BfR8bXMIjhLq38.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n@font-face{font-family:'Goalking';src:url(/fonts/Goalking-Rg.woff2) format('woff2');font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:'Goalking';src:url(/fonts/Goalking-Md.woff2) format('woff2');font-weight:500;font-style:normal;font-display:swap}@font-face{font-family:'Goalking';src:url(/fonts/Goalking-SmBd.woff2) format('woff2');font-weight:600;font-style:normal;font-display:swap}@font-face{font-family:'Goalking';src:url(/fonts/Goalking-Bd.woff2) format('woff2');font-weight:700;font-style:normal;font-display:swap}:root{--subtotal-pink:#db41ff;--subtotal-pink-dark:#3f074e;--subtotal-pink-light:#ffaefe;--subtotal-blue:#2d62ff;--subtotal-rich-black:#21002a}#content,#navbar,#page-title,#sidebar,body,h1,h2,h3,h4{font-family:'Goalking',Arial,sans-serif}#page-title,h1,h2,h3,h4{font-weight:700;letter-spacing:-.01em}code,kbd,pre,samp{font-family:'Roboto Mono',ui-monospace,SFMono-Regular,Menlo,monospace}html:not(.dark) #content{color:rgba(33,0,42,.85)}html:not(.dark) #content h1,html:not(.dark) #content h2,html:not(.dark) #content h3,html:not(.dark) #page-title{color:var(--subtotal-rich-black)}#topbar-cta-button a,#topbar-cta-button button{border-radius:1rem;font-weight:600}#content .callout,#content [class*=code-block],#content a.card,#content div.card,#content img.rounded-lg{border-radius:1rem}html.dark body{background-image:radial-gradient(60rem 30rem at 100% 0,rgba(219,65,255,.16),transparent 60%),radial-gradient(50rem 30rem at 0 0,rgba(45,98,255,.12),transparent 60%);background-repeat:no-repeat;background-attachment:fixed}"}],"page":{"pagePath":"docs/api-reference/account/get-usage","slug":"/docs/api-reference/account/get-usage","pageMetadata":{"openapi":"get /usage","title":"Get Usage","description":"Your plan usage for one window, as Settings · Usage in the dashboard shows it: each metric's count against its included quota and overage fee. Defaults to the current window; `periods` lists every window.","href":"/docs/api-reference/account/get-usage"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Your plan usage for one window, as Settings · Usage in the dashboard shows it: each metric’s count against its included quota and overage fee. Defaults to the current window; \", _jsx(_components.code, {\n children: \"periods\"\n }), \" lists every window.\"]\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Badge}=_components;if(!Badge)_missingMdxReference(`Badge`,true);return _jsxs(_Fragment,{children:[_jsx(_components.a,{href:`/docs/connector/tools#get_usage`,children:_jsx(Badge,{icon:`robot`,color:`purple`,children:`Subtotal Connector tool: get_usage`})}),`\n`,_jsxs(_components.p,{children:[`Your plan usage for one window, the same figures as `,_jsx(_components.strong,{children:`Settings · Usage`}),` in the dashboard: connections, purchases, events, MCP queries and API requests, each counted the way invoicing counts it and shown against your plan’s included amount and overage fee. An `,_jsx(_components.code,{children:`included`}),` of `,_jsx(_components.code,{children:`null`}),` means unlimited.`]}),`\n`,_jsxs(_components.p,{children:[`The current window is the default. `,_jsx(_components.code,{children:`periods`}),` lists every window, newest first, including earlier plans’; pass one’s `,_jsx(_components.code,{children:`start`}),` as `,_jsx(_components.code,{children:`period_start`}),` to read it, with its `,_jsx(_components.code,{children:`plan_id`}),` if two plans’ windows share that start.`]}),`\n`,_jsxs(_components.p,{children:[`Call it with your API key, or with a `,_jsx(_components.a,{href:`/docs/connector/introduction`,children:`Subtotal Connector`}),` OAuth token that includes `,_jsx(_components.code,{children:`usage:read`}),`. A token without it receives `,_jsx(_components.code,{children:`403 insufficient_scope`}),`. `,_jsx(_components.a,{href:`/docs/partner-apps/introduction#fixed-permissions`,children:`Partner app`}),` tokens don’t include it.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /usage","title":"Get Usage","description":"Your plan usage for one window, as Settings · Usage in the dashboard shows it: each metric's count against its included quota and overage fee. Defaults to the current window; `periods` lists every window.","href":"/docs/api-reference/account/get-usage"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["usage"],"summary":"Get Usage","description":"Your plan usage for one window, as Settings · Usage in the dashboard shows it: each metric's count against its included quota and overage fee. Defaults to the current window; `periods` lists every window.","operationId":"get_usage_usage_get","parameters":["f6cecb3f-9542-47c4-a2ad-a23943f1529d","44f66078-c612-4802-9146-d06d228410f5"],"responses":{"200":"ca51e3cb-f59b-4b20-8062-cdc8039ed089","404":"c7f10cc2-ab76-4e1a-96e9-130d2b198965","422":"3778742a-7cab-45cb-8297-0b5692438687"},"security":["cd13890b-3a45-4e11-acdd-16f6df5ae0b4","4bb01c99-bd7d-43be-ab9d-18695864fca7"],"method":"get","type":"path","servers":[],"path":"/usage","baseUrlOptions":[],"title":"Get Usage","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f6cecb3f-9542-47c4-a2ad-a23943f1529d":{"name":"period_start","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Period Start","description":"The `start` of a window from `periods`. Omit for the current window.","format":"date-time","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Period Start","description":"The `start` of a window from `periods`. Omit for the current window.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate-time> | null"},"description":"The `start` of a window from `periods`. Omit for the current window."},"44f66078-c612-4802-9146-d06d228410f5":{"name":"plan_id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Plan Id","description":"The window's `plan_id` from `periods`. Needed only when two plans' windows share a start.","maxLength":26,"uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Plan Id","description":"The window's `plan_id` from `periods`. Needed only when two plans' windows share a start.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"The window's `plan_id` from `periods`. Needed only when two plans' windows share a start."}},"responses":{"ca51e3cb-f59b-4b20-8062-cdc8039ed089":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"plan_id":{"type":"string","title":"Plan Id","isRequired":true,"uniqueKey":"plan_id","typeLabel":"string"},"plan_name":{"type":"string","title":"Plan Name","isRequired":true,"uniqueKey":"plan_name","typeLabel":"string"},"current_plan":{"type":"boolean","title":"Current Plan","description":"False when the window belongs to an earlier plan.","isRequired":true,"uniqueKey":"current_plan","typeLabel":"boolean"},"period_start":{"type":"string","format":"date-time","title":"Period Start","isRequired":true,"uniqueKey":"period_start","typeLabel":"string\u003cdate-time>"},"period_end":{"type":"string","format":"date-time","title":"Period End","isRequired":true,"uniqueKey":"period_end","typeLabel":"string\u003cdate-time>"},"metrics":{"items":{"properties":{"metric":{"type":"string","enum":["connections","purchases","events","mcp_queries","api_requests"],"title":"Metric","isRequired":true,"uniqueKey":"metrics.items.[INDEX].metric","typeLabel":"enum\u003cstring>"},"used":{"type":"integer","title":"Used","description":"Counted in this window, the way invoicing counts it.","isRequired":true,"uniqueKey":"metrics.items.[INDEX].used","typeLabel":"integer"},"included":{"oneOf":[{"type":"integer","title":"Included","description":"Included in the plan for this window. Null means unlimited; 0 with no additional_fee means not on the plan.","isRequired":true,"uniqueKey":"metrics.items.[INDEX].included.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Included","description":"Included in the plan for this window. Null means unlimited; 0 with no additional_fee means not on the plan.","isRequired":true,"uniqueKey":"metrics.items.[INDEX].included.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"metrics.items.[INDEX].included","typeLabel":"integer | null"},"additional_fee":{"oneOf":[{"type":"string","title":"Additional Fee","description":"Price per unit beyond `included`, in USD. Null means no overage billing.","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","isRequired":true,"uniqueKey":"metrics.items.[INDEX].additional_fee.oneOf.0","typeLabel":"string"},{"type":"null","title":"Additional Fee","description":"Price per unit beyond `included`, in USD. Null means no overage billing.","isRequired":true,"uniqueKey":"metrics.items.[INDEX].additional_fee.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"metrics.items.[INDEX].additional_fee","typeLabel":"string | null"}},"type":"object","required":["metric","used","included","additional_fee"],"title":"UsageMetric","uniqueKey":"metrics.items.[INDEX]","typeLabel":"UsageMetric · object"},"type":"array","title":"Metrics","isRequired":true,"uniqueKey":"metrics","typeLabel":"UsageMetric · object[]"},"periods":{"items":{"properties":{"start":{"type":"string","format":"date-time","title":"Start","isRequired":true,"uniqueKey":"periods.items.[INDEX].start","typeLabel":"string\u003cdate-time>"},"end":{"type":"string","format":"date-time","title":"End","isRequired":true,"uniqueKey":"periods.items.[INDEX].end","typeLabel":"string\u003cdate-time>"},"plan_id":{"type":"string","title":"Plan Id","isRequired":true,"uniqueKey":"periods.items.[INDEX].plan_id","typeLabel":"string"},"plan_name":{"type":"string","title":"Plan Name","isRequired":true,"uniqueKey":"periods.items.[INDEX].plan_name","typeLabel":"string"},"current_plan":{"type":"boolean","title":"Current Plan","description":"False for a window of an earlier plan.","isRequired":true,"uniqueKey":"periods.items.[INDEX].current_plan","typeLabel":"boolean"}},"type":"object","required":["start","end","plan_id","plan_name","current_plan"],"title":"UsageWindow","uniqueKey":"periods.items.[INDEX]","typeLabel":"UsageWindow · object"},"type":"array","title":"Periods","description":"Every usage window, newest first: the current plan's, then earlier plans'. Pass one's `start` as `period_start` to read it.","isRequired":true,"uniqueKey":"periods","typeLabel":"UsageWindow · object[]"}},"type":"object","required":["plan_id","plan_name","current_plan","period_start","period_end","metrics","periods"],"title":"UsageResponse","uniqueKey":"","typeLabel":"UsageResponse · object"},"examples":{"Example":{"title":"Example","value":{"plan_id":"\u003cstring>","plan_name":"\u003cstring>","current_plan":true,"period_start":"2023-11-07T05:31:56Z","period_end":"2023-11-07T05:31:56Z","metrics":[{"metric":"connections","used":123,"included":123,"additional_fee":"\u003cstring>"}],"periods":[{"start":"2023-11-07T05:31:56Z","end":"2023-11-07T05:31:56Z","plan_id":"\u003cstring>","plan_name":"\u003cstring>","current_plan":true}]}}},"exampleType":"generated"}},"exampleType":"generated"},"c7f10cc2-ab76-4e1a-96e9-130d2b198965":{"description":"No active plan, or no usage window starts at period_start","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"3778742a-7cab-45cb-8297-0b5692438687":{"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":{"cd13890b-3a45-4e11-acdd-16f6df5ae0b4":{"PartnerOAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Partner OAuth: send `Authorization: Bearer \u003caccess_token>`, an OAuth access token from Subtotal's authorization server with the scope this endpoint needs.","scopes":[],"schemeName":"PartnerOAuth"}},"4bb01c99-bd7d-43be-ab9d-18695864fca7":{"ApiKey":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"API key: your Subtotal API key.","scopes":[],"schemeName":"ApiKey"}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Partner OAuth: send `Authorization: Bearer \u003caccess_token>`, an OAuth access token from Subtotal's authorization server with the scope this endpoint needs.","scopes":[],"schemeName":"PartnerOAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Partner OAuth: send `Authorization: Bearer \u003caccess_token>`, an OAuth access token from Subtotal's authorization server with the scope this endpoint needs.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"PartnerOAuth","name":"Authorization"}],"title":"PartnerOAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"API key: your Subtotal API key.","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"X-Api-Key","type":"string","description":"API key: your Subtotal API key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"X-Api-Key"}],"title":"ApiKey"}]},"originalFileLocation":"docs/openapi.json"},"subdomain":"typecastleinc","siteName":"Subtotal Docs","title":"Get Usage - Subtotal Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T20:12:08.548Z","originalFileLocation":"docs/api-reference/account/get-usage.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=\"light\"}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=\"Your plan usage for one window, as Settings · Usage in the dashboard shows it: each metric\u0026#x27;s count against its included quota and overage fee. Defaults to the current window; periods lists every window.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Subtotal Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_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/typecastleinc/CqEoIfFQWU-okRJN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Usage - Subtotal Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Your plan usage for one window, as Settings · Usage in the dashboard shows it: each metric\u0026#x27;s count against its included quota and overage fee. Defaults to the current window; periods lists every window.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Subtotal Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.subtotal.com/docs/api-reference/account/get-usage\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://typecastleinc.mintlify.app/_mintlify/api/og/v2?division=Account\u0026amp;title=Get+Usage\u0026amp;description=Your+plan+usage+for+one+window%2C+as+Settings+%C2%B7+Usage+in+the+dashboard+shows+it%3A+each+metric%27s+count+against+its+included+quota+and+overage+fee.+Defaults+to+the+c\u0026amp;theme=bcf387a2f6ae8960065c4b10\u0026amp;signature=7ed08451add81c02e206c2ea54d10e77ee3f870771cc225ebe17c9da2c8aead3\">\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 - Subtotal Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Your plan usage for one window, as Settings · Usage in the dashboard shows it: each metric\u0026#x27;s count against its included quota and overage fee. Defaults to the current window; periods lists every window.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://typecastleinc.mintlify.app/_mintlify/api/og/v2?division=Account\u0026amp;title=Get+Usage\u0026amp;description=Your+plan+usage+for+one+window%2C+as+Settings+%C2%B7+Usage+in+the+dashboard+shows+it%3A+each+metric%27s+count+against+its+included+quota+and+overage+fee.+Defaults+to+the+c\u0026amp;theme=bcf387a2f6ae8960065c4b10\u0026amp;signature=7ed08451add81c02e206c2ea54d10e77ee3f870771cc225ebe17c9da2c8aead3\">\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/typecastleinc/CqEoIfFQWU-okRJN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Subtotal Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#912DA8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.subtotal.com/docs/api-reference/account/get-usage\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/account/get-usage.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.subtotal.com/#organization\",\"name\":\"Subtotal Docs\",\"url\":\"https://docs.subtotal.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/typecastleinc/d5UA7eGR6OP4SNAc/logo/light.svg?fit=max\u0026auto=format\u0026n=d5UA7eGR6OP4SNAc\u0026q=85\u0026s=92869634e0f56df8f5c3f380760324ec\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.subtotal.com#website\",\"name\":\"Subtotal Docs\",\"url\":\"https://docs.subtotal.com\",\"publisher\":{\"@id\":\"https://docs.subtotal.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.subtotal.com/docs/api-reference/account/get-usage#webpage\",\"url\":\"https://docs.subtotal.com/docs/api-reference/account/get-usage\",\"name\":\"Get Usage\",\"description\":\"Your plan usage for one window, as Settings · Usage in the dashboard shows it: each metric's count against its included quota and overage fee. Defaults to the current window; periods lists every window.\",\"dateModified\":\"2026-10-26T20:12:08.548Z\",\"isPartOf\":{\"@id\":\"https://docs.subtotal.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.subtotal.com/docs/api-reference/account/get-usage#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.subtotal.com/docs/api-reference/account/get-usage#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Account\",\"item\":\"https://docs.subtotal.com/docs/api-reference/account/get-account\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Usage\",\"item\":\"https://docs.subtotal.com/docs/api-reference/account/get-usage\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.subtotal.com/docs/api-reference/account/get-usage#apireference\",\"headline\":\"Get Usage\",\"name\":\"Get Usage\",\"description\":\"Your plan usage for one window, as Settings · Usage in the dashboard shows it: each metric's count against its included quota and overage fee. Defaults to the current window; periods lists every window.\",\"url\":\"https://docs.subtotal.com/docs/api-reference/account/get-usage\",\"mainEntityOfPage\":{\"@id\":\"https://docs.subtotal.com/docs/api-reference/account/get-usage#webpage\"},\"dateModified\":\"2026-10-26T20:12:08.548Z\",\"publisher\":{\"@id\":\"https://docs.subtotal.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.subtotal.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Subtotal Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Subtotal Docs","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/docs/introduction"}]},{"anchor":"API Reference","icon":"code","groups":[{"group":"API Reference","pages":[{"title":"Subtotal API","sidebarTitle":"Introduction","href":"/docs/api-reference/introduction"}]},{"group":"Account","pages":[{"openapi":"get /account","title":"Get Account","description":"Your own account: your team, the brands you subscribe to, your plan and what it includes, and the OAuth scopes your token was granted. Any valid credential can read it; no scope is required.","href":"/docs/api-reference/account/get-account"},{"openapi":"get /usage","title":"Get Usage","href":"/docs/api-reference/account/get-usage"}]},{"group":"Connections","pages":[{"openapi":"post /connections","title":"Create Connection","description":"Create a new connection","href":"/docs/api-reference/connections/create-connection"},{"openapi":"get /connections/{connection_id}","title":"Get Connection","href":"/docs/api-reference/connections/get-connection"},{"openapi":"get /connections","title":"Get Connections","href":"/docs/api-reference/connections/get-connections"},{"openapi":"get /connections/{connection_id}/activity","title":"Get Connection Activity Log","href":"/docs/api-reference/connections/get-connection-activity"},{"openapi":"get /connections/{connection_id}/purchases","title":"Get Connection Purchases","href":"/docs/api-reference/connections/get-connection-purchases"},{"openapi":"patch /connections/{connection_id}","title":"Update Connection","href":"/docs/api-reference/connections/update-connection"},{"openapi":"delete /connections/{connection_id}","title":"Delete Connection","href":"/docs/api-reference/connections/delete-connection"}]},{"group":"Link Tokens","pages":[{"openapi":"post /link-tokens","title":"Create Link Token","href":"/docs/api-reference/link-tokens/create-link-token"},{"openapi":"get /link-tokens","title":"List Link Tokens","href":"/docs/api-reference/link-tokens/get-link-tokens"},{"openapi":"delete /link-tokens/{link_token}","title":"Revoke Link Token","href":"/docs/api-reference/link-tokens/revoke-link-token"}]},{"group":"Connection Tokens","pages":[{"openapi":"post /connections/{connection_id}/token","title":"Create Connection Token","href":"/docs/api-reference/connections/create-connection-token"}]},{"group":"Purchases","pages":[{"openapi":"get /purchases","title":"Get Purchases","href":"/docs/api-reference/purchases/get-purchases"},{"openapi":"get /purchases/{purchase_id}","title":"Get Purchase","href":"/docs/api-reference/purchases/get-purchase"}]},{"group":"Products","pages":[{"openapi":"get /products","title":"Get Products","href":"/docs/api-reference/products/get-products"},{"openapi":"get /products/{product_id}","title":"Get Product","href":"/docs/api-reference/products/get-product"}]},{"group":"Product groups","pages":[{"openapi":"get /product-groups","title":"List Product Groups","href":"/docs/api-reference/product-groups/list-product-groups"},{"openapi":"post /product-groups","title":"Create Product Group","href":"/docs/api-reference/product-groups/create-product-group"},{"openapi":"patch /product-groups/{product_group_id}","title":"Rename Product Group","href":"/docs/api-reference/product-groups/rename-product-group"},{"openapi":"delete /product-groups/{product_group_id}","title":"Delete Product Group","href":"/docs/api-reference/product-groups/delete-product-group"},{"openapi":"put /product-groups/{product_group_id}/products","title":"Update Product Group Products","href":"/docs/api-reference/product-groups/update-product-group-products"}]},{"group":"Retailers","pages":[{"openapi":"get /retailers","title":"Get Retailers","href":"/docs/api-reference/retailers/get-retailers"},{"openapi":"patch /retailers/{retailer_id}","title":"Update Retailer","href":"/docs/api-reference/retailers/update-retailer"}]},{"group":"Event simulator","pages":[{"openapi":"post /simulated-connections","title":"Simulate Connection","href":"/docs/api-reference/simulated-connections/simulate-connection"},{"openapi":"post /simulated-connections/{connection_id}/purchases","title":"Simulate Purchase","href":"/docs/api-reference/simulated-connections/simulate-purchase"},{"openapi":"patch /simulated-connections/{connection_id}","title":"Set Simulated Status","href":"/docs/api-reference/simulated-connections/set-simulated-status"},{"openapi":"delete /simulated-connections/{connection_id}","title":"Delete Simulated Connection","href":"/docs/api-reference/simulated-connections/delete-simulated-connection"}]},{"group":"Webhooks","pages":[{"openapi":"get /webhooks","title":"List Webhooks","href":"/docs/api-reference/webhooks/get-webhooks"},{"openapi":"post /webhooks","title":"Create Webhook","href":"/docs/api-reference/webhooks/create-webhook"},{"openapi":"patch /webhooks/{webhook_id}","title":"Update Webhook","href":"/docs/api-reference/webhooks/update-webhook"},{"openapi":"delete /webhooks/{webhook_id}","title":"Delete Webhook","href":"/docs/api-reference/webhooks/delete-webhook"}]}]},{"anchor":"Create an API key","icon":"key","href":"https://dashboard.subtotal.com/api-keys"}]},"title":"Get Usage - Subtotal Docs","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}