credits_limit minus credits_used. Can be negative, see below.
billing_period_end
integer or null
When the period ends and usage resets, in Unix seconds.
tier
string
Your current plan.
credits_remaining can be negative. A run that overshoots the remaining balance is not rolled back mid-execution, so a team can finish a period slightly below zero.
When the period ends and usage resets, in Unix seconds.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Markifact","colors":{"primary":"#1374FF","light":"#1374FF","dark":"#1374FF"},"logo":{"light":"https://mintcdn.com/markifact/s418riJ1kIvXeqdE/logo/light.png?fit=max\u0026auto=format\u0026n=s418riJ1kIvXeqdE\u0026q=85\u0026s=97a0d799b6dd0f43778a389425cf0213","dark":"https://mintcdn.com/markifact/s418riJ1kIvXeqdE/logo/dark.png?fit=max\u0026auto=format\u0026n=s418riJ1kIvXeqdE\u0026q=85\u0026s=bebd2a4899640adec9102bc2f6dd85ec"},"favicon":"https://mintcdn.com/markifact/Ljk8anYBzOzZ898C/favicon.ico?fit=max\u0026auto=format\u0026n=Ljk8anYBzOzZ898C\u0026q=85\u0026s=2402591c302780d9642e9e5dcf964340","appearance":{"default":"light"},"navbar":{"links":[{"href":"https://www.markifact.com/auth/signin","label":"Log In"}],"primary":{"type":"button","label":"App","href":"https://markifact.com/"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/markifact","twitter":"https://twitter.com/markifactcom","youtube":"https://www.youtube.com/@markifactcom"}},"seo":{"metatags":{"og:site_name":"Markifact","og:image":"/images/og-image.webp","canonical":"https://docs.markifact.com"}},"styling":{"codeblocks":"dark","latex":true},"integrations":{"gtm":{"tagId":"GTM-MDGV4NFS"}},"contextual":{"options":["copy","view"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Contact Support","icon":"heart","href":"https://www.markifact.com/app/contact-us"},{"anchor":"Changelog","icon":"clock","href":"https://www.markifact.com/changelog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"markifact","hasAudioNarration":false,"actualSubdomain":"markifact","customDomains":["docs.markifact.com"],"gitSource":{"type":"github","owner":"ahmed-3li","repo":"markifact-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb3ef0935ad58d711843d7","collectionId":"4f681f16-42ff-41cd-969c-94cc60abfbbe","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb3ef0935ad58d711843d7"},"entitlements":{},"buildId":"6adb3ef0935ad58d711843d7","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Documentation","count":1224},{"language":"default","tag":"Operations","count":1201},{"language":"default","tag":"Google Tag Manager","count":98},{"language":"default","tag":"Microsoft Ads","count":94},{"language":"default","tag":"Meta Ads","count":93},{"language":"default","tag":"Google Ads","count":69},{"language":"default","tag":"X Ads","count":63},{"language":"default","tag":"Snapchat Ads","count":54},{"language":"default","tag":"DV360","count":53},{"language":"default","tag":"LinkedIn Ads","count":51}]},"assistantConfig":{},"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":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/credits/get-balance","slug":"/api-reference/credits/get-balance","pageMetadata":{"title":"Get credit balance","description":"Check how many Markifact credits your team has left in the current billing period.","openapi":"GET /v1/credits","href":"/api-reference/credits/get-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: \"Check how many Markifact credits your team has left in the current billing period.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,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 your team’s credit position for the current billing period. This is the endpoint to poll if you want to alert before your team runs out.`}),`\n`,_jsx(Heading,{level:`2`,id:`endpoint`,children:`Endpoint`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#C586C0`,\"--shiki-dark\":`#C586C0`},children:`GET`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` /v1/credits`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`example-request`,children:`Example Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--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:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.markifact.com/v1/credits\"`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_API_KEY\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"credits_limit\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#B5CEA8`,\"--shiki-dark\":`#B5CEA8`},children:`10000`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"credits_used\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#B5CEA8`,\"--shiki-dark\":`#B5CEA8`},children:`3613`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"credits_remaining\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#B5CEA8`,\"--shiki-dark\":`#B5CEA8`},children:`6387`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"billing_period_end\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#B5CEA8`,\"--shiki-dark\":`#B5CEA8`},children:`1780853312`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"tier\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"team\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`fields`,children:`Fields`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`credits_limit`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`Credits included in your plan for the period.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`credits_used`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`Credits consumed so far this period.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`credits_remaining`})}),_jsx(_components.td,{children:`integer`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`credits_limit`}),` minus `,_jsx(_components.code,{children:`credits_used`}),`. Can be negative, see below.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`billing_period_end`})}),_jsx(_components.td,{children:`integer or null`}),_jsx(_components.td,{children:`When the period ends and usage resets, in Unix seconds.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`tier`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Your current plan.`})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`credits_remaining`}),` can be negative. A run that overshoots the remaining balance is not rolled back mid-execution, so a team can finish a period slightly below zero.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`alerting-example`,children:`Alerting Example`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:`REMAINING`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`=$(`}),_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -s`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.markifact.com/v1/credits\"`}),_jsx(_components.span,{style:{color:`#D7BA7D`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` | `}),_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`jq`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` '.credits_remaining'`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#C586C0`,\"--shiki-dark\":`#C586C0`},children:`if`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` [ `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:`$REMAINING`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` -lt `}),_jsx(_components.span,{style:{color:`#B5CEA8`,\"--shiki-dark\":`#B5CEA8`},children:`500`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` ]; `}),_jsx(_components.span,{style:{color:`#C586C0`,\"--shiki-dark\":`#C586C0`},children:`then`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:` echo`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` \"Markifact credits low: `}),_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:`$REMAINING`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:` remaining\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#C586C0`,\"--shiki-dark\":`#C586C0`},children:`fi`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`To see what consumed the credits, use `,_jsx(_components.a,{href:`/api-reference/credits/list-credit-logs`,children:`List credit logs`}),`.`]})]})}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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Get credit balance","description":"Check how many Markifact credits your team has left in the current billing period.","openapi":"GET /v1/credits","href":"/api-reference/credits/get-balance"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Endpoint","slug":"endpoint","depth":2,"children":[]},{"title":"Example Request","slug":"example-request","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Fields","slug":"fields","depth":2,"children":[]},{"title":"Alerting Example","slug":"alerting-example","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/markifact/3685bc415eb86d32/chatbase.js"],"openApiReferenceData":{"operation":{"operationId":"getCreditBalance","summary":"Get credit balance","description":"Check how many Markifact credits your team has left in the current billing period.","tags":["Credits"],"responses":{"200":"ea0da981-0cc1-471c-a7bf-0103521edbba","401":"813d71f3-0216-43f2-9cf3-15210d0e176f","404":"2befe747-9bb1-44c6-b328-dcfc2bbdb7ab"},"method":"get","type":"path","servers":["f57092d7-b197-440e-9fca-7df546756ae9"],"security":["c8564385-cff3-4bb0-9dde-2883723f4b64"],"path":"/v1/credits","baseUrlOptions":["https://api.markifact.com"],"title":"Get credit balance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"ea0da981-0cc1-471c-a7bf-0103521edbba":{"description":"Balance returned.","content":{"application/json":{"schema":{"type":"object","properties":{"credits_limit":{"type":"integer","description":"Credits included in the plan for the current period.","isRequired":true,"uniqueKey":"credits_limit","typeLabel":"integer"},"credits_used":{"type":"integer","description":"Credits consumed so far this period.","isRequired":true,"uniqueKey":"credits_used","typeLabel":"integer"},"credits_remaining":{"type":"integer","description":"credits_limit minus credits_used. Can be negative: a run that overshoots is not rolled back.","isRequired":true,"uniqueKey":"credits_remaining","typeLabel":"integer"},"tier":{"type":"string","description":"Current plan.","isRequired":true,"uniqueKey":"tier","typeLabel":"string"},"billing_period_end":{"oneOf":[{"type":"integer","format":"int64","description":"When the period ends and usage resets, in Unix seconds.","uniqueKey":"billing_period_end.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"When the period ends and usage resets, in Unix seconds.","uniqueKey":"billing_period_end.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_period_end","typeLabel":"integer\u003cint64> | null"}},"required":["credits_limit","credits_used","credits_remaining","tier"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"credits_limit":123,"credits_used":123,"credits_remaining":123,"tier":"\u003cstring>","billing_period_end":123}}},"exampleType":"generated"}},"exampleType":"generated"},"813d71f3-0216-43f2-9cf3-15210d0e176f":{"description":"Invalid API key.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"oneOf":[{}],"uniqueKey":"detail","typeLabel":"any"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"2befe747-9bb1-44c6-b328-dcfc2bbdb7ab":{"description":"Team not found.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"oneOf":[{}],"uniqueKey":"detail","typeLabel":"any"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c8564385-cff3-4bb0-9dde-2883723f4b64":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"f57092d7-b197-440e-9fca-7df546756ae9":{"url":"https://api.markifact.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"markifact","siteName":"Markifact","title":"Get credit balance - Markifact","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-27T08:21:45.619Z","originalFileLocation":"api-reference/credits/get-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=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Check how many Markifact credits your team has left in the current billing period.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Markifact\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/markifact/rRckqEm4YH35F_Gi/_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/markifact/rRckqEm4YH35F_Gi/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/markifact/rRckqEm4YH35F_Gi/_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/markifact/rRckqEm4YH35F_Gi/_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/markifact/rRckqEm4YH35F_Gi/_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/markifact/rRckqEm4YH35F_Gi/_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/markifact/rRckqEm4YH35F_Gi/_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/markifact/rRckqEm4YH35F_Gi/_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/markifact/rRckqEm4YH35F_Gi/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get credit balance - Markifact\">\u003cmeta data-mint-head property=\"og:description\" content=\"Check how many Markifact credits your team has left in the current billing period.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Markifact\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.markifact.com/api-reference/credits/get-balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://markifact.mintlify.app/images/og-image.webp\">\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 credit balance - Markifact\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Check how many Markifact credits your team has left in the current billing period.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://markifact.mintlify.app/images/og-image.webp\">\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/markifact/rRckqEm4YH35F_Gi/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Markifact\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1374FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.markifact.com/api-reference/credits/get-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/credits/get-balance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.markifact.com/#organization\",\"name\":\"Markifact\",\"url\":\"https://docs.markifact.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/markifact/s418riJ1kIvXeqdE/logo/light.png?fit=max\u0026auto=format\u0026n=s418riJ1kIvXeqdE\u0026q=85\u0026s=97a0d799b6dd0f43778a389425cf0213\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.markifact.com#website\",\"name\":\"Markifact\",\"url\":\"https://docs.markifact.com\",\"publisher\":{\"@id\":\"https://docs.markifact.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.markifact.com/api-reference/credits/get-balance#webpage\",\"url\":\"https://docs.markifact.com/api-reference/credits/get-balance\",\"name\":\"Get credit balance\",\"description\":\"Check how many Markifact credits your team has left in the current billing period.\",\"dateModified\":\"2026-07-27T08:21:45.619Z\",\"isPartOf\":{\"@id\":\"https://docs.markifact.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.markifact.com/api-reference/credits/get-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.markifact.com/api-reference/credits/get-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Markifact\",\"item\":\"https://docs.markifact.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get credit balance\",\"item\":\"https://docs.markifact.com/api-reference/credits/get-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.markifact.com/api-reference/credits/get-balance#apireference\",\"headline\":\"Get credit balance\",\"name\":\"Get credit balance\",\"description\":\"Check how many Markifact credits your team has left in the current billing period.\",\"url\":\"https://docs.markifact.com/api-reference/credits/get-balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.markifact.com/api-reference/credits/get-balance#webpage\"},\"image\":\"https://docs.markifact.com/images/og-image.webp\",\"dateModified\":\"2026-07-27T08:21:45.619Z\",\"publisher\":{\"@id\":\"https://docs.markifact.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.markifact.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Markifact\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Markifact","nav":{"global":{"anchors":[{"anchor":"Contact Support","icon":"heart","href":"https://www.markifact.com/app/contact-us"},{"anchor":"Changelog","icon":"clock","href":"https://www.markifact.com/changelog"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Get Started","icon":"rocket","pages":[{"title":"Getting started","href":"/api-reference/getting-started"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"}]},{"group":"Connections","icon":"plug","pages":[{"title":"List connections","openapi":"GET /v1/connections","href":"/api-reference/connections/list-connections"},{"title":"Get connection","openapi":"GET /v1/connections/{connection_id}","href":"/api-reference/connections/get-connection"},{"title":"List connection types","openapi":"GET /v1/connections/types","href":"/api-reference/connections/list-connection-types"},{"title":"Create connection","openapi":"POST /v1/connections","href":"/api-reference/connections/create-connection"},{"title":"Create auth link","openapi":"POST /v1/connections/auth-link","href":"/api-reference/connections/create-auth-link"},{"title":"Get auth link status","openapi":"GET /v1/connections/auth-links/{auth_link_id}/status","href":"/api-reference/connections/get-auth-link-status"},{"title":"Delete connection","description":"Delete an API-visible connection from your Markifact team workspace.","openapi":"DELETE /v1/connections/{connection_id}","href":"/api-reference/connections/delete-connection"}]},{"group":"Credits","icon":"coins","pages":[{"title":"Get credit balance","openapi":"GET /v1/credits","href":"/api-reference/credits/get-balance"},{"title":"List credit logs","description":"Read your Markifact team's credit ledger: every charge, what caused it, and who ran it.","openapi":"GET /v1/credits/logs","href":"/api-reference/credits/list-credit-logs"}]},{"group":"Logs","icon":"list-check","pages":[{"title":"List logs","openapi":"GET /v1/logs","href":"/api-reference/logs/list-logs"},{"title":"Get log","openapi":"GET /v1/logs/{log_id}","href":"/api-reference/logs/get-log"}]}]}]},"title":"Get credit balance - Markifact","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}