Read the selected workspace CAD wallet shared across Insights and Signal. Payment methods and automatic funding controls belong to the organization billing console.
Read the selected workspace CAD wallet shared across Insights and Signal. Payment methods and automatic funding controls belong to the organization billing console. All IDs and cursors must belong to the authorized workspace and environment. Required scope: billing:read. Owner authority is required. Related reads can pin snapshot_id from billing summary to reconcile the same as-of state; expired snapshots return 410, never a silent refresh.Examples use synthetic IDs. Replace them with values returned by your environment.
Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.
Read-only lifetime workspace CAD totals as of one snapshot. available_credits = paid_funding_credits + promotional_credits + adjustment_credits - spent_credits - refunded_credits. Sum posted funding/usage/adjustment/final_refund entries; pending payments are excluded. Corrections use signed adjustments. No reserved credits.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"AMLOK","description":"AMLOK documentation, integration guides, data model, and API reference.","colors":{"primary":"#052698","light":"#2567FF","dark":"#1239B0"},"logo":{"light":"https://mintcdn.com/amlok-docs/vYb5LH-5AUaCJz-O/logo/amlok-logo-blue.svg?fit=max\u0026auto=format\u0026n=vYb5LH-5AUaCJz-O\u0026q=85\u0026s=e9395a8f9571d3a71fd68ecf40d9f0fb","dark":"https://mintcdn.com/amlok-docs/vYb5LH-5AUaCJz-O/logo/amlok-logo-white.svg?fit=max\u0026auto=format\u0026n=vYb5LH-5AUaCJz-O\u0026q=85\u0026s=20b048d8a03845d4a48a07c071b975f1","href":"/"},"favicon":{"light":"https://mintcdn.com/amlok-docs/SI95tT9C8WVAHz_k/logo/amlok-blue.svg?fit=max\u0026auto=format\u0026n=SI95tT9C8WVAHz_k\u0026q=85\u0026s=8a89367dc9c1c87d297fccd9bda086db","dark":"https://mintcdn.com/amlok-docs/SI95tT9C8WVAHz_k/logo/amlok-white.svg?fit=max\u0026auto=format\u0026n=SI95tT9C8WVAHz_k\u0026q=85\u0026s=097b549b0731621879cbf1f9fafbb9fd"},"api":{"playground":{"display":"simple"},"examples":{"languages":["bash","python","javascript"]}},"appearance":{"default":"light","strict":false},"background":{"color":{"light":"#FFFFFF"}},"navbar":{"primary":{"type":"button","label":"Get started","href":"/overview/introduction"}},"footer":{"socials":{"github":"https://github.com/amloktech"}},"fonts":{"heading":{"family":"Inter","weight":600},"body":{"family":"Inter"}},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"amlok-docs","hasAudioNarration":false,"actualSubdomain":"amlok-docs","customDomains":["docs.amlok.io"],"gitSource":{"type":"github","owner":"amloktech","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6adb662593b56c4f04af019c"},"chroma":{"latestBuiltDeploymentHistoryId":"6ae8b175a0f23322a3d8c497","collectionId":"2fbaaa6e-d5ef-4a07-b079-7893298aaa29","liveDeploymentHistoryId":"6ae8b175a0f23322a3d8c497","schemaVersion":"v3"},"entitlements":{},"buildId":"6aee3619342f6fdd57962612","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Documentation","count":297},{"language":"default","tag":"Integrations","count":247},{"language":"default","tag":"API Reference","count":84},{"language":"default","tag":"Endpoints","count":54},{"language":"default","tag":"Accounting","count":51},{"language":"default","tag":"Ecommerce","count":51},{"language":"default","tag":"Inventory and ERP","count":51},{"language":"default","tag":"Payments and POS","count":51},{"language":"default","tag":"Research","count":44},{"language":"default","tag":"Lender Systems","count":26}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#navbar .nav-logo{height:24px;width:auto}#amlok-docs-home{--amlok-ink: #101828;--amlok-muted: #536176;--amlok-blue: #052698;--amlok-border: #dce4f1;--amlok-surface: #ffffff;--amlok-art: #f2f6ff;--amlok-grid: rgba(5, 38, 152, .07);max-width:1040px;margin:0 auto;padding:24px 32px 40px;color:var(--amlok-ink)}.dark #amlok-docs-home{--amlok-ink: #f1f5ff;--amlok-muted: #acb9ce;--amlok-blue: #a8c2ff;--amlok-border: #283a56;--amlok-surface: #101b2c;--amlok-art: #122342;--amlok-grid: rgba(148, 180, 255, .08)}#amlok-docs-home .icon{background-color:currentColor}.amlok-home-hero{position:relative;overflow:hidden;isolation:isolate;padding:64px 80px 58px;margin-bottom:36px;text-align:center}.amlok-hero-grid{position:absolute;inset:0;z-index:-1;background-image:linear-gradient(var(--amlok-grid) 1px, transparent 1px), linear-gradient(90deg, var(--amlok-grid) 1px, transparent 1px);background-size:40px 40px;mask-image:radial-gradient(ellipse, #000 5%, transparent 72%)}.amlok-eyebrow{display:block;margin-bottom:20px;color:var(--amlok-blue);font:500 11px/1.5 ui-monospace, monospace;letter-spacing:.14em}#amlok-home-title{margin:0 0 22px;color:var(--amlok-ink);font-size:clamp(36px, 4vw, 52px);line-height:1.08;font-weight:600;letter-spacing:-.045em}.amlok-home-hero>p{max-width:540px;margin:0 auto;color:var(--amlok-muted);font-size:17px;line-height:1.65}.amlok-hero-symbol{position:absolute;z-index:-1;top:88px;color:var(--amlok-blue);opacity:.08}.amlok-hero-symbol-left{left:-10px;transform:rotate(-12deg)}.amlok-hero-symbol-right{right:-10px;transform:rotate(12deg)}.amlok-entry-grid{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:24px}.amlok-entry-card{display:block;overflow:hidden;color:var(--amlok-ink);background:var(--amlok-surface);border:1px solid var(--amlok-border);text-decoration:none!important;transition:border-color .15s ease, box-shadow .15s ease}.amlok-entry-card:hover{border-color:var(--amlok-blue);box-shadow:0 6px 24px rgba(5, 38, 152, .06)}.amlok-entry-card:focus-visible{outline:2px solid #2567ff;outline-offset:5px}.amlok-card-art{position:relative;display:flex;align-items:center;justify-content:center;height:168px;overflow:hidden;color:var(--amlok-blue);border-bottom:1px solid var(--amlok-border);background-color:var(--amlok-art);background-image:linear-gradient(var(--amlok-grid) 1px, transparent 1px), linear-gradient(90deg, var(--amlok-grid) 1px, transparent 1px);background-size:24px 24px}.amlok-icon-plane{display:grid;place-items:center;width:112px;height:112px;border:1px solid var(--amlok-border);background:var(--amlok-surface);box-shadow:8px 8px 0 var(--amlok-grid)}.amlok-card-index{position:absolute;top:16px;left:18px;font:500 9px/1.5 ui-monospace, monospace;letter-spacing:.09em}.amlok-card-cross{position:absolute;bottom:12px;right:18px;font:400 20px/1 ui-monospace, monospace}.amlok-card-copy{padding:24px 26px 26px}.amlok-card-heading{display:flex;align-items:center;justify-content:space-between;gap:16px}.amlok-card-heading h2{margin:0;padding:0;color:var(--amlok-ink);font-size:21px;font-weight:600;line-height:1.35;letter-spacing:-.025em}.amlok-card-heading>span{display:flex;color:var(--amlok-blue)}.amlok-card-copy p{margin:12px 0 0;color:var(--amlok-muted);font-size:15px;line-height:1.65}.amlok-home-signoff{margin:32px 0 0;color:var(--amlok-muted);text-align:center;font-size:12px}@media (max-width: 640px){#amlok-docs-home{padding:8px 20px 32px}.amlok-home-hero{padding:40px 8px 36px;margin-bottom:20px}.amlok-home-hero>p{font-size:16px}.amlok-hero-symbol{display:none}.amlok-entry-grid{grid-template-columns:1fr;gap:20px}.amlok-card-art{height:150px}.amlok-card-copy{padding:20px}}@media (prefers-reduced-motion: reduce){.amlok-entry-card{transition:none}}.amlok-status{--status-ink: #172238;--status-muted: #56647a;--status-blue: #052698;--status-border: #dce4f1;--status-surface: #ffffff;--status-soft: #f5f8fe;--status-active: #146345;--status-active-bg: #eaf7ef;margin:28px 0 36px;color:var(--status-ink);font-size:14px;line-height:1.5}.dark .amlok-status{--status-ink: #edf3ff;--status-muted: #afbdd2;--status-blue: #a8c2ff;--status-border: #2a3c59;--status-surface: #101b2c;--status-soft: #15243c;--status-active: #8ee2b5;--status-active-bg: #16352c}.amlok-status button,.amlok-status input,.amlok-status select{font:inherit}.amlok-status button{cursor:pointer}.amlok-status button:focus-visible,.amlok-status input:focus-visible,.amlok-status select:focus-visible,.amlok-status a:focus-visible{outline:2px solid var(--status-blue);outline-offset:3px}.amlok-status-summary{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));gap:12px;margin-bottom:28px}.amlok-status .amlok-status-metric{display:flex;flex-direction:column;align-items:flex-start;gap:12px;padding:18px 20px;text-align:left;color:var(--status-muted);background:var(--status-surface);border:1px solid var(--status-border);border-radius:10px}.amlok-status .amlok-status-metric>span{display:flex;align-items:center;flex-wrap:wrap;gap:6px;font-size:12px;font-weight:500}.amlok-status .amlok-status-metric strong{color:var(--status-ink);font-size:28px;line-height:1;font-weight:600;letter-spacing:-.035em}.amlok-status .amlok-status-metric:hover,.amlok-status .amlok-status-metric[aria-pressed=\"true\"]{border-color:var(--status-blue);background:var(--status-soft)}.amlok-status-filters{display:grid;grid-template-columns:minmax(0, 2fr) minmax(140px, 1fr) minmax(140px, 1fr);gap:12px}.amlok-status label{display:block;margin-bottom:7px;color:var(--status-ink);font-size:12px;font-weight:500}.amlok-status-search-input{position:relative}.amlok-status-search-input>svg{position:absolute;left:12px;top:13px;color:var(--status-muted);pointer-events:none}.amlok-status input,.amlok-status select{display:block;width:100%;min-width:0;height:44px;color:var(--status-ink);background:var(--status-surface);border:1px solid var(--status-border);border-radius:7px}.amlok-status input{padding:9px 12px 9px 38px}.amlok-status input::placeholder{color:var(--status-muted);opacity:1}.amlok-status select{padding:9px 28px 9px 12px}.amlok-status-results{display:flex;align-items:center;justify-content:space-between;gap:12px;min-height:53px;color:var(--status-muted);font-size:12px}.amlok-status-results p{margin:0}.amlok-status .amlok-status-reset{padding:8px 0;color:var(--status-blue);font-size:12px;font-weight:500;background:transparent;border:0;text-decoration:underline;text-underline-offset:3px}.amlok-status-table-wrap{overflow:hidden;border:1px solid var(--status-border);border-radius:10px;background:var(--status-surface)}.amlok-status table{display:table;width:100%;margin:0;table-layout:fixed;border-collapse:collapse;font-size:13px;line-height:1.5}.amlok-status th,.amlok-status td{padding:17px 18px;text-align:left;vertical-align:middle;border-bottom:1px solid var(--status-border)}.amlok-status thead th{color:var(--status-muted);background:var(--status-soft);font-size:11px;font-weight:600;letter-spacing:.025em}.amlok-status thead th:first-child{width:49%}.amlok-status thead th:nth-child(2){width:23%}.amlok-status thead th:nth-child(3){width:28%}.amlok-status tbody th{font-weight:500}.amlok-status tbody tr:last-child>*{border-bottom:0}.amlok-status tbody tr:hover{background:var(--status-soft)}.amlok-status tbody a{display:inline;color:var(--status-ink);text-decoration:none;overflow-wrap:anywhere}.amlok-status tbody a:hover{color:var(--status-blue);text-decoration:underline;text-underline-offset:3px}.amlok-status tbody a svg{display:inline-block;margin-left:6px;vertical-align:-2px;color:var(--status-muted)}.amlok-status-category{display:block;margin-top:3px;color:var(--status-muted);font-size:11px;font-weight:400}.amlok-status-markets,.amlok-status-badges{display:flex;align-items:center;flex-wrap:wrap;gap:6px}.amlok-status-market{color:var(--status-muted);font-size:11px;padding:2px 6px;border:1px solid var(--status-border);border-radius:4px}.amlok-status-badge{display:inline-flex;align-items:center;gap:6px;padding:3px 8px;border-radius:5px;font-size:11px;font-weight:500;white-space:nowrap}.amlok-status-dot{width:5px;height:5px;border-radius:50%;background:currentColor}.amlok-status-active{color:var(--status-active);background:var(--status-active-bg)}.amlok-status-review{color:var(--status-muted);background:var(--status-soft);border:1px solid var(--status-border)}.amlok-status-roadmap{color:var(--status-blue);background:var(--status-soft)}.amlok-status-progress{color:#805b00;background:#fff5d4}.dark .amlok-status-progress{color:#f4cf7d;background:#3a3018}.amlok-status-beta{display:inline-block;color:var(--status-blue);padding:1px 5px;border:1px solid var(--status-border);border-radius:4px;font-size:10px;line-height:1.5;font-weight:500}.amlok-status .amlok-status-empty{padding:48px 20px;text-align:center}.amlok-status-empty strong,.amlok-status-empty>span{display:block}.amlok-status-empty>span{margin:8px 0;color:var(--status-muted)}.amlok-status-pagination{display:flex;align-items:center;justify-content:space-between;gap:12px;margin-top:16px;color:var(--status-muted);font-size:12px}.amlok-status-pagination>div{display:flex;gap:8px}.amlok-status-pagination button{min-height:36px;padding:7px 13px;color:var(--status-ink);background:var(--status-surface);border:1px solid var(--status-border);border-radius:6px}.amlok-status-pagination button:hover:not(:disabled){border-color:var(--status-blue)}.amlok-status-pagination button:disabled{opacity:.45;cursor:default}.amlok-status-sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;border:0}@media (max-width: 640px){.amlok-status-summary{gap:8px;margin-bottom:22px}.amlok-status .amlok-status-metric{gap:10px;padding:13px 10px}.amlok-status .amlok-status-metric>span{min-height:36px;align-content:center;font-size:11px}.amlok-status .amlok-status-metric strong{font-size:25px}.amlok-status-filters{grid-template-columns:repeat(2, minmax(0, 1fr))}.amlok-status-search{grid-column:1 / -1}.amlok-status th,.amlok-status td{padding:13px 9px}.amlok-status thead th:first-child{width:43%}.amlok-status thead th:nth-child(2){width:25%}.amlok-status thead th:nth-child(3){width:32%}.amlok-status table{font-size:12px}.amlok-status-badge{padding:3px 6px;gap:4px;font-size:10px}}"},{"filePath":"pricing-calculator.css","content":".amlok-pricing-calc{--apc-text: #17233b;--apc-muted: #57657b;--apc-border: #dce4f1;--apc-surface: #fff;--apc-tint: #f4f7ff;--apc-blue: #052698;--apc-error: #b42318;margin:24px 0 36px;color:var(--apc-text);font-size:14px;line-height:1.5}.dark .amlok-pricing-calc{--apc-text: #edf3ff;--apc-muted: #aebbd0;--apc-border: #30405a;--apc-surface: #111c2d;--apc-tint: #162643;--apc-blue: #aac6ff;--apc-error: #ffaca4}.amlok-pricing-calc *{box-sizing:border-box}.amlok-pricing-calc .apc-toolbar{display:flex;align-items:center;justify-content:space-between;gap:16px;margin-bottom:16px}.amlok-pricing-calc .apc-badge{color:var(--apc-muted);font-size:12px;font-weight:600}.amlok-pricing-calc .apc-reset{padding:8px 12px;border:1px solid var(--apc-border);border-radius:8px;color:var(--apc-blue);background:var(--apc-surface);cursor:pointer;font:inherit;font-size:13px}.amlok-pricing-calc .apc-volume-help{margin:0 0 20px;color:var(--apc-muted);font-size:12px}.amlok-pricing-calc .apc-layout{display:grid;grid-template-columns:minmax(0, 1.2fr) minmax(270px, 1fr);gap:24px;align-items:start}.amlok-pricing-calc .apc-inputs{display:grid;gap:16px;min-width:0}.amlok-pricing-calc .apc-panel{border:1px solid var(--apc-border);border-radius:14px;background:var(--apc-surface);overflow:hidden}.amlok-pricing-calc .apc-product-header{padding:18px 20px 14px;border-bottom:1px solid var(--apc-border)}.amlok-pricing-calc .apc-product-toggle{display:flex;align-items:center;gap:10px;font-size:17px;font-weight:650;cursor:pointer}.amlok-pricing-calc input[type=\"checkbox\"]{width:18px;height:18px;accent-color:#052698;flex-shrink:0}.dark .amlok-pricing-calc input[type=\"checkbox\"]{accent-color:#8eafff}.amlok-pricing-calc .apc-product-header p{margin:6px 0 0 28px;color:var(--apc-muted);font-size:12px}.amlok-pricing-calc .apc-tiers{border:0;margin:0;padding:2px 20px;min-width:0}.amlok-pricing-calc .apc-tiers:disabled{opacity:.45}.amlok-pricing-calc .apc-tier{display:grid;grid-template-columns:minmax(0, 1fr) 105px;gap:4px 12px;align-items:center;padding:12px 0}.amlok-pricing-calc .apc-tier+.apc-tier{border-top:1px solid var(--apc-border)}.amlok-pricing-calc .apc-tier label{display:grid;gap:2px}.amlok-pricing-calc .apc-tier label strong{font-weight:600}.amlok-pricing-calc .apc-tier label span{color:var(--apc-muted);font-size:12px}.amlok-pricing-calc .apc-slider-control{grid-column:1 / -1;padding-top:6px;container-type:inline-size}.amlok-pricing-calc input[type=\"range\"]{display:block;appearance:none;-webkit-appearance:none;width:100%;height:28px;margin:0;background:transparent;cursor:pointer}.amlok-pricing-calc input[type=\"range\"]::-webkit-slider-runnable-track{height:6px;border-radius:999px;background:linear-gradient(to right, var(--apc-blue) var(--apc-slider-progress), var(--apc-border) var(--apc-slider-progress))}.amlok-pricing-calc input[type=\"range\"]::-webkit-slider-thumb{appearance:none;-webkit-appearance:none;width:20px;height:20px;margin-top:-7px;border:3px solid var(--apc-surface);border-radius:50%;background:var(--apc-blue);box-shadow:0 0 0 1px var(--apc-blue)}.amlok-pricing-calc input[type=\"range\"]::-moz-range-track{height:6px;border-radius:999px;background:linear-gradient(to right, var(--apc-blue) var(--apc-slider-progress), var(--apc-border) var(--apc-slider-progress))}.amlok-pricing-calc input[type=\"range\"]::-moz-range-thumb{width:14px;height:14px;border:3px solid var(--apc-surface);border-radius:50%;background:var(--apc-blue);box-shadow:0 0 0 1px var(--apc-blue)}.amlok-pricing-calc input[type=\"range\"]:disabled{cursor:not-allowed}.amlok-pricing-calc .apc-slider-labels{position:relative;height:20px;margin:0 10px;color:var(--apc-muted);font-size:clamp(8px, 3.3cqi, 10px);line-height:16px;font-variant-numeric:tabular-nums}.amlok-pricing-calc .apc-slider-labels span{position:absolute;top:0;transform:translateX(-50%);white-space:nowrap}.amlok-pricing-calc input[type=\"number\"]{display:block;width:100%;min-width:0;border:1px solid var(--apc-border);border-radius:8px;padding:9px 10px;color:var(--apc-text);background:var(--apc-surface);font:inherit;font-variant-numeric:tabular-nums}.amlok-pricing-calc input[aria-invalid=\"true\"]{border-color:var(--apc-error)}.amlok-pricing-calc :is(input,button):focus-visible{outline:2px solid #2567ff;outline-offset:3px}.amlok-pricing-calc .apc-error{color:var(--apc-error);font-size:12px;margin:4px 0 0;grid-column:1 / -1}.amlok-pricing-calc .apc-error:empty{display:none}.amlok-pricing-calc .apc-terms{padding:20px}.amlok-pricing-calc .apc-terms h2,.amlok-pricing-calc .apc-summary h2{margin:0 0 16px;font-size:17px;font-weight:650;line-height:1.4}.amlok-pricing-calc .apc-terms-grid{display:grid;gap:18px}.amlok-pricing-calc .apc-terms-grid label{display:block;margin-bottom:6px;font-weight:600}.amlok-pricing-calc .apc-terms-grid p{margin:6px 0 0;font-size:12px;color:var(--apc-muted)}.amlok-pricing-calc .apc-terms-grid .apc-error{color:var(--apc-error)}.amlok-pricing-calc .apc-summary{position:sticky;top:120px;border:1px solid var(--apc-border);border-radius:14px;padding:24px;background:var(--apc-tint);min-width:0}.amlok-pricing-calc .apc-hero-amount{display:grid;gap:5px}.amlok-pricing-calc .apc-hero-amount span{font-size:12px;color:var(--apc-muted)}.amlok-pricing-calc .apc-hero-amount strong{font-size:clamp(24px, 2.3vw, 32px);font-weight:650;letter-spacing:-.035em;color:var(--apc-blue);overflow-wrap:anywhere;font-variant-numeric:tabular-nums}.amlok-pricing-calc .apc-breakdown{display:grid;gap:12px;margin:22px 0}.amlok-pricing-calc .apc-breakdown>div{display:flex;flex-wrap:wrap;justify-content:space-between;gap:3px 12px}.amlok-pricing-calc .apc-breakdown dt{color:var(--apc-muted);font-size:12px}.amlok-pricing-calc .apc-breakdown dd{margin:0;font-size:13px;font-weight:600;font-variant-numeric:tabular-nums}.amlok-pricing-calc .apc-total-row{padding-top:12px;border-top:1px solid var(--apc-border)}.amlok-pricing-calc .apc-total-row dt{color:var(--apc-text);font-weight:600}.amlok-pricing-calc .apc-payment{padding:16px;border:1px solid var(--apc-border);border-radius:10px;background:var(--apc-surface)}.amlok-pricing-calc .apc-payment span{display:block;font-weight:600;font-size:12px}.amlok-pricing-calc .apc-payment strong{display:block;margin-top:4px;font-size:23px;letter-spacing:-.02em;overflow-wrap:anywhere}.amlok-pricing-calc .apc-payment p,.amlok-pricing-calc .apc-footnote,.amlok-pricing-calc .apc-explanation{margin:8px 0 0;color:var(--apc-muted);font-size:12px}.amlok-pricing-calc .apc-footnote{margin-top:16px}.amlok-pricing-calc .apc-invalid-summary{color:var(--apc-muted)}.amlok-pricing-calc .apc-sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border:0}@media (max-width: 760px){.amlok-pricing-calc .apc-layout{grid-template-columns:minmax(0, 1fr);gap:20px}.amlok-pricing-calc .apc-summary{position:static;padding:20px}}@media (prefers-reduced-motion: reduce){.amlok-pricing-calc *{scroll-behavior:auto}}.amlok-pricing-calc .apc-tier .apc-tier-toggle{display:flex;align-items:center;gap:8px;cursor:pointer}.amlok-pricing-calc .apc-tier-heading>span{display:block;margin-left:26px;font-size:12px;color:var(--apc-muted)}.amlok-pricing-calc .apc-tier input:disabled{opacity:.45}"},{"filePath":"brand-guidelines.css","href":"/_mintlify/custom/amlok-docs/f84d35997dc566c5/brand-guidelines.css"}],"page":{"pagePath":"api-reference/endpoints/billing/get-billing-summary","slug":"/api-reference/endpoints/billing/get-billing-summary","pageMetadata":{"title":"Get billing summary","description":"Read the selected workspace CAD wallet shared across Insights and Signal. Payment methods and automatic funding controls belong to the organization billing console.","openapi":"openapi/amlok.json GET /v1/billing/summary","href":"/api-reference/endpoints/billing/get-billing-summary"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Read the selected workspace CAD wallet shared across Insights and Signal. Payment methods and automatic funding controls belong to the organization billing console.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Read the selected workspace CAD wallet shared across Insights and Signal. Payment methods and automatic funding controls belong to the organization billing console. All IDs and cursors must belong to the authorized workspace and environment. Required scope: billing:read. Owner authority is required. Related reads can pin snapshot_id from billing summary to reconcile the same as-of state; expired snapshots return 410, never a silent refresh.`}),`\n`,_jsx(_components.p,{children:`Examples use synthetic IDs. Replace them with values returned by your environment.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get billing summary","description":"Read the selected workspace CAD wallet shared across Insights and Signal. Payment methods and automatic funding controls belong to the organization billing console.","openapi":"openapi/amlok.json GET /v1/billing/summary","href":"/api-reference/endpoints/billing/get-billing-summary"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/amlok-docs/3336037d05644c09/downloads/hub-embed.js"],"openApiReferenceData":{"operation":{"operationId":"getBillingSummary","summary":"Get billing summary","tags":["Billing"],"x-availability":"published_contract","x-required-scopes":["billing:read"],"parameters":[],"responses":{"200":"3905a95e-0eee-42c6-8fd1-023c48ec7d82","400":"bbfb179d-b01d-4665-b506-e4f6e70c17e3","401":"ab6bb507-35c6-42f1-8c17-914cba37dea8","403":"4d6577ab-4e32-491a-b35d-8c44f2363701","404":"22ab0bdb-c3ff-4f05-b125-e91877888c61","409":"bcca6153-ce08-411a-a84d-29330cccb1ea","410":"72ade856-ab22-47e2-b9ba-d7fce76aee37","429":"00c0e25f-827b-4e2d-b3ae-4452391f16dd","503":"a0476568-f260-4bcd-b99e-ce156d1f6e88"},"description":"Read the selected workspace CAD wallet shared across Insights and Signal. Payment methods and automatic funding controls belong to the organization billing console.","security":["9c84c91d-268b-4608-8f88-fac9c25bf9a4"],"x-codeSamples":[{"lang":"Shell","label":"cURL","source":"curl --request GET --fail-with-body --max-time 30 \\\n \"${AMLOK_API_BASE_URL}/v1/billing/summary\" \\\n --header \"Authorization: Bearer ${AMLOK_API_KEY}\" \\\n --header 'Accept: application/json'"},{"lang":"Python","source":"import os\nimport requests\n\nheaders = {'Accept': 'application/json'}\nheaders[\"Authorization\"] = \"Bearer \" + os.environ[\"AMLOK_API_KEY\"]\nresponse = requests.request('GET', os.environ[\"AMLOK_API_BASE_URL\"] + '/v1/billing/summary', headers=headers, timeout=30, allow_redirects=False)\nresponse.raise_for_status()\nprint(response.json())\n"},{"lang":"JavaScript","source":"const headers = {\"Accept\": \"application/json\"};\nheaders.Authorization = `Bearer ${process.env.AMLOK_API_KEY}`;\nconst response = await fetch(process.env.AMLOK_API_BASE_URL + \"/v1/billing/summary\", {\n method: \"GET\", headers, redirect: \"error\", signal: AbortSignal.timeout(30000)\n});\nif (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);\nconsole.log(await response.json());\n"}],"method":"get","type":"path","servers":[],"path":"/v1/billing/summary","baseUrlOptions":[],"title":"Get billing summary","codeSamples":[{"label":"cURL","lang":"Shell","source":"curl --request GET --fail-with-body --max-time 30 \\\n \"${AMLOK_API_BASE_URL}/v1/billing/summary\" \\\n --header \"Authorization: Bearer ${AMLOK_API_KEY}\" \\\n --header 'Accept: application/json'"},{"lang":"Python","source":"import os\nimport requests\n\nheaders = {'Accept': 'application/json'}\nheaders[\"Authorization\"] = \"Bearer \" + os.environ[\"AMLOK_API_KEY\"]\nresponse = requests.request('GET', os.environ[\"AMLOK_API_BASE_URL\"] + '/v1/billing/summary', headers=headers, timeout=30, allow_redirects=False)\nresponse.raise_for_status()\nprint(response.json())\n"},{"lang":"JavaScript","source":"const headers = {\"Accept\": \"application/json\"};\nheaders.Authorization = `Bearer ${process.env.AMLOK_API_KEY}`;\nconst response = await fetch(process.env.AMLOK_API_BASE_URL + \"/v1/billing/summary\", {\n method: \"GET\", headers, redirect: \"error\", signal: AbortSignal.timeout(30000)\n});\nif (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);\nconsole.log(await response.json());\n"}],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"3905a95e-0eee-42c6-8fd1-023c48ec7d82":{"description":"Successful response.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"as_of":{"type":"string","minLength":1,"format":"date-time","description":"As of for BillingSummary. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"data.as_of","typeLabel":"string\u003cdate-time>"},"currency":{"const":"CAD","description":"Currency for BillingSummary. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"data.currency","typeLabel":"any"},"available_credits":{"type":"string","minLength":1,"pattern":"^(?:0|[1-9][0-9]*)\\.[0-9]{2}$","description":"Current spendable CAD credits at the reporting snapshot.","isRequired":true,"uniqueKey":"data.available_credits","typeLabel":"string"},"spent_credits":{"type":"string","minLength":1,"pattern":"^(?:0|[1-9][0-9]*)\\.[0-9]{2}$","description":"Cumulative posted usage deductions in CAD, expressed as a positive total.","isRequired":true,"uniqueKey":"data.spent_credits","typeLabel":"string"},"billing_account_id":{"type":"string","minLength":1,"description":"Opaque identifier, authorized within the API key workspace and environment.","isRequired":true,"uniqueKey":"data.billing_account_id","typeLabel":"string"},"snapshot_id":{"type":"string","minLength":1,"description":"Opaque identifier, authorized within the API key workspace and environment.","isRequired":true,"uniqueKey":"data.snapshot_id","typeLabel":"string"},"paid_funding_credits":{"type":"string","minLength":1,"pattern":"^(?:0|[1-9][0-9]*)\\.[0-9]{2}$","description":"Cumulative posted paid funding credits in CAD; excludes pending or failed payments.","isRequired":true,"uniqueKey":"data.paid_funding_credits","typeLabel":"string"},"promotional_credits":{"type":"string","minLength":1,"pattern":"^(?:0|[1-9][0-9]*)\\.[0-9]{2}$","description":"Cumulative posted promotional credits in CAD.","isRequired":true,"uniqueKey":"data.promotional_credits","typeLabel":"string"},"adjustment_credits":{"type":"string","minLength":1,"pattern":"^-?(?:0|[1-9][0-9]*)\\.[0-9]{2}$","description":"Signed sum of posted corrections and adjustments in CAD.","isRequired":true,"uniqueKey":"data.adjustment_credits","typeLabel":"string"},"refunded_credits":{"type":"string","minLength":1,"pattern":"^(?:0|[1-9][0-9]*)\\.[0-9]{2}$","description":"Cumulative final-refund deductions in CAD, expressed as a positive total.","isRequired":true,"uniqueKey":"data.refunded_credits","typeLabel":"string"},"auto_pay":{"type":"object","properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"data.auto_pay.enabled","typeLabel":"boolean"},"trigger_amount":{"type":"string","minLength":1,"pattern":"^(?:0|[1-9][0-9]*)\\.[0-9]{2}$","isRequired":true,"uniqueKey":"data.auto_pay.trigger_amount","typeLabel":"string"},"top_up_amount":{"type":"string","minLength":1,"pattern":"^(?:0|[1-9][0-9]*)\\.[0-9]{2}$","isRequired":true,"uniqueKey":"data.auto_pay.top_up_amount","typeLabel":"string"}},"required":["enabled","trigger_amount","top_up_amount"],"additionalProperties":false,"description":"Actual read-only portal configuration. Values do not authorize a payment or expose a payment method. Changes are made in the console.","isRequired":true,"uniqueKey":"data.auto_pay","typeLabel":"object"},"snapshot_expires_at":{"type":"string","format":"date-time","description":"Expiry for snapshot_id on related billing reads.","isRequired":true,"uniqueKey":"data.snapshot_expires_at","typeLabel":"string\u003cdate-time>"}},"required":["as_of","currency","available_credits","spent_credits","billing_account_id","snapshot_id","paid_funding_credits","promotional_credits","adjustment_credits","refunded_credits","auto_pay","snapshot_expires_at"],"additionalProperties":false,"description":"Read-only lifetime workspace CAD totals as of one snapshot. available_credits = paid_funding_credits + promotional_credits + adjustment_credits - spent_credits - refunded_credits. Sum posted funding/usage/adjustment/final_refund entries; pending payments are excluded. Corrections use signed adjustments. No reserved credits.","isRequired":true,"uniqueKey":"data","typeLabel":"object"},"meta":{"type":"object","properties":{"request_id":{"type":"string","minLength":1,"description":"Opaque identifier, authorized within the API key workspace and environment.","isRequired":true,"uniqueKey":"meta.request_id","typeLabel":"string"},"schema_version":{"type":"string","minLength":1,"description":"Schema version for Meta. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"meta.schema_version","typeLabel":"string"},"environment":{"type":"string","enum":["sandbox","live"],"description":"Environment for Meta. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"meta.environment","typeLabel":"enum\u003cstring>"}},"required":["request_id","schema_version","environment"],"additionalProperties":false,"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["data","meta"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"data":{"as_of":"2026-11-06T12:00:00Z","currency":"CAD","available_credits":"4935.00","spent_credits":"65.00","billing_account_id":"billing_synthetic","snapshot_id":"snap_synthetic","paid_funding_credits":"5000.00","promotional_credits":"0.00","adjustment_credits":"0.00","refunded_credits":"0.00","auto_pay":{"enabled":false,"trigger_amount":"200.00","top_up_amount":"500.00"},"snapshot_expires_at":"2026-11-06T13:00:00Z"},"meta":{"request_id":"req_synthetic","schema_version":"1.0.0","environment":"sandbox"}},"examples":{"Example":{"title":"Example","value":{"data":{"as_of":"2026-11-06T12:00:00Z","currency":"CAD","available_credits":"4935.00","spent_credits":"65.00","billing_account_id":"billing_synthetic","snapshot_id":"snap_synthetic","paid_funding_credits":"5000.00","promotional_credits":"0.00","adjustment_credits":"0.00","refunded_credits":"0.00","auto_pay":{"enabled":false,"trigger_amount":"200.00","top_up_amount":"500.00"},"snapshot_expires_at":"2026-11-06T13:00:00Z"},"meta":{"request_id":"req_synthetic","schema_version":"1.0.0","environment":"sandbox"}}}},"exampleType":"examples"}},"headers":{"X-Request-ID":{"schema":{"type":"string","minLength":1},"description":"Same request ID as meta.request_id or error.request_id."}},"exampleType":"examples"},"bbfb179d-b01d-4665-b506-e4f6e70c17e3":{"description":"Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["validation_error","unauthenticated","forbidden","not_found","invalid_state","idempotency_conflict","insufficient_credits","precondition_failed","cursor_expired","rate_limited","temporarily_unavailable","deal_snapshot_conflict","payload_too_large","unsupported_media_type","document_rejected","processing_failed","session_expired","consent_purpose_missing","sandbox_only","scenario_not_available","idempotency_result_expired"],"description":"Code for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"description":"Message for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Retryable for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","minLength":1,"description":"Opaque identifier, authorized within the API key workspace and environment.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","minLength":1,"isRequired":true,"uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.field","typeLabel":"string | null"}},"required":["code","message","retryable","request_id","field"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"validation_error","message":"Validation error.","retryable":false,"request_id":"req_synthetic","field":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_error","message":"Validation error.","retryable":false,"request_id":"req_synthetic","field":null}}}},"exampleType":"examples"}},"headers":{"X-Request-ID":{"schema":{"type":"string","minLength":1},"description":"Same request ID as meta.request_id or error.request_id."}},"exampleType":"examples"},"ab6bb507-35c6-42f1-8c17-914cba37dea8":{"description":"Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["validation_error","unauthenticated","forbidden","not_found","invalid_state","idempotency_conflict","insufficient_credits","precondition_failed","cursor_expired","rate_limited","temporarily_unavailable","deal_snapshot_conflict","payload_too_large","unsupported_media_type","document_rejected","processing_failed","session_expired","consent_purpose_missing","sandbox_only","scenario_not_available","idempotency_result_expired"],"description":"Code for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"description":"Message for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Retryable for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","minLength":1,"description":"Opaque identifier, authorized within the API key workspace and environment.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","minLength":1,"isRequired":true,"uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.field","typeLabel":"string | null"}},"required":["code","message","retryable","request_id","field"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"unauthenticated","message":"Unauthenticated.","retryable":false,"request_id":"req_synthetic","field":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthenticated","message":"Unauthenticated.","retryable":false,"request_id":"req_synthetic","field":null}}}},"exampleType":"examples"}},"headers":{"X-Request-ID":{"schema":{"type":"string","minLength":1},"description":"Same request ID as meta.request_id or error.request_id."}},"exampleType":"examples"},"4d6577ab-4e32-491a-b35d-8c44f2363701":{"description":"Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["validation_error","unauthenticated","forbidden","not_found","invalid_state","idempotency_conflict","insufficient_credits","precondition_failed","cursor_expired","rate_limited","temporarily_unavailable","deal_snapshot_conflict","payload_too_large","unsupported_media_type","document_rejected","processing_failed","session_expired","consent_purpose_missing","sandbox_only","scenario_not_available","idempotency_result_expired"],"description":"Code for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"description":"Message for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Retryable for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","minLength":1,"description":"Opaque identifier, authorized within the API key workspace and environment.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","minLength":1,"isRequired":true,"uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.field","typeLabel":"string | null"}},"required":["code","message","retryable","request_id","field"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"forbidden","message":"Forbidden.","retryable":false,"request_id":"req_synthetic","field":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"Forbidden.","retryable":false,"request_id":"req_synthetic","field":null}}}},"exampleType":"examples"}},"headers":{"X-Request-ID":{"schema":{"type":"string","minLength":1},"description":"Same request ID as meta.request_id or error.request_id."}},"exampleType":"examples"},"22ab0bdb-c3ff-4f05-b125-e91877888c61":{"description":"Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["validation_error","unauthenticated","forbidden","not_found","invalid_state","idempotency_conflict","insufficient_credits","precondition_failed","cursor_expired","rate_limited","temporarily_unavailable","deal_snapshot_conflict","payload_too_large","unsupported_media_type","document_rejected","processing_failed","session_expired","consent_purpose_missing","sandbox_only","scenario_not_available","idempotency_result_expired"],"description":"Code for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"description":"Message for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Retryable for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","minLength":1,"description":"Opaque identifier, authorized within the API key workspace and environment.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","minLength":1,"isRequired":true,"uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.field","typeLabel":"string | null"}},"required":["code","message","retryable","request_id","field"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"not_found","message":"Not found.","retryable":false,"request_id":"req_synthetic","field":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"Not found.","retryable":false,"request_id":"req_synthetic","field":null}}}},"exampleType":"examples"}},"headers":{"X-Request-ID":{"schema":{"type":"string","minLength":1},"description":"Same request ID as meta.request_id or error.request_id."}},"exampleType":"examples"},"bcca6153-ce08-411a-a84d-29330cccb1ea":{"description":"Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["validation_error","unauthenticated","forbidden","not_found","invalid_state","idempotency_conflict","insufficient_credits","precondition_failed","cursor_expired","rate_limited","temporarily_unavailable","deal_snapshot_conflict","payload_too_large","unsupported_media_type","document_rejected","processing_failed","session_expired","consent_purpose_missing","sandbox_only","scenario_not_available","idempotency_result_expired"],"description":"Code for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"description":"Message for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Retryable for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","minLength":1,"description":"Opaque identifier, authorized within the API key workspace and environment.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","minLength":1,"isRequired":true,"uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.field","typeLabel":"string | null"}},"required":["code","message","retryable","request_id","field"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"invalid_state","message":"Invalid state.","retryable":false,"request_id":"req_synthetic","field":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_state","message":"Invalid state.","retryable":false,"request_id":"req_synthetic","field":null}}}},"exampleType":"examples"}},"headers":{"X-Request-ID":{"schema":{"type":"string","minLength":1},"description":"Same request ID as meta.request_id or error.request_id."}},"exampleType":"examples"},"72ade856-ab22-47e2-b9ba-d7fce76aee37":{"description":"Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["validation_error","unauthenticated","forbidden","not_found","invalid_state","idempotency_conflict","insufficient_credits","precondition_failed","cursor_expired","rate_limited","temporarily_unavailable","deal_snapshot_conflict","payload_too_large","unsupported_media_type","document_rejected","processing_failed","session_expired","consent_purpose_missing","sandbox_only","scenario_not_available","idempotency_result_expired"],"description":"Code for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"description":"Message for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Retryable for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","minLength":1,"description":"Opaque identifier, authorized within the API key workspace and environment.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","minLength":1,"isRequired":true,"uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.field","typeLabel":"string | null"}},"required":["code","message","retryable","request_id","field"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"cursor_expired","message":"Cursor expired.","retryable":false,"request_id":"req_synthetic","field":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"cursor_expired","message":"Cursor expired.","retryable":false,"request_id":"req_synthetic","field":null}}}},"exampleType":"examples"}},"headers":{"X-Request-ID":{"schema":{"type":"string","minLength":1},"description":"Same request ID as meta.request_id or error.request_id."}},"exampleType":"examples"},"00c0e25f-827b-4e2d-b3ae-4452391f16dd":{"description":"Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["validation_error","unauthenticated","forbidden","not_found","invalid_state","idempotency_conflict","insufficient_credits","precondition_failed","cursor_expired","rate_limited","temporarily_unavailable","deal_snapshot_conflict","payload_too_large","unsupported_media_type","document_rejected","processing_failed","session_expired","consent_purpose_missing","sandbox_only","scenario_not_available","idempotency_result_expired"],"description":"Code for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"description":"Message for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Retryable for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","minLength":1,"description":"Opaque identifier, authorized within the API key workspace and environment.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","minLength":1,"isRequired":true,"uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.field","typeLabel":"string | null"}},"required":["code","message","retryable","request_id","field"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"rate_limited","message":"Rate limited.","retryable":true,"request_id":"req_synthetic","field":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limited","message":"Rate limited.","retryable":true,"request_id":"req_synthetic","field":null}}}},"exampleType":"examples"}},"headers":{"Retry-After":{"description":"Minimum delay in seconds before retry.","schema":{"type":"integer","minimum":0}},"X-Request-ID":{"schema":{"type":"string","minLength":1},"description":"Same request ID as meta.request_id or error.request_id."}},"exampleType":"examples"},"a0476568-f260-4bcd-b99e-ce156d1f6e88":{"description":"Inspect structured error; retry only when retryable. 429 and 503 can include Retry-After.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["validation_error","unauthenticated","forbidden","not_found","invalid_state","idempotency_conflict","insufficient_credits","precondition_failed","cursor_expired","rate_limited","temporarily_unavailable","deal_snapshot_conflict","payload_too_large","unsupported_media_type","document_rejected","processing_failed","session_expired","consent_purpose_missing","sandbox_only","scenario_not_available","idempotency_result_expired"],"description":"Code for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","minLength":1,"description":"Message for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Retryable for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","minLength":1,"description":"Opaque identifier, authorized within the API key workspace and environment.","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"field":{"oneOf":[{"type":"string","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","minLength":1,"isRequired":true,"uniqueKey":"error.field.oneOf.0","typeLabel":"string"},{"type":"null","description":"Field for Error. Constraints, requiredness and allowed values are defined by this schema.","isRequired":true,"uniqueKey":"error.field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.field","typeLabel":"string | null"}},"required":["code","message","retryable","request_id","field"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"temporarily_unavailable","message":"Temporarily unavailable.","retryable":true,"request_id":"req_synthetic","field":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"temporarily_unavailable","message":"Temporarily unavailable.","retryable":true,"request_id":"req_synthetic","field":null}}}},"exampleType":"examples"}},"headers":{"Retry-After":{"description":"Minimum delay in seconds before retry.","schema":{"type":"integer","minimum":0}},"X-Request-ID":{"schema":{"type":"string","minLength":1},"description":"Same request ID as meta.request_id or error.request_id."}},"exampleType":"examples"}},"security":{"9c84c91d-268b-4608-8f88-fac9c25bf9a4":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API key","description":"Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API key","description":"Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi/amlok.json"},"subdomain":"amlok-docs","siteName":"AMLOK","title":"Get billing summary - AMLOK","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T19:29:18.422Z","originalFileLocation":"api-reference/endpoints/billing/get-billing-summary.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=\"Read the selected workspace CAD wallet shared across Insights and Signal. Payment methods and automatic funding controls belong to the organization billing console.\">\u003cmeta data-mint-head name=\"application-name\" content=\"AMLOK\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/amlok-docs/j-WOjPp62X_FVp2S/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/amlok-docs/j-WOjPp62X_FVp2S/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/amlok-docs/j-WOjPp62X_FVp2S/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/amlok-docs/j-WOjPp62X_FVp2S/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/amlok-docs/j-WOjPp62X_FVp2S/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/amlok-docs/j-WOjPp62X_FVp2S/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/amlok-docs/j-WOjPp62X_FVp2S/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/amlok-docs/j-WOjPp62X_FVp2S/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/amlok-docs/j-WOjPp62X_FVp2S/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get billing summary - AMLOK\">\u003cmeta data-mint-head property=\"og:description\" content=\"Read the selected workspace CAD wallet shared across Insights and Signal. Payment methods and automatic funding controls belong to the organization billing console.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AMLOK\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.amlok.io/api-reference/endpoints/billing/get-billing-summary\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://amlok-docs.mintlify.site/_mintlify/api/og/v2?division=Billing\u0026amp;title=Get+billing+summary\u0026amp;description=Read+the+selected+workspace+CAD+wallet+shared+across+Insights+and+Signal.+Payment+methods+and+automatic+funding+controls+belong+to+the+organization+billing+cons\u0026amp;theme=949f968aaee92935c279d71e\u0026amp;signature=c0e5543082aedb9b162616498fb024dcbcb9805c5fd7741ecfc03f42208267ac\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get billing summary - AMLOK\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Read the selected workspace CAD wallet shared across Insights and Signal. Payment methods and automatic funding controls belong to the organization billing console.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://amlok-docs.mintlify.site/_mintlify/api/og/v2?division=Billing\u0026amp;title=Get+billing+summary\u0026amp;description=Read+the+selected+workspace+CAD+wallet+shared+across+Insights+and+Signal.+Payment+methods+and+automatic+funding+controls+belong+to+the+organization+billing+cons\u0026amp;theme=949f968aaee92935c279d71e\u0026amp;signature=c0e5543082aedb9b162616498fb024dcbcb9805c5fd7741ecfc03f42208267ac\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/amlok-docs/j-WOjPp62X_FVp2S/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"AMLOK\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#052698\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.amlok.io/api-reference/endpoints/billing/get-billing-summary\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/billing/get-billing-summary.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.amlok.io/#organization\",\"name\":\"AMLOK\",\"url\":\"https://docs.amlok.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/amlok-docs/vYb5LH-5AUaCJz-O/logo/amlok-logo-blue.svg?fit=max\u0026auto=format\u0026n=vYb5LH-5AUaCJz-O\u0026q=85\u0026s=e9395a8f9571d3a71fd68ecf40d9f0fb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.amlok.io#website\",\"name\":\"AMLOK\",\"url\":\"https://docs.amlok.io\",\"publisher\":{\"@id\":\"https://docs.amlok.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.amlok.io/api-reference/endpoints/billing/get-billing-summary#webpage\",\"url\":\"https://docs.amlok.io/api-reference/endpoints/billing/get-billing-summary\",\"name\":\"Get billing summary\",\"description\":\"Read the selected workspace CAD wallet shared across Insights and Signal. Payment methods and automatic funding controls belong to the organization billing console.\",\"dateModified\":\"2026-11-06T19:29:18.422Z\",\"isPartOf\":{\"@id\":\"https://docs.amlok.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.amlok.io/api-reference/endpoints/billing/get-billing-summary#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.amlok.io/api-reference/endpoints/billing/get-billing-summary#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.amlok.io/api-reference/endpoints/borrowers/create-borrower\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get billing summary\",\"item\":\"https://docs.amlok.io/api-reference/endpoints/billing/get-billing-summary\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.amlok.io/api-reference/endpoints/billing/get-billing-summary#apireference\",\"headline\":\"Get billing summary\",\"name\":\"Get billing summary\",\"description\":\"Read the selected workspace CAD wallet shared across Insights and Signal. Payment methods and automatic funding controls belong to the organization billing console.\",\"url\":\"https://docs.amlok.io/api-reference/endpoints/billing/get-billing-summary\",\"mainEntityOfPage\":{\"@id\":\"https://docs.amlok.io/api-reference/endpoints/billing/get-billing-summary#webpage\"},\"dateModified\":\"2026-11-06T19:29:18.422Z\",\"publisher\":{\"@id\":\"https://docs.amlok.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.amlok.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"AMLOK\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"AMLOK","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Start here","pages":[{"title":"API overview","sidebarTitle":"Overview","href":"/api-reference/overview"},{"title":"Contract and implementation status","sidebarTitle":"Contract and implementation status","href":"/api-reference/implementation-status"},{"title":"Connect a borrower and request underwriting","sidebarTitle":"Quickstart","href":"/api-reference/quickstart"},{"title":"Run the complete integration example","sidebarTitle":"Runnable example","href":"/api-reference/runnable-example"},{"title":"Authentication and access","sidebarTitle":"Authentication","href":"/api-reference/authentication"},{"title":"Sandbox and Live","sidebarTitle":"Environments","href":"/api-reference/environments"},{"title":"Specifications and integration downloads","sidebarTitle":"Downloads","href":"/api-reference/downloads"}]},{"group":"Product guides","pages":[{"title":"Embed the Integrations Hub","sidebarTitle":"Embed the Integrations Hub","href":"/api-reference/integration-hub"},{"title":"Lending products, policies and configuration","sidebarTitle":"Lending configuration","href":"/api-reference/configuration"},{"title":"Retrieve collected and enriched borrower data","sidebarTitle":"Retrieve collected and enriched borrower data","href":"/api-reference/data-access"},{"title":"Read a risk package","sidebarTitle":"Risk packages","href":"/api-reference/risk-package"},{"title":"Monitor funded deals with Signal","sidebarTitle":"Signal monitoring","href":"/api-reference/monitoring-design"},{"title":"Send funded-deal updates","sidebarTitle":"Send funded-deal updates","href":"/api-reference/deal-inputs"},{"title":"Retrieve records, reports and source files","sidebarTitle":"Evidence","href":"/api-reference/evidence-traceability"},{"title":"Upload and download documents","sidebarTitle":"Documents","href":"/api-reference/documents"}]},{"group":"Endpoints","pages":[{"group":"Borrowers","icon":"users","expanded":false,"pages":[{"title":"Create borrower","openapi":"openapi/amlok.json POST /v1/borrowers","href":"/api-reference/endpoints/borrowers/create-borrower"},{"title":"List borrowers","openapi":"openapi/amlok.json GET /v1/borrowers","href":"/api-reference/endpoints/borrowers/list-borrower"},{"title":"Get borrower","openapi":"openapi/amlok.json GET /v1/borrowers/{id}","href":"/api-reference/endpoints/borrowers/get-borrower"}]},{"group":"Connections","icon":"plug","expanded":false,"pages":[{"title":"Create embedding session","openapi":"openapi/amlok.json POST /v1/embedding-sessions","href":"/api-reference/endpoints/connections/create-embedding-session"},{"title":"Get embedding session","openapi":"openapi/amlok.json GET /v1/embedding-sessions/{id}","href":"/api-reference/endpoints/connections/get-embedding-session"},{"title":"List connections","openapi":"openapi/amlok.json GET /v1/connections","href":"/api-reference/endpoints/connections/list-connections"},{"title":"Get connection","openapi":"openapi/amlok.json GET /v1/connections/{id}","href":"/api-reference/endpoints/connections/get-connection"},{"title":"Get consent","openapi":"openapi/amlok.json GET /v1/consents/{id}","href":"/api-reference/endpoints/connections/get-consent"},{"title":"Revoke consent","openapi":"openapi/amlok.json POST /v1/consents/{id}/revoke","href":"/api-reference/endpoints/connections/revoke-consent"}]},{"group":"Configuration","icon":"sliders-horizontal","expanded":false,"pages":[{"title":"Create lending product version","openapi":"openapi/amlok.json POST /v1/lending-product-versions","href":"/api-reference/endpoints/configuration/create-lending-product-version"},{"title":"List lending product versions","openapi":"openapi/amlok.json GET /v1/lending-product-versions","href":"/api-reference/endpoints/configuration/list-lending-product-version"},{"title":"Get lending product version","openapi":"openapi/amlok.json GET /v1/lending-product-versions/{id}","href":"/api-reference/endpoints/configuration/get-lending-product-version"},{"title":"Create risk policy version","openapi":"openapi/amlok.json POST /v1/risk-policy-versions","href":"/api-reference/endpoints/configuration/create-risk-policy-version"},{"title":"List risk policy versions","openapi":"openapi/amlok.json GET /v1/risk-policy-versions","href":"/api-reference/endpoints/configuration/list-risk-policy-version"},{"title":"Get risk policy version","openapi":"openapi/amlok.json GET /v1/risk-policy-versions/{id}","href":"/api-reference/endpoints/configuration/get-risk-policy-version"},{"title":"Get configuration","openapi":"openapi/amlok.json GET /v1/configuration","href":"/api-reference/endpoints/configuration/get-configuration"}]},{"group":"Insights","icon":"files","expanded":true,"pages":[{"title":"Create origination","openapi":"openapi/amlok.json POST /v1/originations","href":"/api-reference/endpoints/insights/create-origination"},{"title":"List originations","openapi":"openapi/amlok.json GET /v1/originations","href":"/api-reference/endpoints/insights/list-origination"},{"title":"Get origination","openapi":"openapi/amlok.json GET /v1/originations/{id}","href":"/api-reference/endpoints/insights/get-origination"}]},{"group":"Results","icon":"file-search","expanded":false,"pages":[{"title":"Get risk package","openapi":"openapi/amlok.json GET /v1/risk-packages/{id}","href":"/api-reference/endpoints/results/get-risk-package"}]},{"group":"Signal","icon":"activity","expanded":false,"pages":[{"title":"Create monitor","openapi":"openapi/amlok.json POST /v1/monitors","href":"/api-reference/endpoints/signal/create-monitor"},{"title":"List monitors","openapi":"openapi/amlok.json GET /v1/monitors","href":"/api-reference/endpoints/signal/list-monitor"},{"title":"Get monitor","openapi":"openapi/amlok.json GET /v1/monitors/{id}","href":"/api-reference/endpoints/signal/get-monitor"},{"title":"Update monitor","openapi":"openapi/amlok.json PATCH /v1/monitors/{id}","href":"/api-reference/endpoints/signal/update-monitor"},{"title":"List monitoring runs","openapi":"openapi/amlok.json GET /v1/monitoring-runs","href":"/api-reference/endpoints/signal/list-monitoring-runs"},{"title":"Get monitoring run","openapi":"openapi/amlok.json GET /v1/monitoring-runs/{id}","href":"/api-reference/endpoints/signal/get-monitoring-run"},{"title":"List alerts","openapi":"openapi/amlok.json GET /v1/alerts","href":"/api-reference/endpoints/signal/list-alerts"},{"title":"Get alert","openapi":"openapi/amlok.json GET /v1/alerts/{id}","href":"/api-reference/endpoints/signal/get-alert"},{"title":"Create deal snapshot","openapi":"openapi/amlok.json POST /v1/monitors/{id}/deal-snapshots","href":"/api-reference/endpoints/signal/create-deal-snapshot"},{"title":"List deal snapshots","openapi":"openapi/amlok.json GET /v1/monitors/{id}/deal-snapshots","href":"/api-reference/endpoints/signal/list-deal-snapshots"},{"title":"Get deal snapshot","openapi":"openapi/amlok.json GET /v1/deal-snapshots/{id}","href":"/api-reference/endpoints/signal/get-deal-snapshot"}]},{"group":"Data","icon":"database","expanded":false,"pages":[{"title":"List data records","openapi":"openapi/amlok.json GET /v1/data/records","href":"/api-reference/endpoints/data/list-data-records"},{"title":"Get data record","openapi":"openapi/amlok.json GET /v1/data/records/{id}","href":"/api-reference/endpoints/data/get-data-record"},{"title":"List data changes","openapi":"openapi/amlok.json GET /v1/data/changes","href":"/api-reference/endpoints/data/list-data-changes"}]},{"group":"Evidence","icon":"database","expanded":false,"pages":[{"title":"Upload document","openapi":"openapi/amlok.json POST /v1/documents","href":"/api-reference/endpoints/evidence/upload-document"},{"title":"Get document","openapi":"openapi/amlok.json GET /v1/documents/{id}","href":"/api-reference/endpoints/evidence/get-document"},{"title":"Download document","openapi":"openapi/amlok.json POST /v1/documents/{id}/download-links","href":"/api-reference/endpoints/evidence/download-document"},{"title":"List evidence","openapi":"openapi/amlok.json GET /v1/evidence","href":"/api-reference/endpoints/evidence/list-evidence"},{"title":"Get evidence","openapi":"openapi/amlok.json GET /v1/evidence/{id}","href":"/api-reference/endpoints/evidence/get-evidence"},{"title":"List documents","openapi":"openapi/amlok.json GET /v1/documents","href":"/api-reference/endpoints/evidence/list-documents"}]},{"group":"Events","icon":"webhook","expanded":false,"pages":[{"title":"List events","openapi":"openapi/amlok.json GET /v1/events","href":"/api-reference/endpoints/events/list-events"},{"title":"Get event","openapi":"openapi/amlok.json GET /v1/events/{id}","href":"/api-reference/endpoints/events/get-event"},{"title":"List deliveries","openapi":"openapi/amlok.json GET /v1/webhook-deliveries","href":"/api-reference/endpoints/events/list-deliveries"},{"title":"Replay event","openapi":"openapi/amlok.json POST /v1/webhook-replays","href":"/api-reference/endpoints/events/replay-event"}]},{"group":"Exports","icon":"download","expanded":false,"pages":[{"title":"Create export","openapi":"openapi/amlok.json POST /v1/exports","href":"/api-reference/endpoints/exports/create-export"},{"title":"Get export","openapi":"openapi/amlok.json GET /v1/exports/{id}","href":"/api-reference/endpoints/exports/get-export"},{"title":"Download export","description":"Download export.","openapi":"openapi/amlok.json POST /v1/exports/{id}/download-links","href":"/api-reference/endpoints/exports/download-export"}]},{"group":"Billing","icon":"wallet","expanded":false,"pages":[{"title":"Get billing summary","openapi":"openapi/amlok.json GET /v1/billing/summary","href":"/api-reference/endpoints/billing/get-billing-summary"},{"title":"List billing transactions","description":"Read immutable workspace funding, usage, adjustment and final-refund entries. Use typed billing exports for detailed statements, workload and historical rates.","openapi":"openapi/amlok.json GET /v1/billing/transactions","href":"/api-reference/endpoints/billing/list-billing-transactions"},{"title":"Get billing transaction","openapi":"openapi/amlok.json GET /v1/billing/transactions/{id}","href":"/api-reference/endpoints/billing/get-billing-transaction"},{"title":"List billing payments","openapi":"openapi/amlok.json GET /v1/billing/payments","href":"/api-reference/endpoints/billing/list-billing-payments"},{"title":"Get billing payment","openapi":"openapi/amlok.json GET /v1/billing/payments/{id}","href":"/api-reference/endpoints/billing/get-billing-payment"},{"title":"List billing usage","openapi":"openapi/amlok.json GET /v1/billing/usage","href":"/api-reference/endpoints/billing/list-billing-usage"},{"title":"Get billing usage","openapi":"openapi/amlok.json GET /v1/billing/usage/{id}","href":"/api-reference/endpoints/billing/get-billing-usage"}]},{"group":"Reliability","icon":"shield-check","expanded":false,"pages":[{"title":"Lookup request receipt","openapi":"openapi/amlok.json GET /v1/request-receipts/lookup","href":"/api-reference/endpoints/reliability/lookup-request-receipt"},{"title":"Healthcheck","openapi":"openapi/amlok.json GET /v1/healthcheck","href":"/api-reference/endpoints/reliability/healthcheck"},{"title":"Service status","openapi":"openapi/amlok.json GET /v1/service-status","href":"/api-reference/endpoints/reliability/service-status"}]}]},{"group":"Integration behavior","pages":[{"title":"Response format","sidebarTitle":"Response format","href":"/api-reference/response-format"},{"title":"Processing states and recovery","sidebarTitle":"Product lifecycle","href":"/api-reference/processing-lifecycle"},{"title":"Pagination and event recovery","sidebarTitle":"Pagination","href":"/api-reference/pagination"},{"title":"Idempotency and accepted commands","sidebarTitle":"Idempotency","href":"/api-reference/idempotency"},{"title":"Recover a timed-out request","sidebarTitle":"Request recovery","href":"/api-reference/request-recovery"},{"title":"Recover source connections","sidebarTitle":"Connection recovery","href":"/api-reference/connection-recovery"},{"title":"Webhooks and signatures","sidebarTitle":"Webhooks and signatures","href":"/api-reference/webhooks"},{"title":"Public event catalog","sidebarTitle":"Public event catalog","href":"/api-reference/event-catalog"},{"title":"Troubleshoot and replay webhook delivery","sidebarTitle":"Delivery recovery","href":"/api-reference/webhook-operations"},{"title":"Errors and safe retries","sidebarTitle":"Errors and safe retries","href":"/api-reference/errors"},{"title":"Rate limits and polling","sidebarTitle":"Rate limits","href":"/api-reference/rate-limits"},{"title":"Run reproducible Sandbox scenarios","sidebarTitle":"Sandbox journeys","href":"/api-reference/sandbox-journeys"},{"title":"Discover operating limits","sidebarTitle":"Discover operating limits","href":"/api-reference/operating-profile"},{"title":"Verify an integration before release","sidebarTitle":"Acceptance checklist","href":"/api-reference/integration-acceptance"}]},{"group":"Billing and exports","pages":[{"title":"Shared wallet and billing reports","sidebarTitle":"Wallet and billing","href":"/api-reference/credit-reporting"},{"title":"Insights and Signal consumption","sidebarTitle":"Consumption","href":"/api-reference/consumption-reporting"},{"title":"Workload and complexity reporting","sidebarTitle":"Workload","href":"/api-reference/workload-reporting"},{"title":"Exports and file formats","sidebarTitle":"Export formats","href":"/api-reference/export-formats"}]},{"group":"API design","pages":[{"title":"API compatibility and release rules","sidebarTitle":"Versioning","href":"/api-reference/versioning"},{"title":"Institution API completeness review","sidebarTitle":"Simplification review","href":"/api-reference/api-review"},{"title":"Contract change log","sidebarTitle":"Contract change log","href":"/api-reference/contract-changelog"}]}]},{"tab":"Research","icon":"flask-conical","pages":[{"title":"Research","href":"/research"}]}]},"basePath":"","title":"Get billing summary - AMLOK","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}