OpenPAI’s query endpoint is compatible with OpenAI’s legacy structure.
For more fine-grained information (account balance, current token’s spend, used quota, etc.), use the dedicated endpoint:
Many clients (such as NextChat, ChatBox) automatically call /v1/dashboard/billing/subscription and /v1/dashboard/billing/usage to display the balance.
OpenPAI implements both endpoints so client UIs work correctly.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OpenPAI Docs","description":"","colors":{"primary":"#000000","light":"#EEEEEE","dark":"#222222"},"logo":{"light":"https://mintcdn.com/op-40ebb09d/R5XanwifcSXH-dTc/logo/light.svg?fit=max\u0026auto=format\u0026n=R5XanwifcSXH-dTc\u0026q=85\u0026s=9744cc1720a3a6dce9560f9369a2e6c1","dark":"https://mintcdn.com/op-40ebb09d/R5XanwifcSXH-dTc/logo/dark.svg?fit=max\u0026auto=format\u0026n=R5XanwifcSXH-dTc\u0026q=85\u0026s=c7bdfdb1850ab4d9741829fafc38683e"},"favicon":"https://mintcdn.com/op-40ebb09d/R5XanwifcSXH-dTc/favicon.svg?fit=max\u0026auto=format\u0026n=R5XanwifcSXH-dTc\u0026q=85\u0026s=619e2909d396046c2de25fabedd263c5","navbar":{"links":[],"primary":{"type":"button","label":"App","href":"https://openp.ai/dashboard"}},"footer":{"socials":{},"links":[{"header":"产品","items":[{"label":"控制台","href":"https://openp.ai/dashboard"},{"label":"定价","href":"https://openp.ai/pricing"}]},{"header":"文档","items":[{"label":"快速开始","href":"/quickstart"},{"label":"API 参考","href":"/api-reference/introduction"},{"label":"常见问题","href":"/support/faq"}]},{"header":"法律","items":[{"label":"隐私政策","href":"/legal/privacy"},{"label":"服务条款","href":"/legal/terms"}]}]},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"zh","default":true,"href":""},{"language":"en","footer":{"socials":{},"links":[{"header":"Product","items":[{"label":"Console","href":"https://openp.ai/dashboard"},{"label":"Pricing","href":"https://openp.ai/pricing"}]},{"header":"Docs","items":[{"label":"Quickstart","href":"/en/quickstart"},{"label":"API reference","href":"/en/api-reference/introduction"},{"label":"FAQ","href":"/en/support/faq"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"/en/legal/privacy"},{"label":"Terms of Service","href":"/en/legal/terms"}]}]},"href":"en"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"op-40ebb09d","hasAudioNarration":false,"actualSubdomain":"op-40ebb09d","customDomains":["docs.openp.ai"],"gitSource":{"type":"github","owner":"openp-ai","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae957c1bb9827c4f4fe4d62:success","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"zh","tag":"文档","count":39},{"language":"en","tag":"Documentation","count":39},{"language":"zh","tag":"API 参考","count":31},{"language":"en","tag":"API Reference","count":31},{"language":"zh","tag":"OpenAI 兼容","count":12},{"language":"zh","tag":"客户端集成","count":12},{"language":"en","tag":"OpenAI-compatible","count":12},{"language":"en","tag":"Client integrations","count":12},{"language":"zh","tag":"模型与计费","count":9},{"language":"en","tag":"Models \u0026 billing","count":9},{"language":"zh","tag":"视频与图像生成","count":7},{"language":"en","tag":"Video \u0026 image generation","count":7},{"language":"zh","tag":"进阶用法","count":6},{"language":"en","tag":"Advanced","count":6},{"language":"zh","tag":"概览","count":4},{"language":"zh","tag":"新手上路","count":4},{"language":"zh","tag":"开始","count":4},{"language":"en","tag":"Overview","count":4},{"language":"en","tag":"First steps","count":4},{"language":"en","tag":"Get started","count":4}]},"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":"editor-metadata","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":false},"customCss":[],"page":{"pagePath":"en/api-reference/account/balance","slug":"/en/api-reference/account/balance","pageMetadata":{"title":"Get balance","description":"GET /v1/dashboard/billing/subscription — the current account quota","api":"GET https://openp.ai/v1/dashboard/billing/subscription","href":"/en/api-reference/account/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: \"GET /v1/dashboard/billing/subscription — the current account quota\"\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={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Returns the current account’s (or token’s) balance and quota information.`}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://openp.ai/v1/dashboard/billing/subscription`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$OPENPAI_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"billing_subscription\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"has_payment_method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"soft_limit_usd\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`100.0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"hard_limit_usd\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1000.0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"system_hard_limit_usd\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1000.0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"access_until\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`4102444800`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"plan\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"title\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"vip\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"vip\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Field meanings:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`hard_limit_usd`})}),_jsx(_components.td,{children:`The account’s (or token’s) hard quota ceiling`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`soft_limit_usd`})}),_jsx(_components.td,{children:`The soft quota threshold (triggers an alert)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`system_hard_limit_usd`})}),_jsx(_components.td,{children:`The system-level hard ceiling`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`access_until`})}),_jsx(_components.td,{children:`The Unix time when account access ends (0 means permanent)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`plan`})}),_jsx(_components.td,{children:`The current group`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`differences-from-official-openai`,children:`Differences from official OpenAI`}),`\n`,_jsxs(_components.p,{children:[`OpenPAI’s query endpoint is compatible with OpenAI’s legacy structure.\nFor more fine-grained information (account balance, current token’s spend, used quota, etc.), use the `,_jsx(_components.strong,{children:`dedicated endpoint`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Query account-level balance (in ¥)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://openp.ai/api/user/self`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$OPENPAI_USER_TOKEN`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsx(Note,{children:`A user token and an API key (sk-) are two separate credentials — the user token is for the management backend API, while sk- is for model calls.`}),`\n`,_jsx(Heading,{level:`2`,id:`client-integration`,children:`Client integration`}),`\n`,_jsxs(_components.p,{children:[`Many clients (such as NextChat, ChatBox) automatically call `,_jsx(_components.code,{children:`/v1/dashboard/billing/subscription`}),` and `,_jsx(_components.code,{children:`/v1/dashboard/billing/usage`}),` to display the balance.\nOpenPAI implements both endpoints so client UIs work correctly.`]})]})}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":{"title":"Get balance","description":"GET /v1/dashboard/billing/subscription — the current account quota","api":"GET https://openp.ai/v1/dashboard/billing/subscription","href":"/en/api-reference/account/balance"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Request","slug":"request","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Differences from official OpenAI","slug":"differences-from-official-openai","depth":2,"children":[]},{"title":"Client integration","slug":"client-integration","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Get balance","path":"/v1/dashboard/billing/subscription","servers":[{"url":"https://openp.ai"}],"method":"get","request":{"security":[],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{}},"response":{},"deprecated":false}},"jsLinks":[],"subdomain":"op-40ebb09d","siteName":"OpenPAI Docs","title":"Get balance - OpenPAI Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"zh":{"href":"/api-reference/account/balance","matchLevel":1},"en":{"href":"/en/api-reference/account/balance","matchLevel":0}}},"lastModified":"2026-06-07T06:39:10.575Z","originalFileLocation":"en/api-reference/account/balance.mdx","locale":"en"},"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=\"GET /v1/dashboard/billing/subscription — the current account quota\">\u003cmeta data-mint-head name=\"application-name\" content=\"OpenPAI 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/op-40ebb09d/ZaYSMVOk3--uEDph/_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/op-40ebb09d/ZaYSMVOk3--uEDph/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/op-40ebb09d/ZaYSMVOk3--uEDph/_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/op-40ebb09d/ZaYSMVOk3--uEDph/_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/op-40ebb09d/ZaYSMVOk3--uEDph/_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/op-40ebb09d/ZaYSMVOk3--uEDph/_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/op-40ebb09d/ZaYSMVOk3--uEDph/_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/op-40ebb09d/ZaYSMVOk3--uEDph/_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/op-40ebb09d/ZaYSMVOk3--uEDph/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get balance - OpenPAI Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"GET /v1/dashboard/billing/subscription — the current account quota\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OpenPAI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.openp.ai/en/api-reference/account/balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://op-40ebb09d.mintlify.site/_mintlify/api/og/v2?division=Account\u0026amp;title=Get+balance\u0026amp;description=GET+%2Fv1%2Fdashboard%2Fbilling%2Fsubscription+%E2%80%94+the+current+account+quota\u0026amp;theme=0fb60eb90290afca1859be9a\u0026amp;signature=0c0cac55cc69fe3d3c60f06e08bfb96dab5f1e039da08861867c7c17ad68d2c6\">\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 balance - OpenPAI Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"GET /v1/dashboard/billing/subscription — the current account quota\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://op-40ebb09d.mintlify.site/_mintlify/api/og/v2?division=Account\u0026amp;title=Get+balance\u0026amp;description=GET+%2Fv1%2Fdashboard%2Fbilling%2Fsubscription+%E2%80%94+the+current+account+quota\u0026amp;theme=0fb60eb90290afca1859be9a\u0026amp;signature=0c0cac55cc69fe3d3c60f06e08bfb96dab5f1e039da08861867c7c17ad68d2c6\">\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/op-40ebb09d/ZaYSMVOk3--uEDph/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OpenPAI Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.openp.ai/en/api-reference/account/balance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/account/balance.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.openp.ai/en/api-reference/account/balance\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.openp.ai/api-reference/account/balance\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.openp.ai/api-reference/account/balance\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.openp.ai/#organization\",\"name\":\"OpenPAI Docs\",\"url\":\"https://docs.openp.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/op-40ebb09d/R5XanwifcSXH-dTc/logo/light.svg?fit=max\u0026auto=format\u0026n=R5XanwifcSXH-dTc\u0026q=85\u0026s=9744cc1720a3a6dce9560f9369a2e6c1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.openp.ai#website\",\"name\":\"OpenPAI Docs\",\"url\":\"https://docs.openp.ai\",\"publisher\":{\"@id\":\"https://docs.openp.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.openp.ai/en/api-reference/account/balance#webpage\",\"url\":\"https://docs.openp.ai/en/api-reference/account/balance\",\"name\":\"Get balance\",\"description\":\"GET /v1/dashboard/billing/subscription — the current account quota\",\"dateModified\":\"2026-06-07T06:39:10.575Z\",\"isPartOf\":{\"@id\":\"https://docs.openp.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.openp.ai/en/api-reference/account/balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.openp.ai/en/api-reference/account/balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"OpenPAI Docs\",\"item\":\"https://docs.openp.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get balance\",\"item\":\"https://docs.openp.ai/en/api-reference/account/balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.openp.ai/en/api-reference/account/balance#apireference\",\"headline\":\"Get balance\",\"name\":\"Get balance\",\"description\":\"GET /v1/dashboard/billing/subscription — the current account quota\",\"url\":\"https://docs.openp.ai/en/api-reference/account/balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.openp.ai/en/api-reference/account/balance#webpage\"},\"dateModified\":\"2026-06-07T06:39:10.575Z\",\"publisher\":{\"@id\":\"https://docs.openp.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.openp.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OpenPAI Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OpenPAI Docs","nav":{"global":null,"languages":[{"language":"zh","default":true,"pages":[{"title":"zh","href":"/api-reference/account/balance"}]},{"language":"en","footer":{"socials":{},"links":[{"header":"Product","items":[{"label":"Console","href":"https://openp.ai/dashboard"},{"label":"Pricing","href":"https://openp.ai/pricing"}]},{"header":"Docs","items":[{"label":"Quickstart","href":"/en/quickstart"},{"label":"API reference","href":"/en/api-reference/introduction"},{"label":"FAQ","href":"/en/support/faq"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"/en/legal/privacy"},{"label":"Terms of Service","href":"/en/legal/terms"}]}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/en"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API overview","icon":"book-open","href":"/en/api-reference/introduction"},{"title":"Authentication","icon":"key","href":"/en/api-reference/authentication"},{"title":"Error codes","icon":"circle-exclamation","href":"/en/api-reference/errors"},{"title":"Rate limits","icon":"gauge-high","href":"/en/api-reference/rate-limits"}]},{"group":"OpenAI-compatible","pages":[{"title":"Chat Completions","api":"POST https://openp.ai/v1/chat/completions","href":"/en/api-reference/openai/chat-completions"},{"title":"Responses","api":"POST https://openp.ai/v1/responses","href":"/en/api-reference/openai/responses"},{"title":"Completions (legacy)","api":"POST https://openp.ai/v1/completions","href":"/en/api-reference/openai/completions"},{"title":"Embeddings","api":"POST https://openp.ai/v1/embeddings","href":"/en/api-reference/openai/embeddings"},{"title":"Image generation","api":"POST https://openp.ai/v1/images/generations","href":"/en/api-reference/openai/images-generations"},{"title":"Image editing","api":"POST https://openp.ai/v1/images/edits","href":"/en/api-reference/openai/images-edits"},{"title":"Text to speech (TTS)","api":"POST https://openp.ai/v1/audio/speech","href":"/en/api-reference/openai/audio-speech"},{"title":"Speech to text","api":"POST https://openp.ai/v1/audio/transcriptions","href":"/en/api-reference/openai/audio-transcriptions"},{"title":"Audio translation","api":"POST https://openp.ai/v1/audio/translations","href":"/en/api-reference/openai/audio-translations"},{"title":"Moderations","api":"POST https://openp.ai/v1/moderations","href":"/en/api-reference/openai/moderations"},{"title":"List models","api":"GET https://openp.ai/v1/models","href":"/en/api-reference/openai/models-list"},{"title":"Realtime conversation","icon":"satellite-dish","href":"/en/api-reference/openai/realtime"}]},{"group":"Claude Messages","pages":[{"title":"Messages","api":"POST https://openp.ai/v1/messages","href":"/en/api-reference/anthropic/messages"},{"title":"Count Tokens","api":"POST https://openp.ai/v1/messages/count_tokens","href":"/en/api-reference/anthropic/count-tokens"}]},{"group":"Google Gemini","pages":[{"title":"generateContent","api":"POST https://openp.ai/v1beta/models/{model}:generateContent","href":"/en/api-reference/gemini/generate-content"},{"title":"streamGenerateContent","api":"POST https://openp.ai/v1beta/models/{model}:streamGenerateContent","href":"/en/api-reference/gemini/stream-generate-content"},{"title":"embedContent","api":"POST https://openp.ai/v1beta/models/{model}:embedContent","href":"/en/api-reference/gemini/embed-content"}]},{"group":"Rerank","pages":[{"title":"Rerank","api":"POST https://openp.ai/v1/rerank","href":"/en/api-reference/rerank/create-rerank"}]},{"group":"Video \u0026 image generation","pages":[{"title":"Video generation (Sora)","api":"POST https://openp.ai/v1/videos","href":"/en/api-reference/video/sora"},{"title":"Video generation (Seedance)","api":"POST https://openp.ai/seedance/v1/videos/generations","href":"/en/api-reference/video/seedance"},{"title":"Imagine (text-to-image)","api":"POST https://openp.ai/mj/submit/imagine","href":"/en/api-reference/midjourney/imagine"},{"title":"Change (U/V/Reroll)","api":"POST https://openp.ai/mj/submit/change","href":"/en/api-reference/midjourney/change"},{"title":"Fetch (query task)","api":"GET https://openp.ai/mj/task/{id}/fetch","href":"/en/api-reference/midjourney/fetch"},{"title":"Suno generate","api":"POST https://openp.ai/suno/submit/music","href":"/en/api-reference/suno/generate"},{"title":"Suno fetch","description":"GET /suno/fetch/{id} — poll a Suno task's status","api":"GET https://openp.ai/suno/fetch/{id}","href":"/en/api-reference/suno/fetch"}]},{"group":"Account","pages":[{"title":"Get balance","api":"GET https://openp.ai/v1/dashboard/billing/subscription","href":"/en/api-reference/account/balance"},{"title":"Get usage","description":"GET /v1/dashboard/billing/usage — spend over a time range","api":"GET https://openp.ai/v1/dashboard/billing/usage","href":"/en/api-reference/account/usage"}]}]}]}]},"basePath":"","title":"Get balance - OpenPAI Docs","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js"]}