How many days the balance lasts at the rate of your active tracked media. The rate is each media at its cadence and geo price, plus the daily geo account fee. Null when no tracked media are active, or the balance is 0 or less.
Required range: -9007199254740991 <= x <= 9007199254740991
Auto top-up settings. Null when they were never set. Change them on the Billing page of the console.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ClipStake Developer Docs","description":"Developer docs for the ClipStake APIs. The Console API tracks Instagram and X media. The Agency API reads your campaign data. The Creator API submits your clips.","colors":{"primary":"#CE1111","light":"#E34A4A","dark":"#7C0A0A"},"logo":{"light":"https://mintcdn.com/clipstake-618eb5ee/Jsnu6q5jiHt_YP3R/clipstake-logo-light.svg?fit=max\u0026auto=format\u0026n=Jsnu6q5jiHt_YP3R\u0026q=85\u0026s=7681e523e43fb1457a67bd8fef8635d9","dark":"https://mintcdn.com/clipstake-618eb5ee/Jsnu6q5jiHt_YP3R/clipstake-logo-dark.svg?fit=max\u0026auto=format\u0026n=Jsnu6q5jiHt_YP3R\u0026q=85\u0026s=eb665430b972a58134b8c16b137c3230"},"favicon":"https://mintcdn.com/clipstake-618eb5ee/l5j-30uYBX6r2Dqv/favicon.svg?fit=max\u0026auto=format\u0026n=l5j-30uYBX6r2Dqv\u0026q=85\u0026s=f48b590257eaf8c7112fb416b1cbe4e4","appearance":{"default":"system"},"background":{"color":{"light":"#FFFBFA","dark":"#000000"}},"navbar":{"links":[{"href":"https://status.clipstake.com","label":"Status"}],"primary":{"type":"button","label":"Open Console","href":"https://console.clipstake.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"clipstake-618eb5ee","hasAudioNarration":false,"actualSubdomain":"clipstake-618eb5ee","customDomains":["docs.clipstake.com"],"gitSource":{"type":"github","owner":"clipstake","repo":"bedrock","deployBranch":"prod","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"}},"buildId":"6aeb6abedfc350f7e13f9bfb","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":72},{"language":"default","tag":"Console API","count":60},{"language":"default","tag":"Submissions","count":28},{"language":"default","tag":"Developer Guides","count":19},{"language":"default","tag":"Instagram","count":17},{"language":"default","tag":"Agency API","count":15},{"language":"default","tag":"X","count":14},{"language":"default","tag":"YouTube","count":14},{"language":"default","tag":"Brand API","count":13},{"language":"default","tag":"Accounts","count":13}]},"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":"custom-rbac-roles","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/credits/get-the-credit-balance","slug":"/api-reference/credits/get-the-credit-balance","pageMetadata":{"title":"Get the credit balance","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /credits","href":"/api-reference/credits/get-the-credit-balance","autogeneratedByOpenApi":true},"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":{"title":"Get the credit balance","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /credits","href":"/api-reference/credits/get-the-credit-balance","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/clipstake-618eb5ee/39a3d3e929151a04/navbar-cta.js","/_mintlify/custom/clipstake-618eb5ee/53f114a48bb87823/hero-shader.js"],"openApiReferenceData":{"operation":{"operationId":"credits-get","summary":"Get the credit balance","tags":["Credits"],"security":["6cfebfde-19d8-4d3b-bb0e-40470512d25e"],"parameters":[],"responses":{"200":"61982a5f-47fa-4acd-82c7-da6a8497bad9","401":"6f74a0e6-c9ec-4f90-a600-65c2ca02264b","500":"3093a47e-aea3-44be-88f0-fb058c6507ff"},"method":"get","type":"path","servers":["d48b409e-aaa5-49a5-a91b-652e3a108bc7"],"path":"/credits","baseUrlOptions":["https://api.clipstake.com/v1"],"title":"Get the credit balance","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"61982a5f-47fa-4acd-82c7-da6a8497bad9":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"balance":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits the workspace holds now. Can be a little below 0: a read that already happened is never refused.","isRequired":true,"uniqueKey":"balance","typeLabel":"integer"},"tracking_paused":{"type":"boolean","description":"True when the workspace has no credits left. No tracked media is read until credits are added.","isRequired":true,"uniqueKey":"tracking_paused","typeLabel":"boolean"},"paused_since":{"oneOf":[{"type":"string","description":"When tracking paused for lack of credits. Null while tracking runs, or when the workspace never held credits.","format":"date-time","isRequired":true,"uniqueKey":"paused_since.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When tracking paused for lack of credits. Null while tracking runs, or when the workspace never held credits.","isRequired":true,"uniqueKey":"paused_since.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"paused_since","typeLabel":"string\u003cdate-time> | null"},"expiring_soon":{"type":"array","items":{"type":"object","properties":{"credits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits left in this batch.","isRequired":true,"uniqueKey":"expiring_soon.items.[INDEX].credits","typeLabel":"integer"},"expires_at":{"type":"string","format":"date-time","description":"When the credits left in this batch expire.","isRequired":true,"uniqueKey":"expiring_soon.items.[INDEX].expires_at","typeLabel":"string\u003cdate-time>"}},"required":["credits","expires_at"],"additionalProperties":false,"uniqueKey":"expiring_soon.items.[INDEX]","typeLabel":"object"},"description":"Batches of credits that expire in the next 14 days, soonest first.","isRequired":true,"uniqueKey":"expiring_soon","typeLabel":"object[]"},"next_expiry":{"oneOf":[{"type":"object","description":"The batch of credits that expires first. Null when no credits are left.","required":["credits","expires_at"],"properties":{"credits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits left in this batch.","isRequired":true,"uniqueKey":"next_expiry.oneOf.0.credits","typeLabel":"integer"},"expires_at":{"type":"string","format":"date-time","description":"When the credits left in this batch expire.","isRequired":true,"uniqueKey":"next_expiry.oneOf.0.expires_at","typeLabel":"string\u003cdate-time>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"next_expiry.oneOf.0","typeLabel":"object"},{"type":"null","description":"The batch of credits that expires first. Null when no credits are left.","isRequired":true,"uniqueKey":"next_expiry.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_expiry","typeLabel":"object | null"},"spent_last_7_days":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits used in the last 7 days.","isRequired":true,"uniqueKey":"spent_last_7_days","typeLabel":"integer"},"spent_last_30_days":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits used in the last 30 days.","isRequired":true,"uniqueKey":"spent_last_30_days","typeLabel":"integer"},"days_covered":{"oneOf":[{"type":"integer","description":"How many days the balance lasts at the rate of your active tracked media. The rate is each media at its cadence and geo price, plus the daily geo account fee. Null when no tracked media are active, or the balance is 0 or less.","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"days_covered.oneOf.0","typeLabel":"integer"},{"type":"null","description":"How many days the balance lasts at the rate of your active tracked media. The rate is each media at its cadence and geo price, plus the daily geo account fee. Null when no tracked media are active, or the balance is 0 or less.","isRequired":true,"uniqueKey":"days_covered.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"days_covered","typeLabel":"integer | null"},"auto_top_up":{"oneOf":[{"type":"object","description":"Auto top-up settings. Null when they were never set. Change them on the Billing page of the console.","required":["enabled","trigger_credits","pack","monthly_limit_cents","has_card","disabled_reason"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"auto_top_up.oneOf.0.enabled","typeLabel":"boolean"},"trigger_credits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"A credit pack is bought when the balance falls below this number.","isRequired":true,"uniqueKey":"auto_top_up.oneOf.0.trigger_credits","typeLabel":"integer"},"pack":{"type":"string","description":"The credit pack that is bought: `starter`, `growth`, `pro`, `business` or `scale`. Accept values you do not know.","isRequired":true,"uniqueKey":"auto_top_up.oneOf.0.pack","typeLabel":"string"},"monthly_limit_cents":{"oneOf":[{"type":"integer","description":"The most auto top-up spends in a calendar month, in US cents. Null means no limit.","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"auto_top_up.oneOf.0.monthly_limit_cents.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The most auto top-up spends in a calendar month, in US cents. Null means no limit.","isRequired":true,"uniqueKey":"auto_top_up.oneOf.0.monthly_limit_cents.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"auto_top_up.oneOf.0.monthly_limit_cents","typeLabel":"integer | null"},"has_card":{"type":"boolean","description":"True when a card is saved for auto top-up.","isRequired":true,"uniqueKey":"auto_top_up.oneOf.0.has_card","typeLabel":"boolean"},"disabled_reason":{"oneOf":[{"description":"Why auto top-up turned itself off: `declined` or `dispute`. Null when it did not. Accept values you do not know.","type":"string","isRequired":true,"uniqueKey":"auto_top_up.oneOf.0.disabled_reason.oneOf.0","typeLabel":"string"},{"description":"Why auto top-up turned itself off: `declined` or `dispute`. Null when it did not. Accept values you do not know.","type":"null","isRequired":true,"uniqueKey":"auto_top_up.oneOf.0.disabled_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"auto_top_up.oneOf.0.disabled_reason","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"auto_top_up.oneOf.0","typeLabel":"object"},{"type":"null","description":"Auto top-up settings. Null when they were never set. Change them on the Billing page of the console.","isRequired":true,"uniqueKey":"auto_top_up.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"auto_top_up","typeLabel":"object | null"}},"required":["balance","tracking_paused","paused_since","expiring_soon","next_expiry","spent_last_7_days","spent_last_30_days","days_covered","auto_top_up"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"balance":412350,"tracking_paused":false,"paused_since":null,"expiring_soon":[{"credits":20000,"expires_at":"2026-11-02T09:15:00.000Z"}],"next_expiry":{"credits":20000,"expires_at":"2026-11-02T09:15:00.000Z"},"spent_last_7_days":61810,"spent_last_30_days":248440,"days_covered":46,"auto_top_up":{"enabled":true,"trigger_credits":100000,"pack":"growth","monthly_limit_cents":50000,"has_card":true,"disabled_reason":null}},"examples":{"Example":{"title":"Example","value":{"balance":412350,"tracking_paused":false,"paused_since":null,"expiring_soon":[{"credits":20000,"expires_at":"2026-11-02T09:15:00.000Z"}],"next_expiry":{"credits":20000,"expires_at":"2026-11-02T09:15:00.000Z"},"spent_last_7_days":61810,"spent_last_30_days":248440,"days_covered":46,"auto_top_up":{"enabled":true,"trigger_credits":100000,"pack":"growth","monthly_limit_cents":50000,"has_card":true,"disabled_reason":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"6f74a0e6-c9ec-4f90-a600-65c2ca02264b":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Unauthorized","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"UNAUTHORIZED","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"description":"An array of issues that were responsible for the error","example":[],"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"additionalProperties":false,"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"additionalProperties":false,"title":"Unauthorized error (401)","description":"The error information","example":{"code":"UNAUTHORIZED","message":"Unauthorized","issues":[]},"uniqueKey":"","typeLabel":"Unauthorized error (401) · object"},"example":{"error":{"code":"unauthorized","message":"Provide a valid API key.","request_id":"req_01K5A7P2CH8T6R4W9M1B"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Provide a valid API key.","request_id":"req_01K5A7P2CH8T6R4W9M1B"}}}},"exampleType":"examples"}},"exampleType":"examples"},"3093a47e-aea3-44be-88f0-fb058c6507ff":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The error message","example":"Internal server error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"The error code","example":"INTERNAL_SERVER_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"issues":{"description":"An array of issues that were responsible for the error","example":[],"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["message"],"additionalProperties":false,"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["message","code"],"additionalProperties":false,"title":"Internal server error error (500)","description":"The error information","example":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error","issues":[]},"uniqueKey":"","typeLabel":"Internal server error error (500) · object"},"example":{"error":{"code":"internal_error","message":"An unexpected error occurred.","request_id":"req_01K5A7S6FQ3V8H2N9C4M"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"internal_error","message":"An unexpected error occurred.","request_id":"req_01K5A7S6FQ3V8H2N9C4M"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"6cfebfde-19d8-4d3b-bb0e-40470512d25e":{"Authorization":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"Authorization"}}},"servers":{"d48b409e-aaa5-49a5-a91b-652e3a108bc7":{"url":"https://api.clipstake.com/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"Authorization"},"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":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"openapi.json"},"subdomain":"clipstake-618eb5ee","siteName":"ClipStake Developer Docs","title":"Get the credit balance - ClipStake Developer Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T17:26:31.391Z","originalFileLocation":"api-reference/credits/get-the-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=\"application-name\" content=\"ClipStake Developer 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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get the credit balance - ClipStake Developer Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ClipStake Developer Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.clipstake.com/api-reference/credits/get-the-credit-balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://clipstake-618eb5ee.mintlify.site/_mintlify/api/og/v2?division=Credits\u0026amp;title=Get+the+credit+balance\u0026amp;theme=752973628dc7a5916322a68b\u0026amp;signature=e8dbf79664ac552c753eeaf1d516d6c5b5924a7286e4ccfeeda1ea83f69070a6\">\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 credit balance - ClipStake Developer Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://clipstake-618eb5ee.mintlify.site/_mintlify/api/og/v2?division=Credits\u0026amp;title=Get+the+credit+balance\u0026amp;theme=752973628dc7a5916322a68b\u0026amp;signature=e8dbf79664ac552c753eeaf1d516d6c5b5924a7286e4ccfeeda1ea83f69070a6\">\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/clipstake-618eb5ee/86fyYlt-B-ruXaHw/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ClipStake Developer Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#CE1111\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.clipstake.com/api-reference/credits/get-the-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/credits/get-the-credit-balance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.clipstake.com/#organization\",\"name\":\"ClipStake Developer Docs\",\"url\":\"https://docs.clipstake.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/clipstake-618eb5ee/Jsnu6q5jiHt_YP3R/clipstake-logo-light.svg?fit=max\u0026auto=format\u0026n=Jsnu6q5jiHt_YP3R\u0026q=85\u0026s=7681e523e43fb1457a67bd8fef8635d9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.clipstake.com#website\",\"name\":\"ClipStake Developer Docs\",\"url\":\"https://docs.clipstake.com\",\"publisher\":{\"@id\":\"https://docs.clipstake.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.clipstake.com/api-reference/credits/get-the-credit-balance#webpage\",\"url\":\"https://docs.clipstake.com/api-reference/credits/get-the-credit-balance\",\"name\":\"Get the credit balance\",\"dateModified\":\"2026-11-04T17:26:31.391Z\",\"isPartOf\":{\"@id\":\"https://docs.clipstake.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.clipstake.com/api-reference/credits/get-the-credit-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.clipstake.com/api-reference/credits/get-the-credit-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.clipstake.com/api-reference/projects/list-projects-in-this-workspace\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get the credit balance\",\"item\":\"https://docs.clipstake.com/api-reference/credits/get-the-credit-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.clipstake.com/api-reference/credits/get-the-credit-balance#apireference\",\"headline\":\"Get the credit balance\",\"name\":\"Get the credit balance\",\"url\":\"https://docs.clipstake.com/api-reference/credits/get-the-credit-balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.clipstake.com/api-reference/credits/get-the-credit-balance#webpage\"},\"dateModified\":\"2026-11-04T17:26:31.391Z\",\"publisher\":{\"@id\":\"https://docs.clipstake.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.clipstake.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ClipStake Developer Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ClipStake Developer Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/credits/get-the-credit-balance.md","siteName":"ClipStake Developer Docs","nav":{"global":null,"products":[{"product":"Console API","icon":"terminal","description":"For developers who track media in the console.","groups":[{"group":"Getting Started","pages":[{"title":"Console API","href":"/introduction"},{"title":"Quickstart","href":"/api-reference/quickstart"}]},{"group":"API Reference","pages":[{"group":"Projects","pages":[{"title":"List projects in this workspace","deprecated":null,"version":null,"openapi":"/openapi.json get /projects","href":"/api-reference/projects/list-projects-in-this-workspace"},{"title":"Update project metadata","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json patch /projects/{project_id}","href":"/api-reference/projects/update-project-metadata"}]},{"group":"Credits","pages":[{"title":"Get the credit balance","deprecated":null,"version":null,"openapi":"/openapi.json get /credits","href":"/api-reference/credits/get-the-credit-balance"},{"title":"List credit usage per day","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /credits/usage","href":"/api-reference/credits/list-credit-usage-per-day"}]},{"group":"Instagram","pages":[{"group":"Connect links","pages":[{"title":"Generate a login link","deprecated":null,"version":null,"sidebarTitle":"Generate a login link","openapi":"/openapi.json post /instagram/connect-links","href":"/api-reference/instagram/connect/generate-a-login-link"},{"title":"Read the outcome of a connect link","deprecated":null,"version":null,"sidebarTitle":"Read the outcome of a connect link","openapi":"/openapi.json get /instagram/connect-links/{connect_link_id}","href":"/api-reference/instagram/connect/read-the-outcome-of-a-connect-link"}]},{"group":"Accounts","pages":[{"title":"List connected social accounts","deprecated":null,"version":null,"sidebarTitle":"List connected social accounts","openapi":"/openapi.json get /instagram/accounts","href":"/api-reference/instagram/accounts/list-connected-social-accounts"},{"title":"Get an account","deprecated":null,"version":null,"sidebarTitle":"Get an account","openapi":"/openapi.json get /instagram/accounts/{account_id}","href":"/api-reference/instagram/accounts/get-an-account"},{"title":"Update account metadata","deprecated":null,"version":null,"sidebarTitle":"Update account metadata","openapi":"/openapi.json patch /instagram/accounts/{account_id}","href":"/api-reference/instagram/accounts/update-account-metadata"},{"title":"Audience geography, age and gender","deprecated":null,"version":null,"sidebarTitle":"Audience geography age and gender","openapi":"/openapi.json get /instagram/accounts/{account_id}/audience","href":"/api-reference/instagram/accounts/audience-geography-age-and-gender"},{"title":"Daily account insights","deprecated":null,"version":null,"sidebarTitle":"Daily account insights","openapi":"/openapi.json get /instagram/accounts/{account_id}/insights","href":"/api-reference/instagram/accounts/daily-account-insights"}]},{"group":"Submissions","pages":[{"title":"Put posts under tracking","deprecated":null,"version":null,"sidebarTitle":"Put posts under tracking","openapi":"/openapi.json post /instagram/submissions","href":"/api-reference/instagram/submissions/put-posts-under-tracking"},{"title":"List submissions in a project","deprecated":null,"version":null,"sidebarTitle":"List submissions in a project","openapi":"/openapi.json get /instagram/submissions","href":"/api-reference/instagram/submissions/list-submissions-in-a-project"},{"title":"Get a submission","deprecated":null,"version":null,"sidebarTitle":"Get a submission","openapi":"/openapi.json get /instagram/submissions/{submission_id}","href":"/api-reference/instagram/submissions/get-a-submission"},{"title":"Update a submission","deprecated":null,"version":null,"sidebarTitle":"Update a submission","openapi":"/openapi.json patch /instagram/submissions/{submission_id}","href":"/api-reference/instagram/submissions/update-a-submission"},{"title":"Pause active submissions in a project","deprecated":null,"version":null,"sidebarTitle":"Pause active submissions in a project","openapi":"/openapi.json post /instagram/submissions/pause","href":"/api-reference/instagram/submissions/pause-active-submissions-in-a-project"},{"title":"Resume paused submissions in a project","deprecated":null,"version":null,"sidebarTitle":"Resume paused submissions in a project","openapi":"/openapi.json post /instagram/submissions/resume","href":"/api-reference/instagram/submissions/resume-paused-submissions-in-a-project"},{"title":"Pause a submission","deprecated":null,"version":null,"sidebarTitle":"Pause a submission","openapi":"/openapi.json post /instagram/submissions/{submission_id}/pause","href":"/api-reference/instagram/submissions/pause-a-submission"},{"title":"Resume a submission","deprecated":null,"version":null,"sidebarTitle":"Resume a submission","openapi":"/openapi.json post /instagram/submissions/{submission_id}/resume","href":"/api-reference/instagram/submissions/resume-a-submission"},{"title":"Submission metric history","deprecated":null,"version":null,"sidebarTitle":"Submission metric history","openapi":"/openapi.json get /instagram/submissions/{submission_id}/stats","href":"/api-reference/instagram/submissions/submission-metric-history"},{"title":"Submission bot score","deprecated":null,"version":null,"sidebarTitle":"Submission bot score","openapi":"/openapi.json get /instagram/submissions/{submission_id}/bot-score","href":"/api-reference/instagram/submissions/submission-bot-score"}]}]},{"group":"X","pages":[{"group":"Connect links","pages":[{"title":"Generate a login link","deprecated":null,"version":null,"sidebarTitle":"Generate a login link","openapi":"/openapi.json post /x/connect-links","href":"/api-reference/x/connect/generate-a-login-link"},{"title":"Read the outcome of a connect link","deprecated":null,"version":null,"sidebarTitle":"Read the outcome of a connect link","openapi":"/openapi.json get /x/connect-links/{connect_link_id}","href":"/api-reference/x/connect/read-the-outcome-of-a-connect-link"}]},{"group":"Accounts","pages":[{"title":"List connected social accounts","deprecated":null,"version":null,"sidebarTitle":"List connected social accounts","openapi":"/openapi.json get /x/accounts","href":"/api-reference/x/accounts/list-connected-social-accounts"},{"title":"Get an account","deprecated":null,"version":null,"sidebarTitle":"Get an account","openapi":"/openapi.json get /x/accounts/{account_id}","href":"/api-reference/x/accounts/get-an-account"},{"title":"Update account metadata","deprecated":null,"version":null,"sidebarTitle":"Update account metadata","openapi":"/openapi.json patch /x/accounts/{account_id}","href":"/api-reference/x/accounts/update-account-metadata"}]},{"group":"Submissions","pages":[{"title":"Put posts under tracking","deprecated":null,"version":null,"sidebarTitle":"Put posts under tracking","openapi":"/openapi.json post /x/submissions","href":"/api-reference/x/submissions/put-posts-under-tracking"},{"title":"List submissions in a project","deprecated":null,"version":null,"sidebarTitle":"List submissions in a project","openapi":"/openapi.json get /x/submissions","href":"/api-reference/x/submissions/list-submissions-in-a-project"},{"title":"Get a submission","deprecated":null,"version":null,"sidebarTitle":"Get a submission","openapi":"/openapi.json get /x/submissions/{submission_id}","href":"/api-reference/x/submissions/get-a-submission"},{"title":"Update a submission","deprecated":null,"version":null,"sidebarTitle":"Update a submission","openapi":"/openapi.json patch /x/submissions/{submission_id}","href":"/api-reference/x/submissions/update-a-submission"},{"title":"Pause active submissions in a project","deprecated":null,"version":null,"sidebarTitle":"Pause active submissions in a project","openapi":"/openapi.json post /x/submissions/pause","href":"/api-reference/x/submissions/pause-active-submissions-in-a-project"},{"title":"Resume paused submissions in a project","deprecated":null,"version":null,"sidebarTitle":"Resume paused submissions in a project","openapi":"/openapi.json post /x/submissions/resume","href":"/api-reference/x/submissions/resume-paused-submissions-in-a-project"},{"title":"Pause a submission","deprecated":null,"version":null,"sidebarTitle":"Pause a submission","openapi":"/openapi.json post /x/submissions/{submission_id}/pause","href":"/api-reference/x/submissions/pause-a-submission"},{"title":"Resume a submission","deprecated":null,"version":null,"sidebarTitle":"Resume a submission","openapi":"/openapi.json post /x/submissions/{submission_id}/resume","href":"/api-reference/x/submissions/resume-a-submission"},{"title":"Submission metric history","deprecated":null,"version":null,"sidebarTitle":"Submission metric history","openapi":"/openapi.json get /x/submissions/{submission_id}/stats","href":"/api-reference/x/submissions/submission-metric-history"}]}]},{"group":"YouTube","pages":[{"group":"Connect links","pages":[{"title":"Generate a login link","deprecated":null,"version":null,"sidebarTitle":"Generate a login link","openapi":"/openapi.json post /youtube/connect-links","href":"/api-reference/youtube/connect/generate-a-login-link"},{"title":"Read the outcome of a connect link","deprecated":null,"version":null,"sidebarTitle":"Read the outcome of a connect link","openapi":"/openapi.json get /youtube/connect-links/{connect_link_id}","href":"/api-reference/youtube/connect/read-the-outcome-of-a-connect-link"}]},{"group":"Accounts","pages":[{"title":"List connected social accounts","deprecated":null,"version":null,"sidebarTitle":"List connected social accounts","openapi":"/openapi.json get /youtube/accounts","href":"/api-reference/youtube/accounts/list-connected-social-accounts"},{"title":"Get an account","deprecated":null,"version":null,"sidebarTitle":"Get an account","openapi":"/openapi.json get /youtube/accounts/{account_id}","href":"/api-reference/youtube/accounts/get-an-account"},{"title":"Update account metadata","deprecated":null,"version":null,"sidebarTitle":"Update account metadata","openapi":"/openapi.json patch /youtube/accounts/{account_id}","href":"/api-reference/youtube/accounts/update-account-metadata"}]},{"group":"Submissions","pages":[{"title":"Put posts under tracking","deprecated":null,"version":null,"sidebarTitle":"Put posts under tracking","openapi":"/openapi.json post /youtube/submissions","href":"/api-reference/youtube/submissions/put-posts-under-tracking"},{"title":"List submissions in a project","deprecated":null,"version":null,"sidebarTitle":"List submissions in a project","openapi":"/openapi.json get /youtube/submissions","href":"/api-reference/youtube/submissions/list-submissions-in-a-project"},{"title":"Get a submission","deprecated":null,"version":null,"sidebarTitle":"Get a submission","openapi":"/openapi.json get /youtube/submissions/{submission_id}","href":"/api-reference/youtube/submissions/get-a-submission"},{"title":"Update a submission","deprecated":null,"version":null,"sidebarTitle":"Update a submission","openapi":"/openapi.json patch /youtube/submissions/{submission_id}","href":"/api-reference/youtube/submissions/update-a-submission"},{"title":"Pause active submissions in a project","deprecated":null,"version":null,"sidebarTitle":"Pause active submissions in a project","openapi":"/openapi.json post /youtube/submissions/pause","href":"/api-reference/youtube/submissions/pause-active-submissions-in-a-project"},{"title":"Resume paused submissions in a project","deprecated":null,"version":null,"sidebarTitle":"Resume paused submissions in a project","openapi":"/openapi.json post /youtube/submissions/resume","href":"/api-reference/youtube/submissions/resume-paused-submissions-in-a-project"},{"title":"Pause a submission","deprecated":null,"version":null,"sidebarTitle":"Pause a submission","openapi":"/openapi.json post /youtube/submissions/{submission_id}/pause","href":"/api-reference/youtube/submissions/pause-a-submission"},{"title":"Resume a submission","deprecated":null,"version":null,"sidebarTitle":"Resume a submission","openapi":"/openapi.json post /youtube/submissions/{submission_id}/resume","href":"/api-reference/youtube/submissions/resume-a-submission"},{"title":"Submission metric history","deprecated":null,"version":null,"sidebarTitle":"Submission metric history","openapi":"/openapi.json get /youtube/submissions/{submission_id}/stats","href":"/api-reference/youtube/submissions/submission-metric-history"}]}]}]},{"group":"Developer Guides","pages":[{"title":"Authentication","href":"/api-reference/authentication"},{"title":"API contract","href":"/api-reference/contract"},{"title":"Workspaces and projects","href":"/api-reference/workspaces-and-projects"},{"title":"Connecting accounts","href":"/api-reference/connecting-accounts"},{"title":"Tracking media","href":"/api-reference/tracking-media"},{"title":"Audience and insights","href":"/api-reference/audience-and-insights"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Credits and limits","href":"/api-reference/plans-and-limits"}]}]},{"product":"Agency API","icon":"chart-line","description":"For agencies that read their campaign data and create campaigns.","pages":[{"title":"Agency API","href":"/agency-api/introduction"}]},{"product":"Brand API","icon":"store","description":"For brands that read the data of their campaigns.","pages":[{"title":"Brand API","href":"/brand-api/introduction"}]},{"product":"Creator API","icon":"clapperboard","description":"For creators who submit clips from their own tools.","pages":[{"title":"Creator API","href":"/creator-api/introduction"}]}]},"basePath":"","title":"Get the credit balance - ClipStake Developer Docs","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}