Set while the organisation is warming up on the shared pool; null once complete.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Sendbaze","description":"Transactional email and SMS API for Africa. Send from your own domain, from servers on the continent, with webhooks, templates, suppressions and a dashboard.","colors":{"primary":"#4D7CFF","light":"#8FD6FF","dark":"#4D7CFF"},"logo":{"light":"https://mintcdn.com/sendbaze-e4685166/qQClJyyt7LIRtxE9/logo/light.svg?fit=max\u0026auto=format\u0026n=qQClJyyt7LIRtxE9\u0026q=85\u0026s=ad3774129b02e31998cf4d4b68faa6c4","dark":"https://mintcdn.com/sendbaze-e4685166/qQClJyyt7LIRtxE9/logo/dark.svg?fit=max\u0026auto=format\u0026n=qQClJyyt7LIRtxE9\u0026q=85\u0026s=996553666d3645f8510736df07dfd91b","href":"https://www.sendbaze.com"},"favicon":"https://mintcdn.com/sendbaze-e4685166/qQClJyyt7LIRtxE9/favicon.svg?fit=max\u0026auto=format\u0026n=qQClJyyt7LIRtxE9\u0026q=85\u0026s=6cbee94d357b57a8ce76524cdffd13bc","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python","ruby","php","go"]}},"appearance":{"default":"dark","strict":false},"background":{"decoration":"gradient","color":{"light":"#F5F7FF","dark":"#04060D"}},"navbar":{"links":[{"href":"https://dashboard.sendbaze.com","label":"Sign in"}],"primary":{"type":"button","label":"Get started","href":"https://www.sendbaze.com/sign-up"}},"footer":{"socials":{"github":"https://github.com/sendbaze","website":"https://www.sendbaze.com"}},"fonts":{"heading":{"family":"Space Grotesk"},"body":{"family":"Inter"}},"styling":{"codeblocks":"dark","latex":false},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://dashboard.sendbaze.com"},{"anchor":"Status","icon":"signal","href":"https://www.sendbaze.com/status"},{"anchor":"Support","icon":"envelope","href":"mailto:support@sendbaze.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sendbaze-e4685166","hasAudioNarration":false,"actualSubdomain":"sendbaze-e4685166","customDomains":["docs.sendbaze.com"],"gitSource":{"type":"github","owner":"leossaini","repo":"sendbaze","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae371adcacd1c86dbd6e99f","collectionId":"e4644757-a9be-4bcc-959f-aa0bfd3eddce","liveDeploymentHistoryId":"6ae371adcacd1c86dbd6e99f","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae371adcacd1c86dbd6e99f","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API reference","count":40},{"language":"default","tag":"Documentation","count":36},{"language":"default","tag":"Learn","count":19},{"language":"default","tag":"Get started","count":12},{"language":"default","tag":"Webhooks","count":12},{"language":"default","tag":"Domains","count":8},{"language":"default","tag":"Sending","count":8},{"language":"default","tag":"Sending examples","count":7},{"language":"default","tag":"Templates","count":7},{"language":"default","tag":"Resources","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/usage/retrieve-usage","slug":"/api-reference/usage/retrieve-usage","pageMetadata":{"title":"Retrieve usage","description":"Your plan, the current billing period, how much of each allowance is used and remaining, prepaid SMS credits and domains in use. Requires `read`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/usage","href":"/api-reference/usage/retrieve-usage","autogeneratedByOpenApi":true},"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, the current billing period, how much of each allowance is used and remaining, prepaid SMS credits and domains in use. Requires \", _jsx(_components.code, {\n children: \"read\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Retrieve usage","description":"Your plan, the current billing period, how much of each allowance is used and remaining, prepaid SMS credits and domains in use. Requires `read`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/usage","href":"/api-reference/usage/retrieve-usage","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Usage"],"summary":"Retrieve usage","operationId":"getUsage","description":"Your plan, the current billing period, how much of each allowance is used and remaining, prepaid SMS credits and domains in use. Requires `read`.","responses":{"200":"34d52d9f-37d2-4ca0-b878-227a14ecd958"},"method":"get","type":"path","servers":["99d1150c-abf8-43d0-8330-83dbd0837882"],"security":["ff7b157a-6930-432d-86e5-ece197dd1fbb"],"path":"/v1/usage","baseUrlOptions":["https://api.sendbaze.com"],"title":"Retrieve usage","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","ruby","php","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"34d52d9f-37d2-4ca0-b878-227a14ecd958":{"description":"Usage for the current period","content":{"application/json":{"schema":{"type":"object","required":["plan","period","emails","sms","wallet","overage","domains"],"properties":{"plan":{"type":"object","properties":{"id":{"type":"string","enum":["free","starter","growth","scale","payg"],"uniqueKey":"plan.id","typeLabel":"enum\u003cstring>"},"name":{"type":"string","uniqueKey":"plan.name","typeLabel":"string"},"priceRand":{"type":"number","uniqueKey":"plan.priceRand","typeLabel":"number"}},"isRequired":true,"uniqueKey":"plan","typeLabel":"object"},"period":{"type":"object","properties":{"start":{"type":"string","format":"date-time","uniqueKey":"period.start","typeLabel":"string\u003cdate-time>"},"end":{"type":"string","format":"date-time","description":"When the allowance resets.","uniqueKey":"period.end","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"period","typeLabel":"object"},"emails":{"type":"object","properties":{"used":{"type":"integer","uniqueKey":"emails.used","typeLabel":"integer"},"included":{"oneOf":[{"type":"integer","uniqueKey":"emails.included.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"emails.included.oneOf.1","typeLabel":"null"}],"uniqueKey":"emails.included","typeLabel":"integer | null"},"remaining":{"oneOf":[{"type":"integer","uniqueKey":"emails.remaining.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"emails.remaining.oneOf.1","typeLabel":"null"}],"uniqueKey":"emails.remaining","typeLabel":"integer | null"},"daily":{"oneOf":[{"type":"object","description":"Live emails counted today against the plan's daily cap; null when the plan has none.","properties":{"used":{"type":"integer","uniqueKey":"emails.daily.oneOf.0.used","typeLabel":"integer"},"cap":{"type":"integer","uniqueKey":"emails.daily.oneOf.0.cap","typeLabel":"integer"}},"uniqueKey":"emails.daily.oneOf.0","typeLabel":"object"},{"type":"null","description":"Live emails counted today against the plan's daily cap; null when the plan has none.","properties":{"used":{"type":"integer"},"cap":{"type":"integer"}},"uniqueKey":"emails.daily.oneOf.1","typeLabel":"null"}],"uniqueKey":"emails.daily","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"emails","typeLabel":"object"},"sms":{"type":"object","properties":{"used":{"type":"integer","uniqueKey":"sms.used","typeLabel":"integer"},"included":{"oneOf":[{"type":"integer","uniqueKey":"sms.included.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"sms.included.oneOf.1","typeLabel":"null"}],"uniqueKey":"sms.included","typeLabel":"integer | null"},"remaining":{"oneOf":[{"type":"integer","uniqueKey":"sms.remaining.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"sms.remaining.oneOf.1","typeLabel":"null"}],"uniqueKey":"sms.remaining","typeLabel":"integer | null"},"credits":{"type":"integer","description":"Prepaid SMS credits","used once the allowance is gone.":null,"uniqueKey":"sms.credits","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"sms","typeLabel":"object"},"wallet":{"type":"object","description":"The rand wallet. Pays sends beyond the allowance, and every send on pay as you go.","properties":{"balanceRand":{"type":"number","uniqueKey":"wallet.balanceRand","typeLabel":"number"}},"isRequired":true,"uniqueKey":"wallet","typeLabel":"object"},"overage":{"oneOf":[{"type":"object","description":"Postpaid overage accepted this period and the spend cap it stops at; null on plans without overage.","properties":{"emails":{"type":"integer","uniqueKey":"overage.oneOf.0.emails","typeLabel":"integer"},"sms":{"type":"integer","uniqueKey":"overage.oneOf.0.sms","typeLabel":"integer"},"amountRand":{"type":"number","uniqueKey":"overage.oneOf.0.amountRand","typeLabel":"number"},"spendCapRand":{"type":"number","uniqueKey":"overage.oneOf.0.spendCapRand","typeLabel":"number"}},"isRequired":true,"uniqueKey":"overage.oneOf.0","typeLabel":"object"},{"type":"null","description":"Postpaid overage accepted this period and the spend cap it stops at; null on plans without overage.","properties":{"emails":{"type":"integer"},"sms":{"type":"integer"},"amountRand":{"type":"number"},"spendCapRand":{"type":"number"}},"isRequired":true,"uniqueKey":"overage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"overage","typeLabel":"object | null"},"domains":{"type":"object","properties":{"used":{"type":"integer","uniqueKey":"domains.used","typeLabel":"integer"},"included":{"oneOf":[{"type":"integer","uniqueKey":"domains.included.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"domains.included.oneOf.1","typeLabel":"null"}],"uniqueKey":"domains.included","typeLabel":"integer | null"}},"isRequired":true,"uniqueKey":"domains","typeLabel":"object"},"warmup":{"oneOf":[{"type":"object","description":"Set while the organisation is warming up on the shared pool; null once complete.","properties":{"day":{"oneOf":[{"type":"integer","description":"Day of warm-up","starting at 1.":null,"uniqueKey":"warmup.oneOf.0.day.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Day of warm-up","starting at 1.":null,"uniqueKey":"warmup.oneOf.0.day.oneOf.1","typeLabel":"null"}],"uniqueKey":"warmup.oneOf.0.day","typeLabel":"integer | null"},"cap":{"oneOf":[{"type":"integer","description":"Today's cap on live email.","uniqueKey":"warmup.oneOf.0.cap.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Today's cap on live email.","uniqueKey":"warmup.oneOf.0.cap.oneOf.1","typeLabel":"null"}],"uniqueKey":"warmup.oneOf.0.cap","typeLabel":"integer | null"},"sentToday":{"type":"integer","uniqueKey":"warmup.oneOf.0.sentToday","typeLabel":"integer"},"resetsAt":{"type":"string","format":"date-time","description":"Start of the next UTC day","when the cap advances.":null,"uniqueKey":"warmup.oneOf.0.resetsAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"warmup.oneOf.0","typeLabel":"object"},{"type":"null","description":"Set while the organisation is warming up on the shared pool; null once complete.","properties":{"day":{"oneOf":[{"type":"integer","description":"Day of warm-up","starting at 1.":null},{"type":"null","description":"Day of warm-up","starting at 1.":null}]},"cap":{"oneOf":[{"type":"integer","description":"Today's cap on live email."},{"type":"null","description":"Today's cap on live email."}]},"sentToday":{"type":"integer"},"resetsAt":{"type":"string","format":"date-time","description":"Start of the next UTC day","when the cap advances.":null}},"uniqueKey":"warmup.oneOf.1","typeLabel":"null"}],"uniqueKey":"warmup","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"plan":{"id":"starter","name":"Starter","priceRand":249},"period":{"start":"2026-10-23T18:00:00.000Z","end":"2026-11-23T18:00:00.000Z"},"emails":{"used":4210,"included":10000,"remaining":5790},"sms":{"used":300,"included":300,"remaining":0,"credits":1000},"domains":{"used":1,"included":2}},"examples":{"Example":{"title":"Example","value":{"plan":{"id":"starter","name":"Starter","priceRand":249},"period":{"start":"2026-10-23T18:00:00.000Z","end":"2026-11-23T18:00:00.000Z"},"emails":{"used":4210,"included":10000,"remaining":5790},"sms":{"used":300,"included":300,"remaining":0,"credits":1000},"domains":{"used":1,"included":2}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ff7b157a-6930-432d-86e5-ece197dd1fbb":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key from the dashboard. `sk_live_…` sends; `sk_test_…` validates and returns ids without sending.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"99d1150c-abf8-43d0-8330-83dbd0837882":{"url":"https://api.sendbaze.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key from the dashboard. `sk_live_…` sends; `sk_test_…` validates and returns ids without sending.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key from the dashboard. `sk_live_…` sends; `sk_test_…` validates and returns ids without sending.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"sendbaze-e4685166","siteName":"Sendbaze","title":"Retrieve usage - Sendbaze","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T18:37:57.163Z","originalFileLocation":"api-reference/usage/retrieve-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=\"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=\"Your plan, the current billing period, how much of each allowance is used and remaining, prepaid SMS credits and domains in use. Requires read.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sendbaze\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sendbaze-e4685166/EerGTJNPOdlOkMSC/_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/sendbaze-e4685166/EerGTJNPOdlOkMSC/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sendbaze-e4685166/EerGTJNPOdlOkMSC/_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/sendbaze-e4685166/EerGTJNPOdlOkMSC/_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/sendbaze-e4685166/EerGTJNPOdlOkMSC/_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/sendbaze-e4685166/EerGTJNPOdlOkMSC/_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/sendbaze-e4685166/EerGTJNPOdlOkMSC/_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/sendbaze-e4685166/EerGTJNPOdlOkMSC/_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/sendbaze-e4685166/EerGTJNPOdlOkMSC/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve usage - Sendbaze\">\u003cmeta data-mint-head property=\"og:description\" content=\"Your plan, the current billing period, how much of each allowance is used and remaining, prepaid SMS credits and domains in use. Requires read.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sendbaze\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sendbaze.com/api-reference/usage/retrieve-usage\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sendbaze-e4685166.mintlify.site/_mintlify/api/og/v2?division=Usage\u0026amp;title=Retrieve+usage\u0026amp;description=Your+plan%2C+the+current+billing+period%2C+how+much+of+each+allowance+is+used+and+remaining%2C+prepaid+SMS+credits+and+domains+in+use.+Requires+%60read%60.\u0026amp;theme=e0a16bd18abb95d7926b3870\u0026amp;signature=0d931ed957ddd25c2c78fd9e5fa94c8d7a9844e1ee4799ee595928833f780ae6\">\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=\"Retrieve usage - Sendbaze\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Your plan, the current billing period, how much of each allowance is used and remaining, prepaid SMS credits and domains in use. Requires read.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sendbaze-e4685166.mintlify.site/_mintlify/api/og/v2?division=Usage\u0026amp;title=Retrieve+usage\u0026amp;description=Your+plan%2C+the+current+billing+period%2C+how+much+of+each+allowance+is+used+and+remaining%2C+prepaid+SMS+credits+and+domains+in+use.+Requires+%60read%60.\u0026amp;theme=e0a16bd18abb95d7926b3870\u0026amp;signature=0d931ed957ddd25c2c78fd9e5fa94c8d7a9844e1ee4799ee595928833f780ae6\">\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/sendbaze-e4685166/EerGTJNPOdlOkMSC/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sendbaze\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4D7CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sendbaze.com/api-reference/usage/retrieve-usage\">\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/retrieve-usage.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sendbaze.com/#organization\",\"name\":\"Sendbaze\",\"url\":\"https://docs.sendbaze.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sendbaze-e4685166/qQClJyyt7LIRtxE9/logo/light.svg?fit=max\u0026auto=format\u0026n=qQClJyyt7LIRtxE9\u0026q=85\u0026s=ad3774129b02e31998cf4d4b68faa6c4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sendbaze.com#website\",\"name\":\"Sendbaze\",\"url\":\"https://docs.sendbaze.com\",\"publisher\":{\"@id\":\"https://docs.sendbaze.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sendbaze.com/api-reference/usage/retrieve-usage#webpage\",\"url\":\"https://docs.sendbaze.com/api-reference/usage/retrieve-usage\",\"name\":\"Retrieve usage\",\"description\":\"Your plan, the current billing period, how much of each allowance is used and remaining, prepaid SMS credits and domains in use. Requires read.\",\"dateModified\":\"2026-10-26T18:37:57.163Z\",\"isPartOf\":{\"@id\":\"https://docs.sendbaze.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sendbaze.com/api-reference/usage/retrieve-usage#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sendbaze.com/api-reference/usage/retrieve-usage#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sendbaze\",\"item\":\"https://docs.sendbaze.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve usage\",\"item\":\"https://docs.sendbaze.com/api-reference/usage/retrieve-usage\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sendbaze.com/api-reference/usage/retrieve-usage#apireference\",\"headline\":\"Retrieve usage\",\"name\":\"Retrieve usage\",\"description\":\"Your plan, the current billing period, how much of each allowance is used and remaining, prepaid SMS credits and domains in use. Requires read.\",\"url\":\"https://docs.sendbaze.com/api-reference/usage/retrieve-usage\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sendbaze.com/api-reference/usage/retrieve-usage#webpage\"},\"dateModified\":\"2026-10-26T18:37:57.163Z\",\"publisher\":{\"@id\":\"https://docs.sendbaze.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sendbaze.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sendbaze\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Sendbaze","nav":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://dashboard.sendbaze.com"},{"anchor":"Status","icon":"signal","href":"https://www.sendbaze.com/status"},{"anchor":"Support","icon":"envelope","href":"mailto:support@sendbaze.com"}]},"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"API reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Errors","href":"/api-reference/errors"}]},{"group":"Emails","pages":[{"title":"Send an email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/emails","href":"/api-reference/emails/send-an-email"},{"title":"Send a batch of emails","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/emails/batch","href":"/api-reference/emails/send-a-batch-of-emails"},{"title":"Retrieve an email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/emails/{id}","href":"/api-reference/emails/retrieve-an-email"},{"title":"List emails","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/emails","href":"/api-reference/emails/list-emails"}]},{"group":"Templates","pages":[{"title":"Create a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/templates","href":"/api-reference/templates/create-a-template"},{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/templates","href":"/api-reference/templates/list-templates"},{"title":"Retrieve a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/templates/{id}","href":"/api-reference/templates/retrieve-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/templates/{id}","href":"/api-reference/templates/update-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/templates/{id}","href":"/api-reference/templates/delete-a-template"},{"title":"Preview a render","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/templates/{id}/render","href":"/api-reference/templates/preview-a-render"},{"title":"List template versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/templates/{id}/versions","href":"/api-reference/templates/list-template-versions"}]},{"group":"Domains","pages":[{"title":"Add a domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/domains","href":"/api-reference/domains/add-a-domain"},{"title":"List domains","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/domains","href":"/api-reference/domains/list-domains"},{"title":"Retrieve a domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/domains/{id}","href":"/api-reference/domains/retrieve-a-domain"},{"title":"Check a domain now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/domains/{id}/verify","href":"/api-reference/domains/check-a-domain-now"},{"title":"Delete a domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/domains/{id}","href":"/api-reference/domains/delete-a-domain"}]},{"group":"Suppressions","pages":[{"title":"List suppressions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/suppressions","href":"/api-reference/suppressions/list-suppressions"},{"title":"Add a suppression","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/suppressions","href":"/api-reference/suppressions/add-a-suppression"},{"title":"Remove a suppression","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/suppressions/{id}","href":"/api-reference/suppressions/remove-a-suppression"}]},{"group":"Webhooks","pages":[{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/webhooks","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/webhooks","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Retrieve a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/webhooks/{id}","href":"/api-reference/webhooks/retrieve-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/webhooks/{id}/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/webhooks/{id}/deliveries","href":"/api-reference/webhooks/list-deliveries"},{"title":"Replay a delivery","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/webhooks/{id}/deliveries/{deliveryId}/replay","href":"/api-reference/webhooks/replay-a-delivery"}]},{"group":"SMS","pages":[{"title":"Send an SMS","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/sms","href":"/api-reference/sms/send-an-sms"},{"title":"Send a batch of SMS","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/sms/batch","href":"/api-reference/sms/send-a-batch-of-sms"},{"title":"Retrieve an SMS","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/sms/{id}","href":"/api-reference/sms/retrieve-an-sms"},{"title":"SMS coverage","description":"Every country Sendbaze sends SMS to, with the route that carries it, the price per segment, whether the\nroute is live (`available`) and whether your organisation has enabled it (`enabled`). Sends to a country\nthat is not available answer `422 destination_not_supported`; to one your organisation has not enabled,\n`403 destination_not_enabled` with a `settingsUrl`. Requires `read`.\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/sms/coverage","href":"/api-reference/sms/sms-coverage"}]},{"group":"Usage","pages":[{"title":"Retrieve usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/usage","href":"/api-reference/usage/retrieve-usage"}]}]}]},"basePath":"","title":"Retrieve usage - Sendbaze","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}