Returns the account’s remaining credit balance, a derived health status, the auto-topup posture, and the configured low-balance thresholds. This is the remaining balance — for consumption use GET /v2/workspaces/usage.
GET
/
v2
/
billing
/
balance
Get the current account credit balance
curl --request GET \ --url https://api.topograph.co/v2/billing/balance \ --header 'x-api-key: <api-key>'
Derived health of the balance. depleted when the balance is at or below zero (new work is blocked); low when it is at or below the highest configured low-balance threshold; otherwise ok.
Resolved low-balance thresholds. A low_balance notification fires when the balance drops at or below a tier. Returned here so a client can interpret status and surface the same thresholds it is alerted on.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Topograph","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"logo":{"light":"https://mintcdn.com/semaphore/ChRp9mNNuCx3xt6W/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=ChRp9mNNuCx3xt6W\u0026q=85\u0026s=e6ce7b79992dddb6e7039eeceb3a0789","dark":"https://mintcdn.com/semaphore/ChRp9mNNuCx3xt6W/logo/logo-white.svg?fit=max\u0026auto=format\u0026n=ChRp9mNNuCx3xt6W\u0026q=85\u0026s=d2f2d6ec4b9b9ce743f9fb636e960c61"},"favicon":"https://mintcdn.com/semaphore/VQGxb8ZspQ9IKdXE/logo/icon-dark.svg?fit=max\u0026auto=format\u0026n=VQGxb8ZspQ9IKdXE\u0026q=85\u0026s=7696fde22b7a31bdfaf7bc85ac494e2c","navbar":{"links":[{"href":"https://topograph.co/pricing","label":"Pricing"},{"href":"https://app.topograph.co","label":"Dashboard"},{"href":"https://status.topograph.co","label":"Status"},{"href":"mailto:contact@topograph.co","label":"Support"}]},"footer":{"socials":{"x":"https://x.com/gettopograph","linkedin":"https://www.linkedin.com/company/topograph-data"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"semaphore","hasAudioNarration":false,"actualSubdomain":"semaphore","customDomains":["docs.topograph.co"],"gitSource":{"type":"github","owner":"getsemaphore","repo":"semaphore-api","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4b85a5507c0d0db08e070","collectionId":"a130b4c7-254c-464b-b711-36bcba8a4ac4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4b85a5507c0d0db08e070"},"feedback":{"thumbs":false,"agentFeedback":true},"entitlements":{},"buildId":"6ae4b85a5507c0d0db08e070","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Country Guides","count":112},{"language":"default","tag":"North America","count":63},{"language":"default","tag":"Documentation","count":39},{"language":"default","tag":"API Reference","count":37},{"language":"default","tag":"Europe","count":36},{"language":"default","tag":"Core Features","count":22},{"language":"default","tag":"Offshore Centers","count":10},{"language":"default","tag":"Behavior \u0026 Operations","count":7},{"language":"default","tag":"Billing Notifications","count":6},{"language":"default","tag":"Monitors","count":5}]},"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":"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":"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":"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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/billing/get-the-current-account-credit-balance","slug":"/api-reference/billing/get-the-current-account-credit-balance","pageMetadata":{"openapi":"get /v2/billing/balance","title":"Get the current account credit balance","description":"Returns the account's remaining credit balance, a derived health status, the auto-topup posture, and the configured low-balance thresholds. This is the remaining balance — for consumption use GET /v2/workspaces/usage.","href":"/api-reference/billing/get-the-current-account-credit-balance"},"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: \"Returns the account’s remaining credit balance, a derived health status, the auto-topup posture, and the configured low-balance thresholds. This is the remaining balance — for consumption use GET /v2/workspaces/usage.\"\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":{"openapi":"get /v2/billing/balance","title":"Get the current account credit balance","description":"Returns the account's remaining credit balance, a derived health status, the auto-topup posture, and the configured low-balance thresholds. This is the remaining balance — for consumption use GET /v2/workspaces/usage.","href":"/api-reference/billing/get-the-current-account-credit-balance"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/semaphore/6431d896b4d06b6a/snitcher.js"],"openApiReferenceData":{"operation":{"description":"Returns the account's remaining credit balance, a derived health status, the auto-topup posture, and the configured low-balance thresholds. This is the remaining balance — for consumption use GET /v2/workspaces/usage.","operationId":"BillingBalanceController_getBalance_v2","parameters":[],"responses":{"200":"329bcd45-108e-45be-aab1-56038b2200c0"},"security":["dee46579-ca5d-49a9-8115-5443d55c6da6"],"summary":"Get the current account credit balance","tags":["Billing"],"method":"get","type":"path","servers":["1db2fdd8-9e4b-48c6-b826-1a371fe39996"],"path":"/v2/billing/balance","baseUrlOptions":["https://api.topograph.co"],"title":"Get the current account credit balance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"329bcd45-108e-45be-aab1-56038b2200c0":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"balanceInCreditCents":{"type":"number","description":"Current remaining account balance, in credit cents.","example":42350,"isRequired":true,"uniqueKey":"balanceInCreditCents","typeLabel":"number"},"status":{"type":"string","description":"Derived health of the balance. `depleted` when the balance is at or below zero (new work is blocked); `low` when it is at or below the highest configured low-balance threshold; otherwise `ok`.","enum":["ok","low","depleted"],"example":"ok","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"autoTopup":{"type":"object","description":"Read-only auto-topup posture for the account.","required":["enabled","thresholdInCreditCents","amountInCreditCents"],"properties":{"enabled":{"type":"boolean","description":"Whether the account auto-recharges when the balance drops below the threshold.","example":true,"isRequired":true,"uniqueKey":"autoTopup.enabled","typeLabel":"boolean"},"thresholdInCreditCents":{"type":"number","description":"Balance (in credit cents) at or below which an auto-topup is triggered.","example":5000,"minimum":0,"isRequired":true,"uniqueKey":"autoTopup.thresholdInCreditCents","typeLabel":"number"},"amountInCreditCents":{"type":"number","description":"Amount (in credit cents) added to the balance on each auto-topup.","example":10000,"minimum":0,"isRequired":true,"uniqueKey":"autoTopup.amountInCreditCents","typeLabel":"number"}},"isRequired":true,"uniqueKey":"autoTopup","typeLabel":"object"},"lowBalanceThresholds":{"description":"Resolved low-balance thresholds. A low_balance notification fires when the balance drops at or below a tier. Returned here so a client can interpret `status` and surface the same thresholds it is alerted on.","type":"array","items":{"type":"object","properties":{"tier":{"type":"string","description":"Severity tier name. Must be unique within the array.","enum":["warning","critical","depleted"],"example":"warning","isRequired":true,"uniqueKey":"lowBalanceThresholds.items.[INDEX].tier","typeLabel":"enum\u003cstring>"},"cents":{"type":"number","description":"Threshold in cents (integer, same currency as the account). A notification fires when the account balance drops at or below this value.","example":100000,"minimum":0,"isRequired":true,"uniqueKey":"lowBalanceThresholds.items.[INDEX].cents","typeLabel":"number"}},"required":["tier","cents"],"uniqueKey":"lowBalanceThresholds.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"lowBalanceThresholds","typeLabel":"object[]"}},"required":["balanceInCreditCents","status","autoTopup","lowBalanceThresholds"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"balanceInCreditCents":42350,"status":"ok","autoTopup":{"enabled":true,"thresholdInCreditCents":5000,"amountInCreditCents":10000},"lowBalanceThresholds":[{"tier":"warning","cents":100000}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"dee46579-ca5d-49a9-8115-5443d55c6da6":{"x-api-key":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"x-api-key"}}},"servers":{"1db2fdd8-9e4b-48c6-b826-1a371fe39996":{"url":"https://api.topograph.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"x-api-key"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"x-api-key","name":"x-api-key"}],"title":"x-api-key"}]},"originalFileLocation":"openapi.json"},"subdomain":"semaphore","siteName":"Topograph","title":"Get the current account credit balance - Topograph","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-19T08:38:24.144Z","originalFileLocation":"api-reference/billing/get-the-current-account-credit-balance.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns the account\u0026#x27;s remaining credit balance, a derived health status, the auto-topup posture, and the configured low-balance thresholds. This is the remaining balance — for consumption use GET /v2/workspaces/usage.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Topograph\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/semaphore/dO1LV7k9tlVmoSjK/_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/semaphore/dO1LV7k9tlVmoSjK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/semaphore/dO1LV7k9tlVmoSjK/_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/semaphore/dO1LV7k9tlVmoSjK/_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/semaphore/dO1LV7k9tlVmoSjK/_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/semaphore/dO1LV7k9tlVmoSjK/_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/semaphore/dO1LV7k9tlVmoSjK/_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/semaphore/dO1LV7k9tlVmoSjK/_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/semaphore/dO1LV7k9tlVmoSjK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get the current account credit balance - Topograph\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the account\u0026#x27;s remaining credit balance, a derived health status, the auto-topup posture, and the configured low-balance thresholds. This is the remaining balance — for consumption use GET /v2/workspaces/usage.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Topograph\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.topograph.co/api-reference/billing/get-the-current-account-credit-balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://semaphore.mintlify.app/_mintlify/api/og/v2?division=Billing\u0026amp;title=Get+the+current+account+credit+balance\u0026amp;description=Returns+the+account%27s+remaining+credit+balance%2C+a+derived+health+status%2C+the+auto-topup+posture%2C+and+the+configured+low-balance+thresholds.+This+is+the+remainin\u0026amp;theme=996e54fd174205253948e175\u0026amp;signature=ac654f959d11ccebe3c493e117a913049dfc7a58a7b548a2f54c5ee2ad52c0eb\">\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 the current account credit balance - Topograph\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the account\u0026#x27;s remaining credit balance, a derived health status, the auto-topup posture, and the configured low-balance thresholds. This is the remaining balance — for consumption use GET /v2/workspaces/usage.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://semaphore.mintlify.app/_mintlify/api/og/v2?division=Billing\u0026amp;title=Get+the+current+account+credit+balance\u0026amp;description=Returns+the+account%27s+remaining+credit+balance%2C+a+derived+health+status%2C+the+auto-topup+posture%2C+and+the+configured+low-balance+thresholds.+This+is+the+remainin\u0026amp;theme=996e54fd174205253948e175\u0026amp;signature=ac654f959d11ccebe3c493e117a913049dfc7a58a7b548a2f54c5ee2ad52c0eb\">\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/semaphore/dO1LV7k9tlVmoSjK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Topograph\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.topograph.co/api-reference/billing/get-the-current-account-credit-balance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/billing/get-the-current-account-credit-balance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.topograph.co/#organization\",\"name\":\"Topograph\",\"url\":\"https://docs.topograph.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/semaphore/ChRp9mNNuCx3xt6W/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=ChRp9mNNuCx3xt6W\u0026q=85\u0026s=e6ce7b79992dddb6e7039eeceb3a0789\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.topograph.co#website\",\"name\":\"Topograph\",\"url\":\"https://docs.topograph.co\",\"publisher\":{\"@id\":\"https://docs.topograph.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.topograph.co/api-reference/billing/get-the-current-account-credit-balance#webpage\",\"url\":\"https://docs.topograph.co/api-reference/billing/get-the-current-account-credit-balance\",\"name\":\"Get the current account credit balance\",\"description\":\"Returns the account's remaining credit balance, a derived health status, the auto-topup posture, and the configured low-balance thresholds. This is the remaining balance — for consumption use GET /v2/workspaces/usage.\",\"dateModified\":\"2026-06-19T08:38:24.144Z\",\"isPartOf\":{\"@id\":\"https://docs.topograph.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.topograph.co/api-reference/billing/get-the-current-account-credit-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.topograph.co/api-reference/billing/get-the-current-account-credit-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Topograph\",\"item\":\"https://docs.topograph.co\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get the current account credit balance\",\"item\":\"https://docs.topograph.co/api-reference/billing/get-the-current-account-credit-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.topograph.co/api-reference/billing/get-the-current-account-credit-balance#apireference\",\"headline\":\"Get the current account credit balance\",\"name\":\"Get the current account credit balance\",\"description\":\"Returns the account's remaining credit balance, a derived health status, the auto-topup posture, and the configured low-balance thresholds. This is the remaining balance — for consumption use GET /v2/workspaces/usage.\",\"url\":\"https://docs.topograph.co/api-reference/billing/get-the-current-account-credit-balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.topograph.co/api-reference/billing/get-the-current-account-credit-balance#webpage\"},\"dateModified\":\"2026-06-19T08:38:24.144Z\",\"publisher\":{\"@id\":\"https://docs.topograph.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.topograph.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Topograph\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Topograph","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Country Guides","pages":[{"title":"Country Guides","href":"/essentials/austria"}]},{"tab":"API Reference","groups":[{"group":"Search","pages":[{"openapi":"get /v2/search","title":"Search for companies","href":"/api-reference/search/search-for-companies"},{"openapi":"post /v2/search/global","title":"Find a company across countries from its name","href":"/api-reference/search/global-search"}]},{"group":"Data","pages":[{"openapi":"post /v2/company","title":"Get Company Data and Documents","href":"/api-reference/data/get-company-data-and-documents"},{"openapi":"get /v2/company/{requestId}","title":"Get Company Request Result","href":"/api-reference/data/get-company-request-result"},{"openapi":"get /v2/company/{requestId}/pdf","title":"Download Company Extract as PDF","href":"/api-reference/data/download-company-extract-pdf"},{"openapi":"post /v2/onboarding","deprecated":true,"title":"Get Onboarding Data (Deprecated)","href":"/api-reference/data/get-onboarding-data-deprecated"}]},{"group":"Pricing","pages":[{"openapi":"get /v2/pricing","title":"Get pricing for a country","href":"/api-reference/pricing/get-pricing-for-a-country"}]},{"group":"Workspaces","pages":[{"openapi":"get /v2/workspaces","title":"List all workspaces","href":"/api-reference/workspaces/list-all-workspaces"},{"openapi":"post /v2/workspaces","title":"Create a new workspace","href":"/api-reference/workspaces/create-a-new-workspace"},{"openapi":"patch /v2/workspaces/{name}","title":"Update a workspace","href":"/api-reference/workspaces/update-a-workspace"},{"openapi":"delete /v2/workspaces/{name}","title":"Delete a workspace","href":"/api-reference/workspaces/delete-a-workspace"},{"openapi":"get /v2/workspaces/usage","title":"Get usage report per workspace","href":"/api-reference/workspaces/get-usage-report-per-workspace"}]},{"group":"Monitors","pages":[{"openapi":"get /v2/monitors","title":"List monitored companies","href":"/api-reference/monitors/list-monitored-companies"},{"openapi":"post /v2/monitors","title":"Add monitoring for a company","href":"/api-reference/monitors/add-monitoring-for-a-company"},{"openapi":"get /v2/monitors/{id}","title":"Get monitor details","href":"/api-reference/monitors/get-monitor-details"},{"openapi":"get /v2/monitors/{id}/logs","title":"Get monitor change logs","href":"/api-reference/monitors/get-monitor-change-logs"},{"title":"Send a test notification for a monitor","href":"/api-reference/monitors/send-a-test-notification-for-a-monitor"},{"openapi":"delete /v2/monitors/{id}","title":"Stop monitoring a company","href":"/api-reference/monitors/stop-monitoring-a-company"}]},{"group":"Search monitors (Beta)","pages":[{"openapi":"post /v2/search-monitors","tag":"BETA","title":"Watch for newly matching French companies","href":"/api-reference/search-monitors/watch-for-newly-matching-french-companies"},{"openapi":"get /v2/search-monitors","tag":"BETA","title":"List search monitors","href":"/api-reference/search-monitors/list-search-monitors"},{"openapi":"get /v2/search-monitors/{id}","tag":"BETA","title":"Get a search monitor","href":"/api-reference/search-monitors/get-a-search-monitor"},{"openapi":"delete /v2/search-monitors/{id}","tag":"BETA","title":"Stop a search monitor","href":"/api-reference/search-monitors/stop-a-search-monitor"}]},{"group":"Discrepancy reports (Beta)","pages":[{"openapi":"post /v2/discrepancy-reports","tag":"BETA","title":"File a discrepancy report (Beta)","href":"/api-reference/discrepancy-reports/file-a-discrepancy-report"},{"openapi":"get /v2/discrepancy-reports/{id}","tag":"BETA","title":"Get a discrepancy report (Beta)","href":"/api-reference/discrepancy-reports/get-a-discrepancy-report"},{"openapi":"get /v2/discrepancy-reports","tag":"BETA","title":"List discrepancy reports (Beta)","href":"/api-reference/discrepancy-reports/list-discrepancy-reports"},{"openapi":"get /v2/discrepancy-reports/usage","tag":"BETA","title":"Get discrepancy report usage (Beta)","href":"/api-reference/discrepancy-reports/get-discrepancy-report-usage"}]},{"group":"Vault","pages":[{"openapi":"get /v2/vault/sources","title":"List supported credential sources","href":"/api-reference/vault/list-supported-credential-sources"},{"openapi":"get /v2/workspaces/{name}/vault","title":"List vault entries on the workspace (metadata only)","href":"/api-reference/vault/list-vault-entries-on-the-workspace-metadata-only"},{"openapi":"get /v2/workspaces/{name}/vault/{sourceKey}","title":"Get one vault entry by sourceKey (metadata only)","href":"/api-reference/vault/get-one-vault-entry-by-sourcekey-metadata-only"},{"openapi":"put /v2/workspaces/{name}/vault/{sourceKey}","title":"Create or replace a credential","href":"/api-reference/vault/create-or-replace-a-credential"},{"openapi":"delete /v2/workspaces/{name}/vault/{sourceKey}","title":"Delete a credential","description":null,"href":"/api-reference/vault/delete-a-credential"}]},{"group":"Billing","pages":[{"openapi":"get /v2/billing/balance","title":"Get the current account credit balance","href":"/api-reference/billing/get-the-current-account-credit-balance"}]},{"group":"Billing Notifications","pages":[{"openapi":"get /v2/billing/notifications/config","title":"Get resolved billing notification config (defaults merged)","description":null,"href":"/api-reference/billing-notifications/get-resolved-billing-notification-config-defaults-merged"},{"openapi":"get /v2/billing/notifications/workspaces/{workspaceId}/config","title":"Get resolved workspace billing notification view (override + account)","href":"/api-reference/billing-notifications/get-resolved-workspace-billing-notification-view-override-+-account"},{"openapi":"get /v2/billing/notifications/recent","title":"List recent billing notification events","href":"/api-reference/billing-notifications/list-recent-billing-notification-events"},{"openapi":"delete /v2/billing/notifications/workspaces/{workspaceId}/config","title":"Remove workspace high-usage override","href":"/api-reference/billing-notifications/remove-workspace-high-usage-override"},{"openapi":"patch /v2/billing/notifications/config","title":"Upsert billing notification config","href":"/api-reference/billing-notifications/upsert-billing-notification-config"},{"openapi":"patch /v2/billing/notifications/workspaces/{workspaceId}/config","title":"Upsert workspace high-usage override","href":"/api-reference/billing-notifications/upsert-workspace-high-usage-override"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get the current account credit balance - Topograph","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}