Answers the five steps on the dashboard’s Get started page, so a coding agent can see where setup stands without the dashboard. A Sandbox or Live key gets the same answer. Needs the Catalog permission at Read.
agentConnectedAt: when a Sandbox key first made a request. The dashboard shows “Agent connected” from then on.
plans, customer, usage: a paid plan, a customer, and a check or track exist in the Sandbox. Setting up with a coding agent is done when plans is.
live.activated: Go to production is done and Live takes real payments.
live.missing: the production steps left: stripe_connection and webhook (a live Stripe account Ledger can receive events from), catalog_sync (a paid plan in Live, every one synced to Stripe) and api_key (a Live key). Deploy walks through them.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ledger","description":"Ledger, credit billing for your application: plans, credit packs and usage metering on top of Stripe.","colors":{"primary":"#1a1816","light":"#93a7f0","dark":"#1a1816"},"logo":{"light":"https://mintcdn.com/the-monetization-company/ahIz9sTI-PocTQyT/logo/light.svg?fit=max\u0026auto=format\u0026n=ahIz9sTI-PocTQyT\u0026q=85\u0026s=0a7860016a3760c9689ef39ab2ac2124","dark":"https://mintcdn.com/the-monetization-company/ahIz9sTI-PocTQyT/logo/dark.svg?fit=max\u0026auto=format\u0026n=ahIz9sTI-PocTQyT\u0026q=85\u0026s=de2eab69b7e0583b7bd0d45b76fd4832","href":"https://www.integrateledger.com"},"favicon":"https://mintcdn.com/the-monetization-company/ahIz9sTI-PocTQyT/favicon.svg?fit=max\u0026auto=format\u0026n=ahIz9sTI-PocTQyT\u0026q=85\u0026s=4893a209e521556cd21337856127c081","api":{"openapi":"openapi.json","playground":{"display":"simple"},"examples":{"languages":["curl","typescript","python"],"autogenerate":false}},"appearance":{"default":"light","strict":true},"background":{"color":{"light":"#ffffff","dark":"#1a1816"}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.integrateledger.com"}},"footer":{"links":[{"header":"Ledger","items":[{"label":"Dashboard","href":"https://dashboard.integrateledger.com"},{"label":"Terms of Service","href":"/terms"},{"label":"Merchant Terms","href":"/merchant-terms"},{"label":"Privacy Policy","href":"/privacy"},{"label":"Data Processing Addendum","href":"/dpa"}]},{"header":"SDKs","items":[{"label":"TypeScript on npm","href":"https://www.npmjs.com/package/integrateledger"},{"label":"Python on PyPI","href":"https://pypi.org/project/integrateledger"}]}]},"fonts":{"family":"IBM Plex Sans","weight":400},"icons":{"library":"lucide"},"styling":{"eyebrows":"section","codeblocks":"system","latex":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode","download-spec"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"the-monetization-company","hasAudioNarration":false,"actualSubdomain":"the-monetization-company","customDomains":["docs.integrateledger.com"],"gitSource":{"type":"github","owner":"tmc-ledger","repo":"ledger","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":"","_id":"6ae2d50fa009304b407da8cc"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af1ad0c2da007b7b71d26a5","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API reference","count":42},{"language":"default","tag":"Documentation","count":31},{"language":"default","tag":"Customers","count":14},{"language":"default","tag":"Resources","count":10},{"language":"default","tag":"Billing","count":7},{"language":"default","tag":"Configure pricing","count":6},{"language":"default","tag":"Credit packs","count":5},{"language":"default","tag":"Features","count":5},{"language":"default","tag":"Plans","count":5},{"language":"default","tag":"Webhooks","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F63fjptAgt5VM-kVkqdyU8n1iIq129k.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F63fjptAgt5VM-kVkqdyU8n1isq129k.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* vietnamese */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F63fjptAgt5VM-kVkqdyU8n1iAq129k.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F63fjptAgt5VM-kVkqdyU8n1iEq129k.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F63fjptAgt5VM-kVkqdyU8n1i8q1w.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F6qfjptAgt5VM-kVkqdyU8n3twJwl1FgtIU.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F6qfjptAgt5VM-kVkqdyU8n3twJwlRFgtIU.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* vietnamese */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F6qfjptAgt5VM-kVkqdyU8n3twJwl9FgtIU.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F6qfjptAgt5VM-kVkqdyU8n3twJwl5FgtIU.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F6qfjptAgt5VM-kVkqdyU8n3twJwlBFgg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n:root{--ldg-text: #1a1816;--ldg-text-secondary: #3d3934;--ldg-text-muted: #555049;--ldg-text-subtle: #6b655c;--ldg-border: #e7e4de;--ldg-border-strong: #dbd7cf;--ldg-canvas: #f7f6f3;--ldg-surface-muted: #f0eeea;--ldg-accent-text: #1d36a0;--ldg-accent-border: #bfcbf7;--ldg-accent-subtle: #eff2fd;--ldg-focus: #2443c4;--ldg-warning-bg: #fff7e8;--ldg-warning-border: #f3d9a4;--ldg-danger-bg: #fdf1f0;--ldg-danger-border: #f4cac6}#content-area,#content-area p,#content-area li,#content-area td{color:var(--ldg-text-secondary)}#content-area h1,#content-area h2,#content-area h3,#content-area h4,#content-area strong,#content-area th{color:var(--ldg-text)}#sidebar .sidebar-group-header,#sidebar .sidebar-group-header .sidebar-title{font-weight:600;color:var(--ldg-text)}#content-area a.link,#content-area p a,#content-area li a,#content-area td a{color:var(--ldg-accent-text);text-decoration:underline;text-decoration-color:var(--ldg-accent-border);text-underline-offset:3px;border-bottom:0}#content-area a.link:hover,#content-area p a:hover,#content-area li a:hover,#content-area td a:hover{text-decoration-color:currentColor}code,pre,kbd,samp{font-family:\"IBM Plex Mono\", ui-monospace, SFMono-Regular, Menlo, monospace!important}#content-area :not(pre)>code,#content-area span>code{border-color:var(--ldg-border);background:var(--ldg-surface-muted);color:var(--ldg-text)}#content-area .code-block,#content-area .code-group{border-color:var(--ldg-border);box-shadow:none}#content-area .card{border-color:var(--ldg-border);border-radius:8px;box-shadow:none}#content-area .card:hover{border-color:var(--ldg-border-strong)}#content-area table{font-variant-numeric:tabular-nums}#content-area thead th{background:var(--ldg-canvas);font-weight:500}#content-area .mermaid,#content-area [data-component-part=\"mermaid\"]{padding:16px;border:1px solid var(--ldg-border);border-radius:8px;background:#ffffff}a:focus-visible,button:focus-visible,input:focus-visible{outline:2px solid var(--ldg-focus);outline-offset:2px}"}],"page":{"pagePath":"api-reference/setup/status","slug":"/api-reference/setup/status","pageMetadata":{"title":"Get setup status","description":"Where the workspace is in Get started, the same steps the dashboard shows.","openapi":"openapi.json GET /v1/setup","href":"/api-reference/setup/status"},"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: \"Where the workspace is in Get started, the same steps the dashboard shows.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Answers the five steps on the dashboard’s `,_jsx(_components.strong,{children:`Get started`}),` page, so a coding agent can see where setup stands without the dashboard. A Sandbox or Live key gets the same answer. Needs the `,_jsx(_components.strong,{children:`Catalog`}),` permission at Read.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`agentConnectedAt`}),`: when a Sandbox key first made a request. The dashboard shows “Agent connected” from then on.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`plans`}),`, `,_jsx(_components.code,{children:`customer`}),`, `,_jsx(_components.code,{children:`usage`}),`: a paid plan, a customer, and a check or track exist in the Sandbox. Setting up with a coding agent is done when `,_jsx(_components.code,{children:`plans`}),` is.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`live.activated`}),`: Go to production is done and Live takes real payments.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`live.missing`}),`: the production steps left: `,_jsx(_components.code,{children:`stripe_connection`}),` and `,_jsx(_components.code,{children:`webhook`}),` (a live Stripe account Ledger can receive events from), `,_jsx(_components.code,{children:`catalog_sync`}),` (a paid plan in Live, every one synced to Stripe) and `,_jsx(_components.code,{children:`api_key`}),` (a Live key). `,_jsx(_components.a,{href:`/getting-started/deploy`,children:`Deploy`}),` walks through them.`]}),`\n`]})]})}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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Get setup status","description":"Where the workspace is in Get started, the same steps the dashboard shows.","openapi":"openapi.json GET /v1/setup","href":"/api-reference/setup/status"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getSetupStatus","summary":"Get setup status","description":"Where the workspace is in Get started, the same steps the dashboard shows.","security":["b33b92af-1d70-4dd3-b6d8-a5b53fce6e44"],"responses":{"200":"88628c14-773b-4221-84c4-7d957fe87af7","401":"e80eca90-331f-4eec-b9c8-19c99588b715","429":"e0b81cb1-7786-4f2a-9e6a-b01afdedad36"},"x-codeSamples":[{"lang":"python","label":"Python SDK","source":"import os\nfrom integrateledger import ledger\n\nclient = ledger(api_key=os.environ[\"LEDGER_API_KEY\"])\nclient.get_setup_status()"},{"lang":"bash","label":"cURL","source":"curl --request GET 'https://api.integrateledger.com/v1/setup' \\\n -H \"Authorization: Bearer $LEDGER_API_KEY\""},{"lang":"typescript","label":"TypeScript SDK","source":"import ledger from \"integrateledger\";\n\nconst client = new ledger({ apiKey: process.env.LEDGER_API_KEY ?? \"\" });\nawait client.getSetupStatus();"}],"tags":["Usage"],"method":"get","type":"path","servers":["d05d605c-14be-4177-a9c7-ea799acc8fe6"],"path":"/v1/setup","baseUrlOptions":["https://api.integrateledger.com"],"title":"Get setup status","codeSamples":[{"label":"Python SDK","lang":"python","source":"import os\nfrom integrateledger import ledger\n\nclient = ledger(api_key=os.environ[\"LEDGER_API_KEY\"])\nclient.get_setup_status()"},{"label":"cURL","lang":"bash","source":"curl --request GET 'https://api.integrateledger.com/v1/setup' \\\n -H \"Authorization: Bearer $LEDGER_API_KEY\""},{"label":"TypeScript SDK","lang":"typescript","source":"import ledger from \"integrateledger\";\n\nconst client = new ledger({ apiKey: process.env.LEDGER_API_KEY ?? \"\" });\nawait client.getSetupStatus();"}],"requestExampleLanguages":["bash","typescript","python"],"requiredOnlyExamples":false,"disableCodeSampleGeneration":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"88628c14-773b-4221-84c4-7d957fe87af7":{"description":"Where the workspace is in Get started.","content":{"application/json":{"schema":{"type":"object","properties":{"agentConnectedAt":{"oneOf":[{"type":"string","description":"When a Sandbox API key first made a request. Null until then.","isRequired":true,"uniqueKey":"agentConnectedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When a Sandbox API key first made a request. Null until then.","isRequired":true,"uniqueKey":"agentConnectedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agentConnectedAt","typeLabel":"string | null"},"plans":{"type":"boolean","description":"A paid plan exists in the Sandbox.","isRequired":true,"uniqueKey":"plans","typeLabel":"boolean"},"customer":{"type":"boolean","description":"A customer exists in the Sandbox.","isRequired":true,"uniqueKey":"customer","typeLabel":"boolean"},"usage":{"type":"boolean","description":"A check or track has been made in the Sandbox.","isRequired":true,"uniqueKey":"usage","typeLabel":"boolean"},"live":{"type":"object","properties":{"activated":{"type":"boolean","description":"Live billing is activated: Go to production is done.","isRequired":true,"uniqueKey":"live.activated","typeLabel":"boolean"},"missing":{"type":"array","items":{"type":"string","enum":["api_key","stripe_connection","webhook","catalog_sync"],"uniqueKey":"live.missing.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Production steps not done yet: a Live API key, a live Stripe account, a receiving webhook, and every paid Live plan synced to Stripe.","isRequired":true,"uniqueKey":"live.missing","typeLabel":"enum\u003cstring>[]"}},"required":["activated","missing"],"isRequired":true,"uniqueKey":"live","typeLabel":"object"}},"required":["agentConnectedAt","plans","customer","usage","live"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"agentConnectedAt":"\u003cstring>","plans":true,"customer":true,"usage":true,"live":{"activated":true,"missing":["api_key"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"e80eca90-331f-4eec-b9c8-19c99588b715":{"description":"Missing or invalid Ledger API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e0b81cb1-7786-4f2a-9e6a-b01afdedad36":{"description":"Too many requests. Wait Retry-After seconds, then retry. See the rate limits guide.","headers":{"Retry-After":{"description":"Seconds until a request is allowed again","schema":{"type":"integer"}},"RateLimit-Limit":{"description":"The burst: requests allowed at once","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left right now","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the full burst is back","schema":{"type":"integer"}},"RateLimit-Policy":{"description":"The sustained rate per second and the burst, such as 200;w=1;burst=1000","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"rate_limited","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"rate_limited"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b33b92af-1d70-4dd3-b6d8-a5b53fce6e44":{"ApiKey":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"ApiKey"}}},"servers":{"d05d605c-14be-4177-a9c7-ea799acc8fe6":{"url":"https://api.integrateledger.com","description":"Hosted Ledger API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKey","name":"Authorization"}],"title":"ApiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"the-monetization-company","siteName":"Ledger","title":"Get setup status - Ledger","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T10:21:13.307Z","originalFileLocation":"api-reference/setup/status.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"Where the workspace is in Get started, the same steps the dashboard shows.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ledger\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/the-monetization-company/O7Td7oI1CGEEjch4/_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/the-monetization-company/O7Td7oI1CGEEjch4/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/the-monetization-company/O7Td7oI1CGEEjch4/_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/the-monetization-company/O7Td7oI1CGEEjch4/_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/the-monetization-company/O7Td7oI1CGEEjch4/_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/the-monetization-company/O7Td7oI1CGEEjch4/_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/the-monetization-company/O7Td7oI1CGEEjch4/_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/the-monetization-company/O7Td7oI1CGEEjch4/_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/the-monetization-company/O7Td7oI1CGEEjch4/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get setup status - Ledger\">\u003cmeta data-mint-head property=\"og:description\" content=\"Where the workspace is in Get started, the same steps the dashboard shows.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ledger\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.integrateledger.com/api-reference/setup/status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://the-monetization-company.mintlify.site/_mintlify/api/og/v2?division=Setup\u0026amp;title=Get+setup+status\u0026amp;description=Where+the+workspace+is+in+Get+started%2C+the+same+steps+the+dashboard+shows.\u0026amp;theme=8690a452f40a0ac3ad901170\u0026amp;signature=cc1d6e9d8a9ae4e6194fa39e7929f62a146e9a548e97b043fd63a03313e03ab8\">\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 setup status - Ledger\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Where the workspace is in Get started, the same steps the dashboard shows.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://the-monetization-company.mintlify.site/_mintlify/api/og/v2?division=Setup\u0026amp;title=Get+setup+status\u0026amp;description=Where+the+workspace+is+in+Get+started%2C+the+same+steps+the+dashboard+shows.\u0026amp;theme=8690a452f40a0ac3ad901170\u0026amp;signature=cc1d6e9d8a9ae4e6194fa39e7929f62a146e9a548e97b043fd63a03313e03ab8\">\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/the-monetization-company/O7Td7oI1CGEEjch4/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ledger\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1a1816\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.integrateledger.com/api-reference/setup/status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/setup/status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.integrateledger.com/#organization\",\"name\":\"Ledger\",\"url\":\"https://docs.integrateledger.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/the-monetization-company/ahIz9sTI-PocTQyT/logo/light.svg?fit=max\u0026auto=format\u0026n=ahIz9sTI-PocTQyT\u0026q=85\u0026s=0a7860016a3760c9689ef39ab2ac2124\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.integrateledger.com#website\",\"name\":\"Ledger\",\"url\":\"https://docs.integrateledger.com\",\"publisher\":{\"@id\":\"https://docs.integrateledger.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.integrateledger.com/api-reference/setup/status#webpage\",\"url\":\"https://docs.integrateledger.com/api-reference/setup/status\",\"name\":\"Get setup status\",\"description\":\"Where the workspace is in Get started, the same steps the dashboard shows.\",\"dateModified\":\"2026-11-09T10:21:13.307Z\",\"isPartOf\":{\"@id\":\"https://docs.integrateledger.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.integrateledger.com/api-reference/setup/status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.integrateledger.com/api-reference/setup/status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Ledger\",\"item\":\"https://docs.integrateledger.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get setup status\",\"item\":\"https://docs.integrateledger.com/api-reference/setup/status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.integrateledger.com/api-reference/setup/status#apireference\",\"headline\":\"Get setup status\",\"name\":\"Get setup status\",\"description\":\"Where the workspace is in Get started, the same steps the dashboard shows.\",\"url\":\"https://docs.integrateledger.com/api-reference/setup/status\",\"mainEntityOfPage\":{\"@id\":\"https://docs.integrateledger.com/api-reference/setup/status#webpage\"},\"dateModified\":\"2026-11-09T10:21:13.307Z\",\"publisher\":{\"@id\":\"https://docs.integrateledger.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.integrateledger.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ledger\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ledger","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"Get started","pages":[{"title":"API reference","sidebarTitle":"Introduction","href":"/api-reference/introduction"}]},{"group":"Usage","pages":[{"title":"Check credits","openapi":"openapi.json POST /v1/check","href":"/api-reference/usage/check"},{"title":"Track usage","openapi":"openapi.json POST /v1/track","href":"/api-reference/usage/track"}]},{"group":"Customers","pages":[{"title":"Create or get a customer","sidebarTitle":"Create or get","openapi":"openapi.json POST /v1/customers","href":"/api-reference/customers/create"},{"title":"Get a customer","sidebarTitle":"Get","openapi":"openapi.json GET /v1/customers","href":"/api-reference/customers/get"},{"title":"Delete a customer","sidebarTitle":"Delete","openapi":"openapi.json DELETE /v1/customers","href":"/api-reference/customers/delete"},{"title":"Link a Stripe customer","openapi":"openapi.json POST /v1/customers/stripe-customer","href":"/api-reference/customers/stripe-customer"},{"title":"List customer subscriptions","sidebarTitle":"List subscriptions","openapi":"openapi.json GET /v1/customers/subscriptions","href":"/api-reference/customers/subscriptions"},{"title":"List customer purchases","sidebarTitle":"List purchases","openapi":"openapi.json GET /v1/customers/purchases","href":"/api-reference/customers/purchases"},{"title":"Stop or resume renewal","sidebarTitle":"Stop or resume renewal","openapi":"openapi.json POST /v1/customers/subscriptions/{subscriptionId}/cancellation","href":"/api-reference/customers/cancellation"},{"title":"Set a customer's overage cap","sidebarTitle":"Set overage cap","openapi":"openapi.json POST /v1/customers/overage-cap","href":"/api-reference/customers/overage-cap"},{"title":"Set a customer's overage rate","sidebarTitle":"Set overage rate","openapi":"openapi.json POST /v1/customers/overage-override","href":"/api-reference/customers/overage-override"},{"title":"Adjust a customer's balance","sidebarTitle":"Adjust balance","openapi":"openapi.json POST /v1/customers/balance-adjustments","href":"/api-reference/customers/balance-adjustments"}]},{"group":"Billing","pages":[{"title":"Attach a plan or credit pack","sidebarTitle":"Attach","openapi":"openapi.json POST /v1/billing/attach","href":"/api-reference/billing/attach"},{"title":"Upgrade a paid plan","sidebarTitle":"Upgrade","openapi":"openapi.json POST /v1/billing/upgrade","href":"/api-reference/billing/upgrade"},{"title":"Import a Stripe subscription","openapi":"openapi.json POST /v1/billing/import","href":"/api-reference/billing/import"},{"title":"Preview a Stripe migration","openapi":"openapi.json GET /v1/migrate/stripe/preview","href":"/api-reference/migrate/stripe-preview"},{"title":"Downgrade a paid plan","openapi":"openapi.json POST /v1/billing/downgrade","href":"/api-reference/billing/downgrade"},{"title":"Get a scheduled downgrade","openapi":"openapi.json GET /v1/billing/downgrade","href":"/api-reference/billing/scheduled-downgrade"},{"title":"Undo a scheduled downgrade","openapi":"openapi.json POST /v1/billing/downgrade/{downgradeId}/cancel","href":"/api-reference/billing/cancel-downgrade"}]},{"group":"Plans","pages":[{"title":"List plans","sidebarTitle":"List","openapi":"openapi.json GET /v1/plans","href":"/api-reference/plans/list"},{"title":"Create a plan","sidebarTitle":"Create","openapi":"openapi.json POST /v1/plans","href":"/api-reference/plans/create"},{"title":"Get a plan","sidebarTitle":"Get","openapi":"openapi.json GET /v1/plans/{id}","href":"/api-reference/plans/get"},{"title":"Update a plan","sidebarTitle":"Update","openapi":"openapi.json POST /v1/plans/{id}","href":"/api-reference/plans/update"},{"title":"Archive a plan","sidebarTitle":"Archive","openapi":"openapi.json DELETE /v1/plans/{id}","href":"/api-reference/plans/archive"}]},{"group":"Features","pages":[{"title":"List features","sidebarTitle":"List","openapi":"openapi.json GET /v1/features","href":"/api-reference/features/list"},{"title":"Create a feature","sidebarTitle":"Create","openapi":"openapi.json POST /v1/features","href":"/api-reference/features/create"},{"title":"Get a feature","sidebarTitle":"Get","openapi":"openapi.json GET /v1/features/{id}","href":"/api-reference/features/get"},{"title":"Update a feature","sidebarTitle":"Update","openapi":"openapi.json POST /v1/features/{id}","href":"/api-reference/features/update"},{"title":"Archive a feature","sidebarTitle":"Archive","openapi":"openapi.json DELETE /v1/features/{id}","href":"/api-reference/features/archive"}]},{"group":"Credit packs","pages":[{"title":"List credit packs","sidebarTitle":"List","openapi":"openapi.json GET /v1/add-ons","href":"/api-reference/add-ons/list"},{"title":"Create a credit pack","sidebarTitle":"Create","openapi":"openapi.json POST /v1/add-ons","href":"/api-reference/add-ons/create"},{"title":"Get a credit pack","sidebarTitle":"Get","openapi":"openapi.json GET /v1/add-ons/{id}","href":"/api-reference/add-ons/get"},{"title":"Update a credit pack","sidebarTitle":"Update","openapi":"openapi.json POST /v1/add-ons/{id}","href":"/api-reference/add-ons/update"},{"title":"Archive a credit pack","sidebarTitle":"Archive","openapi":"openapi.json DELETE /v1/add-ons/{id}","href":"/api-reference/add-ons/archive"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","openapi":"openapi.json GET /v1/webhook-endpoints","href":"/api-reference/webhooks/list"},{"title":"Create a webhook endpoint","openapi":"openapi.json POST /v1/webhook-endpoints","href":"/api-reference/webhooks/create"},{"title":"Get a webhook endpoint","openapi":"openapi.json GET /v1/webhook-endpoints/{id}","href":"/api-reference/webhooks/get"},{"title":"Update a webhook endpoint","openapi":"openapi.json POST /v1/webhook-endpoints/{id}","href":"/api-reference/webhooks/update"},{"title":"Delete a webhook endpoint","openapi":"openapi.json DELETE /v1/webhook-endpoints/{id}","href":"/api-reference/webhooks/delete"}]},{"group":"Catalog","pages":[{"title":"Publish a catalog","sidebarTitle":"Publish","description":"Replace an environment's whole catalog in one request, from a config file.","openapi":"openapi.json POST /v1/catalog","href":"/api-reference/catalog/publish"}]},{"group":"Setup","pages":[{"title":"Get setup status","openapi":"openapi.json GET /v1/setup","href":"/api-reference/setup/status"}]}]}]},"basePath":"","title":"Get setup status - Ledger","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}