{
"code": "BCK.ROUTER.0003",
"httpStatus": 500,
"message": "delegation budget exceeded, expired, or inactive",
"details": "Hash JWT is not signed by the node account",
"error": "authorization_pending",
"hint": "Verify the wallet has sufficient balance and that the plan is active.",
"docsUrl": "https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008",
"category": "integration",
"retryable": true,
"correlationId": "a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9",
"uuid": "e-550e8400-e29b-41d4-a716-446655440000",
"date": "2026-05-09T12:34:56.789Z",
"params": "{\"planId\":\"43298432984329\",\"reason\":\"Invalid configuration\"}"
}
{
"code": "BCK.ROUTER.0003",
"httpStatus": 500,
"message": "delegation budget exceeded, expired, or inactive",
"details": "Hash JWT is not signed by the node account",
"error": "authorization_pending",
"hint": "Verify the wallet has sufficient balance and that the plan is active.",
"docsUrl": "https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008",
"category": "integration",
"retryable": true,
"correlationId": "a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9",
"uuid": "e-550e8400-e29b-41d4-a716-446655440000",
"date": "2026-05-09T12:34:56.789Z",
"params": "{\"planId\":\"43298432984329\",\"reason\":\"Invalid configuration\"}"
}
{
"code": "BCK.ROUTER.0003",
"httpStatus": 500,
"message": "delegation budget exceeded, expired, or inactive",
"details": "Hash JWT is not signed by the node account",
"error": "authorization_pending",
"hint": "Verify the wallet has sufficient balance and that the plan is active.",
"docsUrl": "https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008",
"category": "integration",
"retryable": true,
"correlationId": "a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9",
"uuid": "e-550e8400-e29b-41d4-a716-446655440000",
"date": "2026-05-09T12:34:56.789Z",
"params": "{\"planId\":\"43298432984329\",\"reason\":\"Invalid configuration\"}"
}
Router
Read Your Credits
Your Nevermined credits: every credit your personal account holds — free welcome credits, a Nevermined Subscription’s monthly allowance and top-up credits — as one balance, subscribed or not. They are spent earliest expiry first. Charges nothing; a caller with no credits gets total: "0" and an empty parts.
Always personal: an organization tag on the key and an X-Current-Org-Id header are ignored — but a call made in an organization never spends these credits (BCK.SUBSCRIPTION_ROUTER.0002), so spendable is what a personal key can pay with. API keys only: an OAuth-minted credential is refused (BCK.OAUTH.0030), even a commerce connection allowed to spend your credits. Frozen credits count in total but not in spendable.
{
"code": "BCK.ROUTER.0003",
"httpStatus": 500,
"message": "delegation budget exceeded, expired, or inactive",
"details": "Hash JWT is not signed by the node account",
"error": "authorization_pending",
"hint": "Verify the wallet has sufficient balance and that the plan is active.",
"docsUrl": "https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008",
"category": "integration",
"retryable": true,
"correlationId": "a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9",
"uuid": "e-550e8400-e29b-41d4-a716-446655440000",
"date": "2026-05-09T12:34:56.789Z",
"params": "{\"planId\":\"43298432984329\",\"reason\":\"Invalid configuration\"}"
}
{
"code": "BCK.ROUTER.0003",
"httpStatus": 500,
"message": "delegation budget exceeded, expired, or inactive",
"details": "Hash JWT is not signed by the node account",
"error": "authorization_pending",
"hint": "Verify the wallet has sufficient balance and that the plan is active.",
"docsUrl": "https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008",
"category": "integration",
"retryable": true,
"correlationId": "a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9",
"uuid": "e-550e8400-e29b-41d4-a716-446655440000",
"date": "2026-05-09T12:34:56.789Z",
"params": "{\"planId\":\"43298432984329\",\"reason\":\"Invalid configuration\"}"
}
{
"code": "BCK.ROUTER.0003",
"httpStatus": 500,
"message": "delegation budget exceeded, expired, or inactive",
"details": "Hash JWT is not signed by the node account",
"error": "authorization_pending",
"hint": "Verify the wallet has sufficient balance and that the plan is active.",
"docsUrl": "https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008",
"category": "integration",
"retryable": true,
"correlationId": "a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9",
"uuid": "e-550e8400-e29b-41d4-a716-446655440000",
"date": "2026-05-09T12:34:56.789Z",
"params": "{\"planId\":\"43298432984329\",\"reason\":\"Invalid configuration\"}"
}
The credits that can pay a call right now: the sum of the parts that are not frozen, as a whole-number digit string. What the Router spends — read it rather than adding up your calls.
Your credit top-up settings. Present when credit top-ups are available to you; absent when they are not, or when the settings could not be read this time. Top-ups are turned on and managed in the Nevermined App, not over the API.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Nevermined Documentation","colors":{"primary":"#0f766e","light":"#5eead4","dark":"#0d3f48"},"logo":{"light":"https://mintcdn.com/neverminedag/pEEAPbhrOtjiJvrW/logo/light.svg?fit=max\u0026auto=format\u0026n=pEEAPbhrOtjiJvrW\u0026q=85\u0026s=adbff4ad34c53aed8ca307e9b12104e5","dark":"https://mintcdn.com/neverminedag/pEEAPbhrOtjiJvrW/logo/dark.svg?fit=max\u0026auto=format\u0026n=pEEAPbhrOtjiJvrW\u0026q=85\u0026s=519fb2296e47f72117a24e0787b6bd87"},"favicon":"https://mintcdn.com/neverminedag/816P0WhT1WcQ-Koj/favicon.ico?fit=max\u0026auto=format\u0026n=816P0WhT1WcQ-Koj\u0026q=85\u0026s=2ff33e631489dd6cca6be632af8aa16a","api":{"openapi":"api-reference/openapi.json"},"appearance":{"default":"light"},"navbar":{"links":[{"href":"https://nevermined.app","label":"App"}],"primary":{"type":"button","label":"AI Catalog","href":"https://nevermined.app/catalog/"}},"footer":{"socials":{"x":"https://x.com/nevermined_ai","github":"https://github.com/nevermined-io","linkedin":"https://linkedin.com/company/nevermined","discord":"https://discord.com/invite/GZju2qScKq"}},"seo":{"metatags":{"canonical":"https://nevermined.ai/docs"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"markdown":{"instructions":["If you are an agent buying services: start with these steps. Every page has a .md version.","1. Install the Catalog MCP (live server https://mcp.live.nevermined.app/mcp, sandbox server https://mcp.sandbox.nevermined.app/mcp; rehearse on sandbox with a sandbox API key before live, as keys work only in their own environment; Claude Code and Cursor commands, Codex config.toml entry): https://nevermined.ai/docs/products/catalog/mcp.md","2. Get an API key: https://nevermined.ai/docs/agents-guide/get-api-key.md","3. Enroll a card and create a delegation (a payment method plus a spend mandate: an amount, an expiry and a number of purchases): https://nevermined.ai/docs/agents-guide/enroll-card.md","4. Buy and call a paid agent over x402: https://nevermined.ai/docs/getting-started/ai-agent-purchase.md","SDK quickstart: https://nevermined.ai/docs/integrate/quickstart/typescript.md. Pricing: https://nevermined.ai/pricing/"]},"styling":{"latex":true},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"neverminedag","hasAudioNarration":false,"actualSubdomain":"neverminedag","customDomains":["nevermined.ai"],"gitSource":{"type":"github","owner":"nevermined-io","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae0c13a0040e29b52150f7c","collectionId":"9e35ee3d-32df-496f-8dc8-ce70d69b6043","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae0c13a0040e29b52150f7c"},"feedback":{"agentFeedback":true,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae0cfcdc9d0adb3afbd8943","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API","count":147},{"language":"default","tag":"Guides","count":130},{"language":"default","tag":"Organizations","count":96},{"language":"default","tag":"Nevermined Catalog","count":48},{"language":"default","tag":"SDK","count":35},{"language":"default","tag":"Connect from a host","count":28},{"language":"default","tag":"Integrations","count":21},{"language":"default","tag":"Authentication","count":17},{"language":"default","tag":"MCP","count":17},{"language":"default","tag":"Learn","count":16}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@nevermined.io","showHelpButton":true}},"basePath":"/docs","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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"@keyframes nvm-catalog-shimmer{0%,to{background-color:var(--catalog-accent)}50%{background-color:var(--catalog-lime)}}img.nav-logo{max-height:20px!important;height:20px!important;width:auto!important}.nav-tabs{gap:0!important;padding:0!important}a.nav-tabs-item{padding:8px 16px!important;font-size:14px!important;font-weight:500!important;min-width:auto!important;border-radius:0!important;background:0 0!important}a.nav-tabs-item:hover{color:#0f766e!important;background:0 0!important}.dark a.nav-tabs-item,[data-theme=dark] a.nav-tabs-item{color:#d1d5db!important}.dark a.nav-tabs-item:hover,[data-theme=dark] a.nav-tabs-item:hover{color:#5eead4!important}@media (max-width:768px){a.nav-tabs-item{padding:6px 12px!important;font-size:13px!important}}.nvm-hero-banner{position:relative;background-color:#0d3f48;border-radius:24px;padding:48px 32px;margin-bottom:32px;overflow:hidden;min-height:320px;display:flex;flex-direction:column;justify-content:center}.nvm-hero-banner::before{content:'';position:absolute;top:0;left:0;right:0;bottom:0;background-image:url(/images/product_hero.jpg);background-size:cover;background-position:center right;opacity:.9}.nvm-hero-content{position:relative;z-index:1;max-width:600px}.nvm-hero-label{color:#fff;font-size:12px;font-weight:600;letter-spacing:2px;text-transform:uppercase;margin-bottom:16px;opacity:.9}.nvm-hero-title{font-size:clamp(28px,5vw,48px);font-weight:300;line-height:1.1;margin-bottom:20px}.nvm-gradient-text{background:linear-gradient(114.57deg,#bcdc4a 23%,#abe2dd 60%);-webkit-background-clip:text;-webkit-text-fill-color:transparent;background-clip:text;font-style:italic}.nvm-hero-title-white{color:#fff;display:block;margin-top:4px}.nvm-hero-description{color:rgba(255,255,255,.85);font-size:16px;line-height:1.6;margin-bottom:24px;max-width:500px}.nvm-hero-button{display:inline-block;background-color:#fff;color:#0d3f48!important;padding:12px 24px;border-radius:8px;font-size:14px;font-weight:600;text-decoration:none!important;transition:all .2s ease;border:0;cursor:pointer}.nvm-hero-button:hover{background-color:#f0f0f0;transform:translateY(-1px);text-decoration:none!important}@media (max-width:768px){.nvm-hero-banner{padding:32px 24px;min-height:280px}.nvm-hero-banner::before{background-position:center center;opacity:.7}.nvm-hero-title{font-size:28px}.nvm-hero-description{font-size:14px}}.prose,.prose li,.prose p,article li,article p{font-size:15px!important;line-height:1.6!important}.prose h1,article h1{font-size:27px!important}.prose h2,article h2{font-size:21px!important}.prose h3,article h3{font-size:17px!important}.prose h4,article h4{font-size:15px!important}#sidebar a.group{padding-top:4px!important;padding-bottom:4px!important}#sidebar li{margin:1px 0!important}.sidebar-group-header{gap:6px!important;margin-bottom:4px!important;padding-left:12px!important}#sidebar .lg\\:mt-8,#sidebar .mt-6{margin-top:20px!important}ul.sidebar-group{gap:0!important}#sidebar-content{padding-top:12px!important;padding-bottom:12px!important}#navigation-items{font-size:13px!important}:is(a, button, input, select, textarea, summary,\n [tabindex]:not([tabindex=\"-1\"]), [role=\"button\"], [role=\"link\"],\n [role=\"tab\"], [role=\"menuitem\"], [role=\"option\"], [role=\"checkbox\"],\n [role=\"switch\"]):focus-visible{outline:2px solid #0f766e!important;outline-offset:2px!important}.dark :is(a, button, input, select, textarea, summary,\n [tabindex]:not([tabindex=\"-1\"]), [role=\"button\"], [role=\"link\"],\n [role=\"tab\"], [role=\"menuitem\"], [role=\"option\"], [role=\"checkbox\"],\n [role=\"switch\"]):focus-visible,[data-theme=dark] :is(a, button, input, select, textarea, summary,\n [tabindex]:not([tabindex=\"-1\"]), [role=\"button\"], [role=\"link\"],\n [role=\"tab\"], [role=\"menuitem\"], [role=\"option\"], [role=\"checkbox\"],\n [role=\"switch\"]):focus-visible{outline-color:#5eead4!important}#navbar{background-color:rgb(var(--background-light, 255 255 255))!important;border-bottom:1px solid #e5e7eb!important;--nvmbg-ink:#0d3f48}.dark #navbar,[data-theme=dark] #navbar{background-color:rgb(var(--background-dark, 11 14 15))!important;border-bottom-color:rgba(255,255,255,.08)!important;--nvmbg-ink:#4ac6bf}#navbar::after,#navbar::before{content:\"\";position:absolute;inset:0;z-index:1;pointer-events:none}#navbar::after{background-image:url(data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20width%3D%22600%22%20height%3D%22130%22%20viewBox%3D%220%200%20600%20130%22%20fill%3D%22none%22%3E%3Cg%20stroke%3D%22%230d3f48%22%20stroke-opacity%3D%220.09%22%20stroke-width%3D%221%22%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%2240%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%2266%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%2292%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22118%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22144%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22170%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22196%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22222%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22248%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22274%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22300%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22326%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22352%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22378%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22404%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22430%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22456%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22482%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22508%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22534%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22560%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22586%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22612%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22638%22%2F%3E%3C%2Fg%3E%3Cg%20stroke%3D%22%230d3f48%22%20stroke-opacity%3D%220.04%22%20stroke-width%3D%221%22%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%2240%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%2266%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%2292%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22118%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22144%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22170%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22196%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22222%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22248%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22274%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22300%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22326%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22352%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22378%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22404%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22430%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22456%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22482%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22508%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22534%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22560%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22586%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22612%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22638%22%2F%3E%3C%2Fg%3E%3C%2Fsvg%3E);background-repeat:no-repeat;background-position:top right;background-size:600px 130px}.dark #navbar::after,[data-theme=dark] #navbar::after{background-image:url(data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20width%3D%22600%22%20height%3D%22130%22%20viewBox%3D%220%200%20600%20130%22%20fill%3D%22none%22%3E%3Cg%20stroke%3D%22%234ac6bf%22%20stroke-opacity%3D%220.1%22%20stroke-width%3D%221%22%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%2240%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%2266%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%2292%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22118%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22144%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22170%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22196%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22222%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22248%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22274%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22300%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22326%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22352%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22378%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22404%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22430%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22456%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22482%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22508%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22534%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22560%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22586%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22612%22%2F%3E%3Ccircle%20cx%3D%22600%22%20cy%3D%220%22%20r%3D%22638%22%2F%3E%3C%2Fg%3E%3Cg%20stroke%3D%22%234ac6bf%22%20stroke-opacity%3D%220.045%22%20stroke-width%3D%221%22%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%2240%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%2266%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%2292%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22118%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22144%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22170%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22196%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22222%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22248%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22274%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22300%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22326%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22352%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22378%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22404%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22430%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22456%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22482%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22508%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22534%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22560%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22586%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22612%22%2F%3E%3Ccircle%20cx%3D%22618%22%20cy%3D%2214%22%20r%3D%22638%22%2F%3E%3C%2Fg%3E%3C%2Fsvg%3E)}#navbar::before{opacity:.06;background-image:repeating-linear-gradient(45deg,var(--nvmbg-ink) 0,var(--nvmbg-ink) .5px,transparent .5px,transparent 5px);-webkit-mask-image:radial-gradient(120% 140% at 0 0,#000 0,transparent 55%);mask-image:radial-gradient(120% 140% at 0 0,#000 0,transparent 55%)}#navbar div:has(>nav #topbar-cta-button)>nav{order:1;margin-inline:1rem 0}#navbar div:has(>nav #topbar-cta-button)>div{margin-inline:0}#topbar-cta-button>a{--catalog-accent:#12a89e;--catalog-lime:#8fbf1f;position:relative;display:inline-flex;align-items:center;padding:13px 22px 13px 57px;border-radius:12px;background:#0d3f48;font-size:15px;font-weight:600;line-height:1}:is(.dark, [data-theme=\"dark\"]) #topbar-cta-button>a{--catalog-accent:#4ac6bf;--catalog-lime:#bcdc4a}#topbar-cta-button>a>div>svg,#topbar-cta-button>a>span.absolute{display:none}#topbar-cta-button>a::after,#topbar-cta-button>a::before{content:\"\";position:absolute;left:22px;top:50%;transform:translateY(-50%);width:24px;height:17px;background-color:var(--catalog-accent);mask:var(--catalog-ribbon) center/contain no-repeat;-webkit-mask:var(--catalog-ribbon) center/contain no-repeat;pointer-events:none}#topbar-cta-button>a::before{--catalog-ribbon:url(\"data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20viewBox%3D%220%200%2031.06%2022%22%3E%3Cpath%20d%3D%22M0%2011.153L10.4179%2020.6426V11.0576L0%201.56805V11.153Z%22%2F%3E%3C%2Fsvg%3E\")}#topbar-cta-button>a::after{--catalog-ribbon:url(\"data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20viewBox%3D%220%200%2031.06%2022%22%3E%3Cpath%20d%3D%22M10.4178%201.56805V11.153L20.8325%2020.6426L31.0596%2011.153V1.56805L20.8325%2011.0576L10.4178%201.56805Z%22%2F%3E%3C%2Fsvg%3E\")}@media (prefers-reduced-motion:no-preference){#topbar-cta-button>a:is(:hover, :focus-visible)::after,#topbar-cta-button>a:is(:hover, :focus-visible)::before{animation:nvm-catalog-shimmer .8s ease-in-out infinite}#topbar-cta-button>a:is(:hover, :focus-visible)::after{animation-delay:.12s}}"}],"page":{"pagePath":"api-reference/router/credits-balance","slug":"/api-reference/router/credits-balance","pageMetadata":{"title":"Read Your Credits","openapi":"GET /credits/balance","description":"Your Nevermined credits: every credit your personal account holds — free welcome credits, a Nevermined Subscription's monthly allowance and top-up credits — as one balance, subscribed or not. They are spent earliest expiry first. Charges nothing; a caller with no credits gets `total: \"0\"` and an empty `parts`.\n\nAlways personal: an organization tag on the key and an `X-Current-Org-Id` header are ignored — but a call made in an organization never spends these credits (`BCK.SUBSCRIPTION_ROUTER.0002`), so `spendable` is what a personal key can pay with. API keys only: an OAuth-minted credential is refused (`BCK.OAUTH.0030`), even a commerce connection allowed to spend your credits. Frozen credits count in `total` but not in `spendable`.","href":"/api-reference/router/credits-balance"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Your Nevermined credits: every credit your personal account holds — free welcome credits, a Nevermined Subscription’s monthly allowance and top-up credits — as one balance, subscribed or not. They are spent earliest expiry first. Charges nothing; a caller with no credits gets \", _jsx(_components.code, {\n children: \"total: \\\"0\\\"\"\n }), \" and an empty \", _jsx(_components.code, {\n children: \"parts\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Always personal: an organization tag on the key and an \", _jsx(_components.code, {\n children: \"X-Current-Org-Id\"\n }), \" header are ignored — but a call made in an organization never spends these credits (\", _jsx(_components.code, {\n children: \"BCK.SUBSCRIPTION_ROUTER.0002\"\n }), \"), so \", _jsx(_components.code, {\n children: \"spendable\"\n }), \" is what a personal key can pay with. API keys only: an OAuth-minted credential is refused (\", _jsx(_components.code, {\n children: \"BCK.OAUTH.0030\"\n }), \"), even a commerce connection allowed to spend your credits. Frozen credits count in \", _jsx(_components.code, {\n children: \"total\"\n }), \" but not in \", _jsx(_components.code, {\n children: \"spendable\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Read Your Credits","openapi":"GET /credits/balance","description":"Your Nevermined credits: every credit your personal account holds — free welcome credits, a Nevermined Subscription's monthly allowance and top-up credits — as one balance, subscribed or not. They are spent earliest expiry first. Charges nothing; a caller with no credits gets `total: \"0\"` and an empty `parts`.\n\nAlways personal: an organization tag on the key and an `X-Current-Org-Id` header are ignored — but a call made in an organization never spends these credits (`BCK.SUBSCRIPTION_ROUTER.0002`), so `spendable` is what a personal key can pay with. API keys only: an OAuth-minted credential is refused (`BCK.OAUTH.0030`), even a commerce connection allowed to spend your credits. Frozen credits count in `total` but not in `spendable`.","href":"/api-reference/router/credits-balance"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/neverminedag/13bbe6de0edf6c8b/docs-analytics.js"],"openApiReferenceData":{"operation":{"description":"Your Nevermined credits: every credit your personal account holds — free welcome credits, a Nevermined Subscription's monthly allowance and top-up credits — as one balance, subscribed or not. They are spent earliest expiry first. Charges nothing; a caller with no credits gets `total: \"0\"` and an empty `parts`.\n\nAlways personal: an organization tag on the key and an `X-Current-Org-Id` header are ignored — but a call made in an organization never spends these credits (`BCK.SUBSCRIPTION_ROUTER.0002`), so `spendable` is what a personal key can pay with. API keys only: an OAuth-minted credential is refused (`BCK.OAUTH.0030`), even a commerce connection allowed to spend your credits. Frozen credits count in `total` but not in `spendable`.","operationId":"getCreditsBalance","parameters":[],"responses":{"200":"e178e6f5-2b0d-469d-b7bc-4846d6be1c8b","401":"ef8d8d43-97d0-4393-91b1-d30eccfe0f3d","403":"2ece618b-da2c-4738-89fb-46ed5d47b422","503":"d0d55a64-3876-4785-a391-ef3e55d03da5"},"summary":"Read your credits","tags":["Router"],"method":"get","type":"path","servers":["92b7fab7-4e53-4304-b2a7-4eea191f4fa3","fcd04889-435b-4fd1-8843-38396a23ff2d"],"security":["007a87bd-2697-4ece-b64f-39bf3f78643e"],"path":"/credits/balance","baseUrlOptions":["https://api.sandbox.nevermined.app/api/v1","https://api.live.nevermined.app/api/v1"],"title":"Read your credits","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"e178e6f5-2b0d-469d-b7bc-4846d6be1c8b":{"description":"The caller's credits, as a total and by kind and expiry.","content":{"application/json":{"schema":{"type":"object","properties":{"total":{"type":"string","description":"Every unexpired credit, frozen ones included, as a whole-number digit string. `\"0\"` when there is none.","example":"2000","isRequired":true,"uniqueKey":"total","typeLabel":"string"},"spendable":{"type":"string","description":"The credits that can pay a call right now: the sum of the parts that are not frozen, as a whole-number digit string. What the Router spends — read it rather than adding up your calls.","example":"2000","isRequired":true,"uniqueKey":"spendable","typeLabel":"string"},"parts":{"type":"array","description":"The credits left, by kind, expiry and freeze, in the order they are spent: earliest expiry first, never-expiring last. Empty when there is none.","items":{"type":"object","properties":{"kind":{"type":"string","enum":["allowance","welcome","topup","sla"],"description":"What the credits are: `allowance` (a Nevermined Subscription invoice; expires at the period end), `welcome` (the free sign-up grant; expires on its date), `topup` (a credit pack; never expires) or `sla` (credits Nevermined added for a defective result; expire at the period end).","example":"welcome","isRequired":true,"uniqueKey":"parts.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"credits":{"type":"string","description":"Credits of this kind and expiry left, as a whole-number digit string.","example":"2000","isRequired":true,"uniqueKey":"parts.items.[INDEX].credits","typeLabel":"string"},"expiresAt":{"oneOf":[{"type":"string","description":"When these credits expire (ISO 8601), or `null` when they never do.","example":"2026-11-26T09:12:44.000Z","isRequired":true,"uniqueKey":"parts.items.[INDEX].expiresAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When these credits expire (ISO 8601), or `null` when they never do.","example":"2026-11-26T09:12:44.000Z","isRequired":true,"uniqueKey":"parts.items.[INDEX].expiresAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"parts.items.[INDEX].expiresAt","typeLabel":"string | null"},"frozen":{"oneOf":[{"type":"string","enum":["renewal_overdue","dispute",null],"description":"`null` when these credits can be spent. `renewal_overdue`: allowance credits, frozen until the overdue renewal payment goes through; your other credits stay spendable. `dispute`: every credit is frozen while a card dispute on a payment to Nevermined is open, or after one was decided in the cardholder's favour.","isRequired":true,"uniqueKey":"parts.items.[INDEX].frozen.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["renewal_overdue","dispute",null],"description":"`null` when these credits can be spent. `renewal_overdue`: allowance credits, frozen until the overdue renewal payment goes through; your other credits stay spendable. `dispute`: every credit is frozen while a card dispute on a payment to Nevermined is open, or after one was decided in the cardholder's favour.","isRequired":true,"uniqueKey":"parts.items.[INDEX].frozen.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"parts.items.[INDEX].frozen","typeLabel":"enum\u003cstring> | null"}},"required":["kind","credits","expiresAt","frozen"],"uniqueKey":"parts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"parts","typeLabel":"object[]"},"nextExpiry":{"oneOf":[{"type":"object","description":"The next credits to expire, or `null` when none of the credits left ever expires.","required":["credits","at"],"properties":{"credits":{"type":"string","description":"Credits that expire at `at`, as a whole-number digit string.","example":"2000","isRequired":true,"uniqueKey":"nextExpiry.oneOf.0.credits","typeLabel":"string"},"at":{"type":"string","description":"The earliest expiry among the credits left (ISO 8601).","example":"2026-11-26T09:12:44.000Z","isRequired":true,"uniqueKey":"nextExpiry.oneOf.0.at","typeLabel":"string"}},"isRequired":true,"uniqueKey":"nextExpiry.oneOf.0","typeLabel":"object"},{"type":"null","description":"The next credits to expire, or `null` when none of the credits left ever expires.","isRequired":true,"uniqueKey":"nextExpiry.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"nextExpiry","typeLabel":"object | null"},"topups":{"type":"object","description":"Your credit top-up settings. Present when credit top-ups are available to you; absent when they are not, or when the settings could not be read this time. Top-ups are turned on and managed in the Nevermined App, not over the API.","required":["enabled","monthlyLimitUsd","maxMonthlyLimitUsd","boughtThisMonthUsd","packPriceUsd","paused","card"],"properties":{"enabled":{"type":"boolean","description":"Whether a pack is charged automatically when credits run out. Off by default; switched on by buying the first pack in the Nevermined App.","example":true,"isRequired":true,"uniqueKey":"topups.enabled","typeLabel":"boolean"},"monthlyLimitUsd":{"oneOf":[{"type":"integer","description":"The monthly limit the account set, in whole US dollars before tax, or `null` when it never set one. Kept when top-ups are switched off.","example":30,"isRequired":true,"uniqueKey":"topups.monthlyLimitUsd.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The monthly limit the account set, in whole US dollars before tax, or `null` when it never set one. Kept when top-ups are switched off.","example":30,"isRequired":true,"uniqueKey":"topups.monthlyLimitUsd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"topups.monthlyLimitUsd","typeLabel":"integer | null"},"maxMonthlyLimitUsd":{"type":"integer","description":"The highest monthly limit Nevermined allows, in whole US dollars.","example":50,"isRequired":true,"uniqueKey":"topups.maxMonthlyLimitUsd","typeLabel":"integer"},"boughtThisMonthUsd":{"type":"number","description":"Packs bought this UTC calendar month, in US dollars before tax — every pack charged or being charged, a refunded one included. What the monthly limit counts.","example":10,"isRequired":true,"uniqueKey":"topups.boughtThisMonthUsd","typeLabel":"number"},"packPriceUsd":{"oneOf":[{"type":"number","description":"The price of one pack, in US dollars before tax: what the next pack adds to `boughtThisMonthUsd`. The lowest monthly limit is this rounded up to a whole dollar. `null` when no pack is on sale in this deployment.","example":10,"isRequired":true,"uniqueKey":"topups.packPriceUsd.oneOf.0","typeLabel":"number"},{"type":"null","description":"The price of one pack, in US dollars before tax: what the next pack adds to `boughtThisMonthUsd`. The lowest monthly limit is this rounded up to a whole dollar. `null` when no pack is on sale in this deployment.","example":10,"isRequired":true,"uniqueKey":"topups.packPriceUsd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"topups.packPriceUsd","typeLabel":"number | null"},"paused":{"oneOf":[{"type":"object","description":"`null` unless packs are paused, and why.","required":["reason","since"],"properties":{"reason":{"type":"string","enum":["payment_failed","action_required","card_unavailable","dispute"],"description":"`payment_failed`: the last automatic pack was declined. `action_required`: its card asked for authentication. `card_unavailable` (API version 1.84 or later; older versions read `payment_failed`): the card that pays packs can no longer pay (removed, or no longer usable); choosing another card lifts it. Buying a pack lifts any of these. `dispute`: a card dispute on a credit top-up pack is open, or was decided in the cardholder's favour — every credit is frozen and no pack is charged. A dispute on the subscription also freezes every credit (`frozen: dispute` on the parts) but leaves `paused` at `null`.","example":"payment_failed","isRequired":true,"uniqueKey":"topups.paused.oneOf.0.reason","typeLabel":"enum\u003cstring>"},"since":{"type":"string","description":"Since when (ISO 8601).","example":"2026-10-19T10:00:00.000Z","isRequired":true,"uniqueKey":"topups.paused.oneOf.0.since","typeLabel":"string"}},"isRequired":true,"uniqueKey":"topups.paused.oneOf.0","typeLabel":"object"},{"type":"null","description":"`null` unless packs are paused, and why.","isRequired":true,"uniqueKey":"topups.paused.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"topups.paused","typeLabel":"object | null"},"card":{"oneOf":[{"type":"object","description":"The saved card that pays packs, or `null` when none is saved.","required":["brand","last4"],"properties":{"brand":{"type":"string","description":"The saved card's brand, as Stripe names it.","example":"visa","isRequired":true,"uniqueKey":"topups.card.oneOf.0.brand","typeLabel":"string"},"last4":{"type":"string","description":"The saved card's last four digits.","example":"4242","isRequired":true,"uniqueKey":"topups.card.oneOf.0.last4","typeLabel":"string"}},"isRequired":true,"uniqueKey":"topups.card.oneOf.0","typeLabel":"object"},{"type":"null","description":"The saved card that pays packs, or `null` when none is saved.","isRequired":true,"uniqueKey":"topups.card.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"topups.card","typeLabel":"object | null"}},"uniqueKey":"topups","typeLabel":"object"}},"required":["total","spendable","parts","nextExpiry"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"total":"2000","spendable":"2000","parts":[{"kind":"welcome","credits":"2000","expiresAt":"2026-11-26T09:12:44.000Z","frozen":"renewal_overdue"}],"nextExpiry":{"credits":"2000","at":"2026-11-26T09:12:44.000Z"},"topups":{"enabled":true,"monthlyLimitUsd":30,"maxMonthlyLimitUsd":50,"boughtThisMonthUsd":10,"packPriceUsd":10,"paused":{"reason":"payment_failed","since":"2026-10-19T10:00:00.000Z"},"card":{"brand":"visa","last4":"4242"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"ef8d8d43-97d0-4393-91b1-d30eccfe0f3d":{"description":"Missing/invalid Nevermined API key.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Router error code. `BCK.ROUTER.0001` invalid request / no fundable option / bad 402 (400); `BCK.ROUTER.0002` requestId already used — idempotency conflict (409); `BCK.ROUTER.0003` delegation budget exceeded, expired, or inactive (402); `BCK.ROUTER.0004` payment record not found (404); `BCK.ROUTER.0005` payment not in a settleable state (409). Framework-level `BCK.HTTP.*` codes (e.g. `BCK.HTTP.400` request validation, `BCK.HTTP.429` throttling) may also appear — see the base `code` field.","example":"BCK.ROUTER.0003","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"httpStatus":{"type":"number","description":"HTTP status code","example":500,"isRequired":true,"uniqueKey":"httpStatus","typeLabel":"number"},"message":{"type":"string","description":"Error message for Router operations.","example":"delegation budget exceeded, expired, or inactive","examples":["delegationId is required — create one via POST /api/v1/delegation/create","no fundable option; offered: [...]","upstream pay-to address is not in this delegation's allowed recipients","delegation budget exceeded, expired, or inactive","payment already settled with a different txHash"],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"type":"string","description":"Throw-site detail string supplementing the canonical message. Only set when the call site supplied an opts.message; absent otherwise.","example":"Hash JWT is not signed by the node account","uniqueKey":"details","typeLabel":"string"},"error":{"type":"string","description":"RFC 6749 §5.2 / RFC 8628 §3.5 top-level OAuth error string. Present only on the OAuth device-polling responses from `POST /oauth/token` (`authorization_pending`, `slow_down`, `expired_token`, `access_denied`), so a standards-compliant OAuth/device client can branch on it directly instead of on the Nevermined `code`. Absent on every other error.","example":"authorization_pending","uniqueKey":"error","typeLabel":"string"},"hint":{"type":"string","description":"Actionable remediation hint, sourced from the catalogue or supplied at the throw site. Tells the caller what to fix or where to look.","example":"Verify the wallet has sufficient balance and that the plan is active.","uniqueKey":"hint","typeLabel":"string"},"docsUrl":{"type":"string","description":"Permalink to the docs page describing this error code.","example":"https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008","uniqueKey":"docsUrl","typeLabel":"string"},"category":{"type":"string","description":"Coarse classification of the failure, useful for client-side branching without parsing the message.","enum":["validation","auth","business","integration","internal"],"example":"integration","uniqueKey":"category","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the failure is transient and the same call can be retried with identical inputs. Absent when the catalogue does not assert either way.","example":true,"uniqueKey":"retryable","typeLabel":"boolean"},"correlationId":{"type":"string","description":"Request-scoped correlation id stamped by the global filter. Echoed in the x-correlation-id response header. Quote this when reporting issues.","example":"a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9","uniqueKey":"correlationId","typeLabel":"string"},"uuid":{"type":"string","description":"Per-error UUID generated at construction. Useful for log correlation.","example":"e-550e8400-e29b-41d4-a716-446655440000","uniqueKey":"uuid","typeLabel":"string"},"date":{"type":"string","description":"ISO timestamp at which the error was constructed.","example":"2026-05-09T12:34:56.789Z","format":"date-time","uniqueKey":"date","typeLabel":"string\u003cdate-time>"},"params":{"type":"string","description":"JSON-stringified contextual parameters supplied at the throw site (e.g. IDs, state). Always a string in the wire format — parse with JSON.parse if needed.","example":"{\"planId\":\"43298432984329\",\"reason\":\"Invalid configuration\"}","uniqueKey":"params","typeLabel":"string"}},"required":["code","httpStatus","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"BCK.ROUTER.0003","httpStatus":500,"message":"delegation budget exceeded, expired, or inactive","details":"Hash JWT is not signed by the node account","error":"authorization_pending","hint":"Verify the wallet has sufficient balance and that the plan is active.","docsUrl":"https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008","category":"integration","retryable":true,"correlationId":"a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9","uuid":"e-550e8400-e29b-41d4-a716-446655440000","date":"2026-05-09T12:34:56.789Z","params":"{\"planId\":\"43298432984329\",\"reason\":\"Invalid configuration\"}"}}},"exampleType":"generated"}},"exampleType":"generated"},"2ece618b-da2c-4738-89fb-46ed5d47b422":{"description":"An OAuth-minted credential (BCK.OAUTH.0030).","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Router error code. `BCK.ROUTER.0001` invalid request / no fundable option / bad 402 (400); `BCK.ROUTER.0002` requestId already used — idempotency conflict (409); `BCK.ROUTER.0003` delegation budget exceeded, expired, or inactive (402); `BCK.ROUTER.0004` payment record not found (404); `BCK.ROUTER.0005` payment not in a settleable state (409). Framework-level `BCK.HTTP.*` codes (e.g. `BCK.HTTP.400` request validation, `BCK.HTTP.429` throttling) may also appear — see the base `code` field.","example":"BCK.ROUTER.0003","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"httpStatus":{"type":"number","description":"HTTP status code","example":500,"isRequired":true,"uniqueKey":"httpStatus","typeLabel":"number"},"message":{"type":"string","description":"Error message for Router operations.","example":"delegation budget exceeded, expired, or inactive","examples":["delegationId is required — create one via POST /api/v1/delegation/create","no fundable option; offered: [...]","upstream pay-to address is not in this delegation's allowed recipients","delegation budget exceeded, expired, or inactive","payment already settled with a different txHash"],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"type":"string","description":"Throw-site detail string supplementing the canonical message. Only set when the call site supplied an opts.message; absent otherwise.","example":"Hash JWT is not signed by the node account","uniqueKey":"details","typeLabel":"string"},"error":{"type":"string","description":"RFC 6749 §5.2 / RFC 8628 §3.5 top-level OAuth error string. Present only on the OAuth device-polling responses from `POST /oauth/token` (`authorization_pending`, `slow_down`, `expired_token`, `access_denied`), so a standards-compliant OAuth/device client can branch on it directly instead of on the Nevermined `code`. Absent on every other error.","example":"authorization_pending","uniqueKey":"error","typeLabel":"string"},"hint":{"type":"string","description":"Actionable remediation hint, sourced from the catalogue or supplied at the throw site. Tells the caller what to fix or where to look.","example":"Verify the wallet has sufficient balance and that the plan is active.","uniqueKey":"hint","typeLabel":"string"},"docsUrl":{"type":"string","description":"Permalink to the docs page describing this error code.","example":"https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008","uniqueKey":"docsUrl","typeLabel":"string"},"category":{"type":"string","description":"Coarse classification of the failure, useful for client-side branching without parsing the message.","enum":["validation","auth","business","integration","internal"],"example":"integration","uniqueKey":"category","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the failure is transient and the same call can be retried with identical inputs. Absent when the catalogue does not assert either way.","example":true,"uniqueKey":"retryable","typeLabel":"boolean"},"correlationId":{"type":"string","description":"Request-scoped correlation id stamped by the global filter. Echoed in the x-correlation-id response header. Quote this when reporting issues.","example":"a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9","uniqueKey":"correlationId","typeLabel":"string"},"uuid":{"type":"string","description":"Per-error UUID generated at construction. Useful for log correlation.","example":"e-550e8400-e29b-41d4-a716-446655440000","uniqueKey":"uuid","typeLabel":"string"},"date":{"type":"string","description":"ISO timestamp at which the error was constructed.","example":"2026-05-09T12:34:56.789Z","format":"date-time","uniqueKey":"date","typeLabel":"string\u003cdate-time>"},"params":{"type":"string","description":"JSON-stringified contextual parameters supplied at the throw site (e.g. IDs, state). Always a string in the wire format — parse with JSON.parse if needed.","example":"{\"planId\":\"43298432984329\",\"reason\":\"Invalid configuration\"}","uniqueKey":"params","typeLabel":"string"}},"required":["code","httpStatus","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"BCK.ROUTER.0003","httpStatus":500,"message":"delegation budget exceeded, expired, or inactive","details":"Hash JWT is not signed by the node account","error":"authorization_pending","hint":"Verify the wallet has sufficient balance and that the plan is active.","docsUrl":"https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008","category":"integration","retryable":true,"correlationId":"a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9","uuid":"e-550e8400-e29b-41d4-a716-446655440000","date":"2026-05-09T12:34:56.789Z","params":"{\"planId\":\"43298432984329\",\"reason\":\"Invalid configuration\"}"}}},"exampleType":"generated"}},"exampleType":"generated"},"d0d55a64-3876-4785-a391-ef3e55d03da5":{"description":"The balance could not be read (BCK.CREDITS.0014) — never answered as zero. Retry.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Router error code. `BCK.ROUTER.0001` invalid request / no fundable option / bad 402 (400); `BCK.ROUTER.0002` requestId already used — idempotency conflict (409); `BCK.ROUTER.0003` delegation budget exceeded, expired, or inactive (402); `BCK.ROUTER.0004` payment record not found (404); `BCK.ROUTER.0005` payment not in a settleable state (409). Framework-level `BCK.HTTP.*` codes (e.g. `BCK.HTTP.400` request validation, `BCK.HTTP.429` throttling) may also appear — see the base `code` field.","example":"BCK.ROUTER.0003","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"httpStatus":{"type":"number","description":"HTTP status code","example":500,"isRequired":true,"uniqueKey":"httpStatus","typeLabel":"number"},"message":{"type":"string","description":"Error message for Router operations.","example":"delegation budget exceeded, expired, or inactive","examples":["delegationId is required — create one via POST /api/v1/delegation/create","no fundable option; offered: [...]","upstream pay-to address is not in this delegation's allowed recipients","delegation budget exceeded, expired, or inactive","payment already settled with a different txHash"],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"details":{"type":"string","description":"Throw-site detail string supplementing the canonical message. Only set when the call site supplied an opts.message; absent otherwise.","example":"Hash JWT is not signed by the node account","uniqueKey":"details","typeLabel":"string"},"error":{"type":"string","description":"RFC 6749 §5.2 / RFC 8628 §3.5 top-level OAuth error string. Present only on the OAuth device-polling responses from `POST /oauth/token` (`authorization_pending`, `slow_down`, `expired_token`, `access_denied`), so a standards-compliant OAuth/device client can branch on it directly instead of on the Nevermined `code`. Absent on every other error.","example":"authorization_pending","uniqueKey":"error","typeLabel":"string"},"hint":{"type":"string","description":"Actionable remediation hint, sourced from the catalogue or supplied at the throw site. Tells the caller what to fix or where to look.","example":"Verify the wallet has sufficient balance and that the plan is active.","uniqueKey":"hint","typeLabel":"string"},"docsUrl":{"type":"string","description":"Permalink to the docs page describing this error code.","example":"https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008","uniqueKey":"docsUrl","typeLabel":"string"},"category":{"type":"string","description":"Coarse classification of the failure, useful for client-side branching without parsing the message.","enum":["validation","auth","business","integration","internal"],"example":"integration","uniqueKey":"category","typeLabel":"enum\u003cstring>"},"retryable":{"type":"boolean","description":"Whether the failure is transient and the same call can be retried with identical inputs. Absent when the catalogue does not assert either way.","example":true,"uniqueKey":"retryable","typeLabel":"boolean"},"correlationId":{"type":"string","description":"Request-scoped correlation id stamped by the global filter. Echoed in the x-correlation-id response header. Quote this when reporting issues.","example":"a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9","uniqueKey":"correlationId","typeLabel":"string"},"uuid":{"type":"string","description":"Per-error UUID generated at construction. Useful for log correlation.","example":"e-550e8400-e29b-41d4-a716-446655440000","uniqueKey":"uuid","typeLabel":"string"},"date":{"type":"string","description":"ISO timestamp at which the error was constructed.","example":"2026-05-09T12:34:56.789Z","format":"date-time","uniqueKey":"date","typeLabel":"string\u003cdate-time>"},"params":{"type":"string","description":"JSON-stringified contextual parameters supplied at the throw site (e.g. IDs, state). Always a string in the wire format — parse with JSON.parse if needed.","example":"{\"planId\":\"43298432984329\",\"reason\":\"Invalid configuration\"}","uniqueKey":"params","typeLabel":"string"}},"required":["code","httpStatus","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"BCK.ROUTER.0003","httpStatus":500,"message":"delegation budget exceeded, expired, or inactive","details":"Hash JWT is not signed by the node account","error":"authorization_pending","hint":"Verify the wallet has sufficient balance and that the plan is active.","docsUrl":"https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008","category":"integration","retryable":true,"correlationId":"a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9","uuid":"e-550e8400-e29b-41d4-a716-446655440000","date":"2026-05-09T12:34:56.789Z","params":"{\"planId\":\"43298432984329\",\"reason\":\"Invalid configuration\"}"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"007a87bd-2697-4ece-b64f-39bf3f78643e":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your Nevermined API Key (starts with 'nvm:'). Get one at [nevermined.app](https://nevermined.app) under **Settings > API Keys**.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"92b7fab7-4e53-4304-b2a7-4eea191f4fa3":{"url":"https://api.sandbox.nevermined.app/api/v1","description":"Sandbox (Testing) - Base Sepolia"},"fcd04889-435b-4fd1-8843-38396a23ff2d":{"url":"https://api.live.nevermined.app/api/v1","description":"Live (Production) - Base Mainnet"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your Nevermined API Key (starts with 'nvm:'). Get one at [nevermined.app](https://nevermined.app) under **Settings > API Keys**.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your Nevermined API Key (starts with 'nvm:'). Get one at [nevermined.app](https://nevermined.app) under **Settings > API Keys**.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"neverminedag","siteName":"Nevermined Documentation","title":"Read Your Credits - Nevermined Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T15:20:45.342Z","originalFileLocation":"api-reference/router/credits-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=\"Your Nevermined credits: every credit your personal account holds — free welcome credits, a Nevermined Subscription\u0026#x27;s monthly allowance and top-up credits — as one balance, subscribed or not. They are spent earliest expiry first. Charges nothing; a caller with no credits gets total: \u0026quot;0\u0026quot; and an empty parts. Always personal: an organization tag on the key and an X-Current-Org-Id header are ignored — but a call made in an organization never spends these credits (BCK.SUBSCRIPTION_ROUTER.0002), so spendable is what a personal key can pay with. API keys only: an OAuth-minted credential is refused (BCK.OAUTH.0030), even a commerce connection allowed to spend your credits. Frozen credits count in total but not in spendable.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nevermined Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/neverminedag/kfri__UAQkYRE-Ph/_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=\"/docs/mintlify-assets/_mintlify/favicons/neverminedag/kfri__UAQkYRE-Ph/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/neverminedag/kfri__UAQkYRE-Ph/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/neverminedag/kfri__UAQkYRE-Ph/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/neverminedag/kfri__UAQkYRE-Ph/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/neverminedag/kfri__UAQkYRE-Ph/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/neverminedag/kfri__UAQkYRE-Ph/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/neverminedag/kfri__UAQkYRE-Ph/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/neverminedag/kfri__UAQkYRE-Ph/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read Your Credits - Nevermined Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Your Nevermined credits: every credit your personal account holds — free welcome credits, a Nevermined Subscription\u0026#x27;s monthly allowance and top-up credits — as one balance, subscribed or not. They are spent earliest expiry first. Charges nothing; a caller with no credits gets total: \u0026quot;0\u0026quot; and an empty parts. Always personal: an organization tag on the key and an X-Current-Org-Id header are ignored — but a call made in an organization never spends these credits (BCK.SUBSCRIPTION_ROUTER.0002), so spendable is what a personal key can pay with. API keys only: an OAuth-minted credential is refused (BCK.OAUTH.0030), even a commerce connection allowed to spend your credits. Frozen credits count in total but not in spendable.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nevermined Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://nevermined.ai/docs/api-reference/router/credits-balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://neverminedag.mintlify.app/_mintlify/api/og/v2?division=Router\u0026amp;title=Read+Your+Credits\u0026amp;description=Your+Nevermined+credits%3A+every+credit+your+personal+account+holds+%E2%80%94+free+welcome+credits%2C+a+Nevermined+Subscription%27s+monthly+allowance+and+top-up+credits+%E2%80%94+as+\u0026amp;theme=c89a77452a99234468b325dc\u0026amp;signature=3d1712c4d0678628b7cc102e12560a846a7a0173f8db5a5cf88f64e1c1b59dc4\">\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=\"Read Your Credits - Nevermined Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Your Nevermined credits: every credit your personal account holds — free welcome credits, a Nevermined Subscription\u0026#x27;s monthly allowance and top-up credits — as one balance, subscribed or not. They are spent earliest expiry first. Charges nothing; a caller with no credits gets total: \u0026quot;0\u0026quot; and an empty parts. Always personal: an organization tag on the key and an X-Current-Org-Id header are ignored — but a call made in an organization never spends these credits (BCK.SUBSCRIPTION_ROUTER.0002), so spendable is what a personal key can pay with. API keys only: an OAuth-minted credential is refused (BCK.OAUTH.0030), even a commerce connection allowed to spend your credits. Frozen credits count in total but not in spendable.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://neverminedag.mintlify.app/_mintlify/api/og/v2?division=Router\u0026amp;title=Read+Your+Credits\u0026amp;description=Your+Nevermined+credits%3A+every+credit+your+personal+account+holds+%E2%80%94+free+welcome+credits%2C+a+Nevermined+Subscription%27s+monthly+allowance+and+top-up+credits+%E2%80%94+as+\u0026amp;theme=c89a77452a99234468b325dc\u0026amp;signature=3d1712c4d0678628b7cc102e12560a846a7a0173f8db5a5cf88f64e1c1b59dc4\">\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=\"/docs/mintlify-assets/_mintlify/favicons/neverminedag/kfri__UAQkYRE-Ph/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nevermined Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0f766e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://nevermined.ai/docs/api-reference/router/credits-balance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/router/credits-balance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://nevermined.ai/#organization\",\"name\":\"Nevermined Documentation\",\"url\":\"https://nevermined.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/neverminedag/pEEAPbhrOtjiJvrW/logo/light.svg?fit=max\u0026auto=format\u0026n=pEEAPbhrOtjiJvrW\u0026q=85\u0026s=adbff4ad34c53aed8ca307e9b12104e5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://nevermined.ai/docs#website\",\"name\":\"Nevermined Documentation\",\"url\":\"https://nevermined.ai/docs\",\"publisher\":{\"@id\":\"https://nevermined.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://nevermined.ai/docs/api-reference/router/credits-balance#webpage\",\"url\":\"https://nevermined.ai/docs/api-reference/router/credits-balance\",\"name\":\"Read Your Credits\",\"description\":\"Your Nevermined credits: every credit your personal account holds — free welcome credits, a Nevermined Subscription's monthly allowance and top-up credits — as one balance, subscribed or not. They are spent earliest expiry first. Charges nothing; a caller with no credits gets total: \\\"0\\\" and an empty parts. Always personal: an organization tag on the key and an X-Current-Org-Id header are ignored — but a call made in an organization never spends these credits (BCK.SUBSCRIPTION_ROUTER.0002), so spendable is what a personal key can pay with. API keys only: an OAuth-minted credential is refused (BCK.OAUTH.0030), even a commerce connection allowed to spend your credits. Frozen credits count in total but not in spendable.\",\"dateModified\":\"2026-10-27T15:20:45.342Z\",\"isPartOf\":{\"@id\":\"https://nevermined.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://nevermined.ai/docs/api-reference/router/credits-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://nevermined.ai/docs/api-reference/router/credits-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Router\",\"item\":\"https://nevermined.ai/docs/api-reference/router/mint-payment-credential\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Read Your Credits\",\"item\":\"https://nevermined.ai/docs/api-reference/router/credits-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://nevermined.ai/docs/api-reference/router/credits-balance#apireference\",\"headline\":\"Read Your Credits\",\"name\":\"Read Your Credits\",\"description\":\"Your Nevermined credits: every credit your personal account holds — free welcome credits, a Nevermined Subscription's monthly allowance and top-up credits — as one balance, subscribed or not. They are spent earliest expiry first. Charges nothing; a caller with no credits gets total: \\\"0\\\" and an empty parts. Always personal: an organization tag on the key and an X-Current-Org-Id header are ignored — but a call made in an organization never spends these credits (BCK.SUBSCRIPTION_ROUTER.0002), so spendable is what a personal key can pay with. API keys only: an OAuth-minted credential is refused (BCK.OAUTH.0030), even a commerce connection allowed to spend your credits. Frozen credits count in total but not in spendable.\",\"url\":\"https://nevermined.ai/docs/api-reference/router/credits-balance\",\"mainEntityOfPage\":{\"@id\":\"https://nevermined.ai/docs/api-reference/router/credits-balance#webpage\"},\"dateModified\":\"2026-10-27T15:20:45.342Z\",\"publisher\":{\"@id\":\"https://nevermined.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://nevermined.ai/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nevermined Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Nevermined Documentation","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/getting-started/overview"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/catalog-mcp/overview"}]},{"tab":"API","groups":[{"group":"Overview","pages":[{"title":"Pre-requisites","icon":"key","href":"/api-reference/introduction"},{"title":"API Versioning","icon":"code-branch","href":"/development-guide/api-versioning"},{"title":"API error model","icon":"circle-exclamation","href":"/development-guide/api-errors/overview"},{"title":"API error codes","href":"/development-guide/api-errors/codes"}]},{"group":"Agents","pages":[{"title":"Register Agent","openapi":"POST /protocol/agents","href":"/api-reference/protocol/register-agent"},{"title":"List Agents","openapi":"GET /protocol/agents","href":"/api-reference/protocol/list-agents"},{"title":"Get Agent","openapi":"GET /protocol/agents/{agentId}","href":"/api-reference/protocol/get-agent"},{"title":"Update Agent","openapi":"PUT /protocol/agents/{agentId}","href":"/api-reference/protocol/update-agent"},{"title":"Register Agent and Plan","openapi":"POST /protocol/agents/plans","href":"/api-reference/protocol/register-agent-and-plan"},{"title":"Activate/Deactivate Agent","openapi":"PUT /protocol/agents/{agentId}/list/{activate}","href":"/api-reference/protocol/toggle-agent-listing"},{"title":"Add Plan to Agent","openapi":"POST /protocol/agents/{agentId}/plan/{planId}","href":"/api-reference/protocol/add-plan-to-agent"},{"title":"Remove Plan from Agent","openapi":"DELETE /protocol/agents/{agentId}/plan/{planId}","href":"/api-reference/protocol/remove-plan-from-agent"},{"title":"Get Agent Plans","openapi":"GET /protocol/agents/{agentId}/plans","href":"/api-reference/protocol/get-agent-plans"}]},{"group":"Plans","pages":[{"title":"Register Plan","openapi":"POST /protocol/plans","href":"/api-reference/protocol/register-plan"},{"title":"List Plans","openapi":"GET /protocol/plans","href":"/api-reference/protocol/list-plans"},{"title":"Get Plan","openapi":"GET /protocol/plans/{planId}","href":"/api-reference/protocol/get-plan"},{"title":"Update Plan","openapi":"PUT /protocol/plans/{planId}","href":"/api-reference/protocol/update-plan"},{"title":"Activate/Deactivate Plan","openapi":"PUT /protocol/plans/{planId}/list/{activate}","href":"/api-reference/protocol/toggle-plan-listing"},{"title":"Order Plan","openapi":"POST /protocol/plans/{planId}/order","href":"/api-reference/protocol/order-plan"},{"title":"Get Plan Balance","openapi":"GET /protocol/plans/{planId}/balance/{holderAddress}","href":"/api-reference/protocol/get-plan-balance"},{"title":"Get Plan Agents","openapi":"GET /protocol/plans/{planId}/agents","href":"/api-reference/protocol/get-plan-agents"}]},{"group":"Access","pages":[{"title":"Get Access Token","openapi":"GET /protocol/token/{planId}/{agentId}","href":"/api-reference/protocol/get-access-token"},{"title":"Initialize Agent Request","openapi":"POST /protocol/agents/initialize/{agentId}","href":"/api-reference/protocol/initialize-agent-request"},{"title":"Track Agent Sub Task","openapi":"POST /protocol/agent-sub-tasks","href":"/api-reference/protocol/track-agent-sub-task"}]},{"group":"x402","pages":[{"title":"Verify","openapi":"POST /x402/verify","href":"/api-reference/x402/verify-permission"},{"title":"Settle","openapi":"POST /x402/settle","href":"/api-reference/x402/settle-permission"},{"title":"Create Permission","openapi":"POST /x402/permissions","href":"/api-reference/x402/create-permission"},{"title":"List Permissions","openapi":"GET /x402/permissions","href":"/api-reference/x402/list-permissions"},{"title":"Get Permission","openapi":"GET /x402/permissions/{permissionHash}","href":"/api-reference/x402/get-permission"},{"title":"Revoke Permission","openapi":"DELETE /x402/permissions/{permissionHash}","href":"/api-reference/x402/revoke-permission"}]},{"group":"Credits","pages":[{"title":"Mint Credits","openapi":"POST /protocol/plans/mint","href":"/api-reference/protocol/mint-credits"},{"title":"Mint Expirable Credits","openapi":"POST /protocol/plans/mintExpirable","href":"/api-reference/protocol/mint-expirable-credits"},{"title":"Redeem Credits","openapi":"POST /protocol/plans/redeem","href":"/api-reference/protocol/redeem-credits"}]},{"group":"Delegation","pages":[{"title":"Create Delegation","openapi":"POST /delegation/create","href":"/api-reference/delegation/create-delegation"},{"title":"List Delegations","openapi":"GET /delegation","href":"/api-reference/delegation/list-delegations"},{"title":"Get Delegation","openapi":"GET /delegation/{delegationId}","href":"/api-reference/delegation/get-delegation"},{"title":"Revoke Delegation","openapi":"DELETE /delegation/{delegationId}","href":"/api-reference/delegation/revoke-delegation"},{"title":"List Delegation Transactions","openapi":"GET /delegation/{delegationId}/transactions","href":"/api-reference/delegation/list-delegation-transactions"}]},{"group":"Router","pages":[{"title":"Mint Payment Credential","openapi":"POST /router/payments","href":"/api-reference/router/mint-payment-credential"},{"title":"Route and Pay a Request","openapi":"POST /router/route","href":"/api-reference/router/route-request"},{"title":"Route and Pay from a Commerce Grant","openapi":"POST /router/commerce/route","href":"/api-reference/router/commerce-route"},{"title":"Quote a Request Before Paying","openapi":"POST /router/quote","href":"/api-reference/router/quote"},{"title":"Quote from a Commerce Grant","openapi":"POST /router/commerce/quote","href":"/api-reference/router/commerce-quote"},{"title":"Call a Service with Subscription Credits","openapi":"POST /router/subscription/route","href":"/api-reference/router/subscription-route"},{"title":"Quote a Call in Subscription Credits","openapi":"POST /router/subscription/quote","href":"/api-reference/router/subscription-quote"},{"title":"Read Your Subscription Credits","openapi":"GET /router/subscription/balance","description":"Your credits left — the whole balance your Nevermined Subscription pays from, free welcome credits included — when the monthly allowance resets, and your plan. Charges nothing. Called in an organization you are an active member of (`X-Current-Org-Id`, or that organization's API key), it reads that organization's subscription instead, never your personal one; organizations can no longer subscribe, so that is `subscribed: false` unless the organization still holds one bought earlier. `subscribed: false` carries no other field; every other field is present exactly when `subscribed` is true.\n\nPersonal API keys only: Nevermined credits and the Nevermined Subscription belong to a personal account, so call with a key that carries no organization tag and without `X-Current-Org-Id`. Of OAuth-minted credentials, only a `commerce` connection the user allowed to spend their Nevermined credits is accepted: another `commerce` connection is refused with `BCK.OAUTH.0037`, one acting in an organization with `BCK.OAUTH.0038`, and any other OAuth credential with `BCK.OAUTH.0030`. For every credit you hold, subscribed or not, by kind and expiry, read `GET /credits/balance`. Where the subscription is not available — on this deployment or to this account — it answers 404 `BCK.SUBSCRIPTION_ACCESS.0001`.","href":"/api-reference/router/subscription-balance"},{"title":"Read Your Credits","openapi":"GET /credits/balance","href":"/api-reference/router/credits-balance"},{"title":"Read the Welcome Credits Offer","openapi":"GET /credits/welcome/offer","description":"The free welcome credits a new account is granted when it signs up with a verified email, and how many days they last. `offer` is `null` while the offer is closed. A non-null offer says what the offer grants, not that a particular sign-up right now will be granted. No authentication; the answer is the same for every caller and may be cached for 5 minutes.","href":"/api-reference/router/welcome-credits-offer"},{"title":"Report Settlement","openapi":"POST /router/payments/{id}/settled","href":"/api-reference/router/report-settlement"},{"title":"List Payments","openapi":"GET /router/payments","href":"/api-reference/router/list-payments"},{"title":"Payments Summary","openapi":"GET /router/payments/summary","href":"/api-reference/router/payments-summary"}]},{"group":"Payment Methods","pages":[{"title":"List Payment Methods","openapi":"GET /payment-methods","href":"/api-reference/payment-methods/list-payment-methods"},{"title":"Update Payment Method","openapi":"PATCH /payment-methods/{paymentMethodId}","href":"/api-reference/payment-methods/update-payment-method"},{"title":"Revoke Payment Method","openapi":"DELETE /payment-methods/{paymentMethodId}","href":"/api-reference/payment-methods/revoke-payment-method"}]},{"group":"Organizations","pages":[{"group":"General","pages":[{"title":"Provision an account for the organization (member or customer)","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/account","href":"/api-reference/organizations/provision-an-account-for-the-organization-member-or-customer"},{"title":"Update organization details","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json put /organizations","href":"/api-reference/organizations/update-organization-details"},{"title":"Get the organization info for a user","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/user-info/{userId}","href":"/api-reference/organizations/get-the-organization-info-for-a-user"},{"title":"Search the members of an organization","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/members","href":"/api-reference/organizations/search-the-members-of-an-organization"},{"title":"List the authenticated user's active org memberships","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/my-memberships","href":"/api-reference/organizations/list-the-authenticated-users-active-org-memberships"},{"title":"Validate that the user may use an org as their workspace context","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/validate","href":"/api-reference/organizations/validate-that-the-user-may-use-an-org-as-their-workspace-context"},{"title":"Remove an organization member","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json delete /organizations/{orgId}/members/{memberId}","href":"/api-reference/organizations/remove-an-organization-member"},{"title":"Change an organization member role","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json patch /organizations/{orgId}/members/{memberId}","href":"/api-reference/organizations/change-an-organization-member-role"},{"title":"Deactivate an organization member","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/members/{memberId}/deactivate","href":"/api-reference/organizations/deactivate-an-organization-member"},{"title":"Reactivate an organization member","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/members/{memberId}/reactivate","href":"/api-reference/organizations/reactivate-an-organization-member"}]},{"group":"Activity","pages":[{"title":"List organization activity events","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/activity","href":"/api-reference/organizations--activity/list-organization-activity-events"}]},{"group":"Analytics","pages":[{"title":"Get revenue breakdown by agent","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/analytics/revenue","href":"/api-reference/organizations--analytics/get-revenue-breakdown-by-agent"},{"title":"Get monthly recurring revenue","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/analytics/mrr","href":"/api-reference/organizations--analytics/get-monthly-recurring-revenue"},{"title":"Get plan consumption","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/analytics/usage","href":"/api-reference/organizations--analytics/get-plan-consumption"},{"title":"Get top customers by spend","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/analytics/customers","href":"/api-reference/organizations--analytics/get-top-customers-by-spend"},{"title":"Get conversion funnel metrics","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/analytics/conversion","href":"/api-reference/organizations--analytics/get-conversion-funnel-metrics"},{"title":"Get per-member credit-burn attribution","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/analytics/credits-by-member","href":"/api-reference/organizations--analytics/get-per-member-credit-burn-attribution"},{"title":"Get a group's Router-rail (crypto) spend","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/analytics/groups/{groupId}/router-spend","href":"/api-reference/organizations--analytics/get-a-groups-router-rail-crypto-spend"}]},{"group":"Billing","pages":[{"title":"Effective tier, caps and feature flags for this org","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/billing/entitlements","href":"/api-reference/organizations--billing/effective-tier-caps-and-feature-flags-for-this-org"},{"title":"Current tier subscription for this org (or null)","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/billing/subscription","href":"/api-reference/organizations--billing/current-tier-subscription-for-this-org-or-null"},{"title":"List Stripe invoices for the org tier subscription","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/billing/invoices","href":"/api-reference/organizations--billing/list-stripe-invoices-for-the-org-tier-subscription"},{"title":"Cancel the org tier subscription at period end","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/billing/cancel","href":"/api-reference/organizations--billing/cancel-the-org-tier-subscription-at-period-end"},{"title":"Downgrade an Enterprise org to Premium without resubscribing","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/billing/downgrade","href":"/api-reference/organizations--billing/downgrade-an-enterprise-org-to-premium-without-resubscribing"},{"title":"Upgrade a Premium org to Enterprise without resubscribing","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/billing/upgrade","href":"/api-reference/organizations--billing/upgrade-a-premium-org-to-enterprise-without-resubscribing"},{"title":"Create a tier-plan Stripe checkout","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/billing/checkout","href":"/api-reference/organizations--billing/create-a-tier-plan-stripe-checkout"},{"title":"List the active hybrid-tier catalog","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/billing/catalog","href":"/api-reference/organizations--billing/list-the-active-hybrid-tier-catalog"}]},{"group":"Customers","pages":[{"title":"List organization customers","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/customers","href":"/api-reference/organizations--customers/list-organization-customers"},{"title":"Org-wide customer aggregations","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/customers/aggregations","href":"/api-reference/organizations--customers/org-wide-customer-aggregations"},{"title":"Export organization customers as CSV","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/customers/export","href":"/api-reference/organizations--customers/export-organization-customers-as-csv"},{"title":"Get an organization customer","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/customers/{customerId}","href":"/api-reference/organizations--customers/get-an-organization-customer"},{"title":"Per-customer aggregations + drill-down series","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/customers/{customerId}/aggregations","href":"/api-reference/organizations--customers/per-customer-aggregations-+-drill-down-series"},{"title":"Per-customer purchase history","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/customers/{customerId}/purchases","href":"/api-reference/organizations--customers/per-customer-purchase-history"},{"title":"Block an organization customer","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/customers/{customerId}/block","href":"/api-reference/organizations--customers/block-an-organization-customer"},{"title":"Unblock an organization customer","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/customers/{customerId}/unblock","href":"/api-reference/organizations--customers/unblock-an-organization-customer"}]},{"group":"Groups \u0026 Budgets","pages":[{"title":"List a group's budgets (one per currency)","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/groups/{groupId}/budgets","href":"/api-reference/groups/list-a-groups-budgets-one-per-currency"},{"title":"Create a per-currency budget for a group","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/groups/{groupId}/budgets","href":"/api-reference/groups/create-a-per-currency-budget-for-a-group"},{"title":"Read a budget's usage for the current period","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/groups/{groupId}/budgets/{budgetId}/usage","href":"/api-reference/groups/read-a-budgets-usage-for-the-current-period"},{"title":"Read one budget by id","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/groups/{groupId}/budgets/{budgetId}","href":"/api-reference/groups/read-one-budget-by-id"},{"title":"Remove one budget by id","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json delete /organizations/{orgId}/groups/{groupId}/budgets/{budgetId}","href":"/api-reference/groups/remove-one-budget-by-id"},{"title":"Update a budget's limit / interval / alert threshold","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json patch /organizations/{orgId}/groups/{groupId}/budgets/{budgetId}","href":"/api-reference/groups/update-a-budgets-limit-interval-alert-threshold"},{"title":"List a group's shared payment methods","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/groups/{groupId}/payment-methods","href":"/api-reference/groups/list-a-groups-shared-payment-methods"},{"title":"Share an enrolled card with a group as a payment method","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/groups/{groupId}/payment-methods","href":"/api-reference/groups/share-an-enrolled-card-with-a-group-as-a-payment-method"},{"title":"Remove a payment method from a group (reverts it to personal)","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json delete /organizations/{orgId}/groups/{groupId}/payment-methods/{id}","href":"/api-reference/groups/remove-a-payment-method-from-a-group-reverts-it-to-personal"},{"title":"List the organization's groups","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/groups","href":"/api-reference/groups/list-the-organizations-groups"},{"title":"Create an organization group","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/groups","href":"/api-reference/groups/create-an-organization-group"},{"title":"Get a group and its members","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/groups/{groupId}","href":"/api-reference/groups/get-a-group-and-its-members"},{"title":"Deactivate a group (soft delete)","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json delete /organizations/{orgId}/groups/{groupId}","href":"/api-reference/groups/deactivate-a-group-soft-delete"},{"title":"Rename or re-describe a group","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json patch /organizations/{orgId}/groups/{groupId}","href":"/api-reference/groups/rename-or-re-describe-a-group"},{"title":"Add an organization member to a group","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/groups/{groupId}/members","href":"/api-reference/groups/add-an-organization-member-to-a-group"},{"title":"Remove a member from a group","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json delete /organizations/{orgId}/groups/{groupId}/members/{memberId}","href":"/api-reference/groups/remove-a-member-from-a-group"}]},{"group":"Agent Discovery","pages":[{"title":"Public llms.txt index for an organization","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/llms.txt","href":"/api-reference/organizations--integration/public-llmstxt-index-for-an-organization"},{"title":"Public agentic instructions for an organization","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/agentic-instructions.md","href":"/api-reference/organizations--integration/public-agentic-instructions-for-an-organization"},{"title":"Public ARD ai-catalog.json for an organization","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/ai-catalog.json","href":"/api-reference/organizations--integration/public-ard-ai-catalogjson-for-an-organization"}]},{"group":"Invitations","pages":[{"title":"List organization invitations","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/invitations","href":"/api-reference/invitations/list-organization-invitations"},{"title":"Invite a teammate by email","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/invitations","href":"/api-reference/invitations/invite-a-teammate-by-email"},{"title":"Revoke an invitation","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/invitations/{id}/revoke","href":"/api-reference/invitations/revoke-an-invitation"},{"title":"Get public info for a pending invitation by token","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/invitations/{token}","href":"/api-reference/invitations/get-public-info-for-a-pending-invitation-by-token"},{"title":"Accept an organization invitation","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/invitations/{token}/accept","href":"/api-reference/invitations/accept-an-organization-invitation"}]},{"group":"Realtime","pages":[{"title":"List the caller's own WebSocket secrets","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/realtime/secrets","href":"/api-reference/organizations--realtime/list-the-callers-own-websocket-secrets"},{"title":"Generate a WebSocket secret","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/realtime/secrets","href":"/api-reference/organizations--realtime/generate-a-websocket-secret"},{"title":"Rotate a WebSocket secret","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/realtime/secrets/{id}/rotate","href":"/api-reference/organizations--realtime/rotate-a-websocket-secret"},{"title":"Revoke a WebSocket secret","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json delete /organizations/{orgId}/realtime/secrets/{id}","href":"/api-reference/organizations--realtime/revoke-a-websocket-secret"}]},{"group":"Wallets","pages":[{"title":"List an org's active stablecoin wallets","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/wallets","href":"/api-reference/organizations--wallets/list-an-orgs-active-stablecoin-wallets"},{"title":"Create an organization stablecoin wallet","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/wallets","href":"/api-reference/organizations--wallets/create-an-organization-stablecoin-wallet"},{"title":"Read one organization wallet by id","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/wallets/{id}","href":"/api-reference/organizations--wallets/read-one-organization-wallet-by-id"},{"title":"Revoke (soft-delete) an organization wallet","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json delete /organizations/{orgId}/wallets/{id}","href":"/api-reference/organizations--wallets/revoke-soft-delete-an-organization-wallet"},{"title":"Rename an organization wallet","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json patch /organizations/{orgId}/wallets/{id}","href":"/api-reference/organizations--wallets/rename-an-organization-wallet"},{"title":"Read a wallet's USDC + EURC balances on the deployment's chain","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/wallets/{id}/balances","href":"/api-reference/organizations--wallets/read-a-wallets-usdc-+-eurc-balances-on-the-deployments-chain"},{"title":"Withdraw stablecoins from an org wallet to a nominated address","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/wallets/{id}/withdraw","href":"/api-reference/organizations--wallets/withdraw-stablecoins-from-an-org-wallet-to-a-nominated-address"},{"title":"Share an org wallet with a group (so it funds the group budget)","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/wallets/{id}/groups/{groupId}","href":"/api-reference/organizations--wallets/share-an-org-wallet-with-a-group-so-it-funds-the-group-budget"},{"title":"Stop a group from drawing on a wallet","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json delete /organizations/{orgId}/wallets/{id}/groups/{groupId}","href":"/api-reference/organizations--wallets/stop-a-group-from-drawing-on-a-wallet"},{"title":"List the org wallets shared with a group (fund its budgets)","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/groups/{groupId}/wallets","href":"/api-reference/organizations--wallets/list-the-org-wallets-shared-with-a-group-fund-its-budgets"},{"title":"List the groups a wallet is shared with","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/wallets/{id}/groups","href":"/api-reference/organizations--wallets/list-the-groups-a-wallet-is-shared-with"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/webhooks","href":"/api-reference/organizations--webhooks/list-webhook-subscriptions"},{"title":"Create a webhook subscription","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/webhooks","href":"/api-reference/organizations--webhooks/create-a-webhook-subscription"},{"title":"Get a webhook subscription","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/webhooks/{id}","href":"/api-reference/organizations--webhooks/get-a-webhook-subscription"},{"title":"Delete a webhook subscription","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json delete /organizations/{orgId}/webhooks/{id}","href":"/api-reference/organizations--webhooks/delete-a-webhook-subscription"},{"title":"Update a webhook subscription","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json patch /organizations/{orgId}/webhooks/{id}","href":"/api-reference/organizations--webhooks/update-a-webhook-subscription"},{"title":"Rotate a webhook signing secret","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/webhooks/{id}/rotate-secret","href":"/api-reference/organizations--webhooks/rotate-a-webhook-signing-secret"},{"title":"List deliveries for a webhook subscription","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/webhooks/{subscriptionId}/deliveries","href":"/api-reference/organizations--webhooks/list-deliveries-for-a-webhook-subscription"},{"title":"Get a webhook delivery record","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json get /organizations/{orgId}/webhooks/deliveries/{deliveryId}","href":"/api-reference/organizations--webhooks/get-a-webhook-delivery-record"},{"title":"Retry a webhook delivery","deprecated":null,"version":null,"openapi":"/api-reference/organizations-openapi.json post /organizations/{orgId}/webhooks/deliveries/{deliveryId}/retry","href":"/api-reference/organizations--webhooks/retry-a-webhook-delivery"}]}]},{"group":"Authentication","pages":[{"group":"Ceremony","pages":[{"title":"Generate an OAuth 2.1 authorization code","deprecated":null,"version":null,"openapi":"/api-reference/oauth-openapi.json post /oauth/authorize","href":"/api-reference/authentication--ceremony/generate-an-oauth-21-authorization-code"},{"title":"Exchange a code, device_code, or refresh_token for a credential","deprecated":null,"version":null,"openapi":"/api-reference/oauth-openapi.json post /oauth/token","href":"/api-reference/authentication--ceremony/exchange-a-code-device_code-or-refresh_token-for-a-credential"},{"title":"RFC 8628 device authorization request","deprecated":null,"version":null,"openapi":"/api-reference/oauth-openapi.json post /oauth/device_authorization","href":"/api-reference/authentication--ceremony/rfc-8628-device-authorization-request"},{"title":"Approve or deny a device authorization","deprecated":null,"version":null,"openapi":"/api-reference/oauth-openapi.json post /oauth/device","href":"/api-reference/authentication--ceremony/approve-or-deny-a-device-authorization"},{"title":"Resolve a user_code to its verification-page details","deprecated":null,"version":null,"openapi":"/api-reference/oauth-openapi.json post /oauth/device/details","href":"/api-reference/authentication--ceremony/resolve-a-user_code-to-its-verification-page-details"},{"title":"Resolve a connect client_id to its display name + eligibility","deprecated":null,"version":null,"openapi":"/api-reference/oauth-openapi.json post /oauth/connect/details","href":"/api-reference/authentication--ceremony/resolve-a-connect-client_id-to-its-display-name-+-eligibility"}]},{"group":"Connections","pages":[{"title":"Revoke a credential (RFC 7009)","deprecated":null,"version":null,"openapi":"/api-reference/oauth-openapi.json post /oauth/revoke","href":"/api-reference/authentication--connections/revoke-a-credential-rfc-7009"},{"title":"List connected agents (AgentBindings) for the signed-in user","deprecated":null,"version":null,"openapi":"/api-reference/oauth-openapi.json get /oauth/bindings","href":"/api-reference/authentication--connections/list-connected-agents-agentbindings-for-the-signed-in-user"},{"title":"Revoke an AgentBinding by id","deprecated":null,"version":null,"openapi":"/api-reference/oauth-openapi.json post /oauth/bindings/{id}/revoke","href":"/api-reference/authentication--connections/revoke-an-agentbinding-by-id"}]},{"group":"Discovery","pages":[{"title":"Authorization Server Metadata (RFC 8414)","deprecated":null,"version":null,"openapi":"/api-reference/oauth-openapi.json get /.well-known/oauth-authorization-server","href":"/api-reference/authentication--discovery/authorization-server-metadata-rfc-8414"},{"title":"Protected Resource Metadata (RFC 9728)","deprecated":null,"version":null,"openapi":"/api-reference/oauth-openapi.json get /.well-known/oauth-protected-resource","href":"/api-reference/authentication--discovery/protected-resource-metadata-rfc-9728"},{"title":"JSON Web Key Set (ES256K / secp256k1)","deprecated":null,"version":null,"openapi":"/api-reference/oauth-openapi.json get /.well-known/jwks.json","href":"/api-reference/authentication--discovery/json-web-key-set-es256k-secp256k1"}]}]}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/api-reference/typescript/installation"}]}]},"title":"Read Your Credits - Nevermined Documentation","buildId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","deploymentId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bg4Z7D_G.js","utils-Biz734EK.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6F9YHs6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BoJjY_VP.js","snippetPresets-CnZ-mOFh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DC_SB2pp.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BYKtOiIP.js","shallow-COAac_UD.js","getApiPlaygroundDisplay-BV4Viqi2.js","CodeSnippet-DDgW-JXl.js","CodeSnippets-CP1LpNhG.js","Page-BeiUfucV.js","getPastedJson-Cvgvbfmv.js","icon-D-H368xH.js","MethodPill-CXSxH1VW.js","DuplicateIcon-JcbBzF1x.js","createIcon-BDt_aHZM.js","DynamicMarkdown-DO1Fz7ar.js","SectionHeading-mwKBArs3.js","axios-vUo_bRtp.js","Markdown-C3KUTGJN.js","clsx-C6CAjViH.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C3vb5JQZ.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C8Hisf3g.js"]}