Publishes the complete desired catalog for the environment selected by the API key in one request. Supply schemaVersion: 1, environment: "sandbox" with a test key or environment: "live" with a live key, currency: "usd", at least one plan and one feature, any add-ons, and policy.onInsufficientCredits: "block". A mismatched environment is rejected. This is a declarative replacement: active items omitted from the submitted lists are archived.
The examples in the request panel use Sandbox. For Live, use a ledger_live_ key and change the body to "environment": "live".
Ledger changes only rows whose values differ. The response reports changed: false for an identical catalog and a stripeSync state for paid plan prices after the database commit. Changed plans create new versions; existing subscriptions retain their referenced plan versions. Feature and add-on values update in place. A Stripe sync failure does not roll back an accepted catalog.If an add-on has a pending purchase, changing its price or credit amount returns 409 purchase_pending; complete the payment or wait for Stripe’s signed checkout.session.expired event to clear it before publishing the new value. A browser cancel redirect alone does not expire Checkout. An invalid catalog returns 400 invalid_catalog with issues that identify fields and validation errors. Use Create a plan, Create a feature, and Create an add-on for incremental onboarding without replacing unrelated items. See Catalog for the tradeoffs.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ledger","description":"Credit billing and usage enforcement for your application","colors":{"primary":"#14110f","light":"#14110f","dark":"#eae8e6"},"logo":{"light":"https://mintcdn.com/the-monetization-company/qn4cqzAsWKBiDg3y/logo/light.svg?fit=max\u0026auto=format\u0026n=qn4cqzAsWKBiDg3y\u0026q=85\u0026s=c43f0b298b0376f480fd807a74b0ceee","dark":"https://mintcdn.com/the-monetization-company/qn4cqzAsWKBiDg3y/logo/dark.svg?fit=max\u0026auto=format\u0026n=qn4cqzAsWKBiDg3y\u0026q=85\u0026s=fa122ccc31417d2b77bbccc21759e278"},"favicon":"https://mintcdn.com/the-monetization-company/aKz7Rud5JPuv5NGW/favicon.svg?fit=max\u0026auto=format\u0026n=aKz7Rud5JPuv5NGW\u0026q=85\u0026s=b74404ad940be974dbfac18f9e62a5ab","api":{"playground":{"display":"simple"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"the-monetization-company","hasAudioNarration":false,"actualSubdomain":"the-monetization-company","customDomains":["docs.integrateledger.com"],"gitSource":{"type":"github","owner":"its-ushen","repo":"tmc","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":"","_id":"6ae2d50fa009304b407da8cc"},"chroma":{"latestBuiltDeploymentHistoryId":"6ae31f2f4c2492fe62cb2834","collectionId":"9a0ac34f-92fe-4d9c-93db-f124794feb0e","liveDeploymentHistoryId":"6ae31f2f4c2492fe62cb2834","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae31f2f4c2492fe62cb2834","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API reference","count":22},{"language":"default","tag":"Documentation","count":13},{"language":"default","tag":"Getting started","count":7},{"language":"default","tag":"Add-ons","count":5},{"language":"default","tag":"Features","count":5},{"language":"default","tag":"Plans","count":5},{"language":"default","tag":"Concepts","count":5},{"language":"default","tag":"Customers and usage","count":4},{"language":"default","tag":"Billing","count":2},{"language":"default","tag":"Catalog sync","count":1}]},"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":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/catalog/publish","slug":"/api-reference/catalog/publish","pageMetadata":{"title":"Publish an organization's catalog","description":"Publish an entire desired catalog for declarative sync. Items omitted from the input are archived.","openapi":"openapi.json PUT /v1/catalog","href":"/api-reference/catalog/publish"},"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: \"Publish an entire desired catalog for declarative sync. Items omitted from the input are archived.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Publishes the complete desired catalog for the environment selected by the API key in one request. Supply `,_jsx(_components.code,{children:`schemaVersion: 1`}),`, `,_jsx(_components.code,{children:`environment: \"sandbox\"`}),` with a test key or `,_jsx(_components.code,{children:`environment: \"live\"`}),` with a live key, `,_jsx(_components.code,{children:`currency: \"usd\"`}),`, at least one plan and one feature, any add-ons, and `,_jsx(_components.code,{children:`policy.onInsufficientCredits: \"block\"`}),`. A mismatched environment is rejected. This is a declarative replacement: active items omitted from the submitted lists are archived.`]}),`\n`,_jsxs(Note,{children:[`The examples in the request panel use Sandbox. For Live, use a `,_jsx(_components.code,{children:`ledger_live_`}),` key and change the body to `,_jsx(_components.code,{children:`\"environment\": \"live\"`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Ledger changes only rows whose values differ. The response reports `,_jsx(_components.code,{children:`changed: false`}),` for an identical catalog and a `,_jsx(_components.code,{children:`stripeSync`}),` state for paid plan prices after the database commit. Changed plans create new versions; existing subscriptions retain their referenced plan versions. Feature and add-on values update in place. A Stripe sync failure does not roll back an accepted catalog.`]}),`\n`,_jsxs(_components.p,{children:[`If an add-on has a pending purchase, changing its price or credit amount returns `,_jsx(_components.code,{children:`409 purchase_pending`}),`; complete the payment or wait for Stripe’s signed `,_jsx(_components.code,{children:`checkout.session.expired`}),` event to clear it before publishing the new value. A browser cancel redirect alone does not expire Checkout. An invalid catalog returns `,_jsx(_components.code,{children:`400 invalid_catalog`}),` with `,_jsx(_components.code,{children:`issues`}),` that identify fields and validation errors. Use `,_jsx(_components.a,{href:`/api-reference/plans/create`,children:`Create a plan`}),`, `,_jsx(_components.a,{href:`/api-reference/features/create`,children:`Create a feature`}),`, and `,_jsx(_components.a,{href:`/api-reference/add-ons/create`,children:`Create an add-on`}),` for incremental onboarding without replacing unrelated items. See `,_jsx(_components.a,{href:`/catalog`,children:`Catalog`}),` for the tradeoffs.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Publish an organization's catalog","description":"Publish an entire desired catalog for declarative sync. Items omitted from the input are archived.","openapi":"openapi.json PUT /v1/catalog","href":"/api-reference/catalog/publish"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"publishCatalog","security":["34b3be25-c322-4cca-9c1f-f5a97aad3bf8"],"requestBody":"89362202-a92c-4beb-93b2-ce13fc76d392","responses":{"200":"c70fee6f-2246-454a-a5cb-371281a2616d","400":"e04e3b6d-e929-4eb1-9063-3d9a393acf4f","401":"673ea69b-8432-4260-b9e7-20a5807ba9ac","409":"5c9ef490-59f2-484b-9756-7e26ed1ed6a4"},"summary":"Publish an organization's catalog","x-codeSamples":[{"lang":"bash","label":"cURL","source":"curl --request PUT 'https://api.integrateledger.com/v1/catalog' \\\n -H \"Authorization: Bearer $LEDGER_API_KEY\" \\\n -H 'Content-Type: application/json' \\\n --data '{\"schemaVersion\":1,\"environment\":\"sandbox\",\"currency\":\"usd\",\"plans\":[{\"id\":\"starter\",\"name\":\"Starter\",\"monthlyCredits\":100,\"monthlyPriceCents\":1900}],\"features\":[{\"id\":\"api_call\",\"name\":\"API call\",\"creditCost\":1}],\"addOns\":[],\"policy\":{\"onInsufficientCredits\":\"block\"}}'"},{"lang":"python","label":"Python SDK (source only)","source":"import os\nfrom ledger_sdk import Ledger\n\nledger = Ledger(api_key=os.environ[\"LEDGER_API_KEY\"])\nledger.publish_catalog({\"schemaVersion\": 1, \"environment\": \"sandbox\", \"currency\": \"usd\", \"plans\": [{\"id\": \"starter\", \"name\": \"Starter\", \"monthlyCredits\": 100, \"monthlyPriceCents\": 1900}], \"features\": [{\"id\": \"api_call\", \"name\": \"API call\", \"creditCost\": 1}], \"addOns\": [], \"policy\": {\"onInsufficientCredits\": \"block\"}})"},{"lang":"typescript","label":"TypeScript SDK (source only)","source":"import { Ledger } from \"@ledger/sdk\";\n\nconst ledger = new Ledger({ apiKey: process.env.LEDGER_API_KEY ?? \"\" });\nawait ledger.publishCatalog({ schemaVersion: 1, environment: \"sandbox\", currency: \"usd\", plans: [{ id: \"starter\", name: \"Starter\", monthlyCredits: 100, monthlyPriceCents: 1900 }], features: [{ id: \"api_call\", name: \"API call\", creditCost: 1 }], addOns: [], policy: { onInsufficientCredits: \"block\" } });"}],"tags":["Catalog"],"method":"put","type":"path","servers":["1fe4bd1d-1f41-4581-9576-f34617198c4c"],"path":"/v1/catalog","baseUrlOptions":["https://api.integrateledger.com"],"title":"Publish an organization's catalog","description":"Publish an entire desired catalog for declarative sync. Items omitted from the input are archived.","codeSamples":[{"label":"cURL","lang":"bash","source":"curl --request PUT 'https://api.integrateledger.com/v1/catalog' \\\n -H \"Authorization: Bearer $LEDGER_API_KEY\" \\\n -H 'Content-Type: application/json' \\\n --data '{\"schemaVersion\":1,\"environment\":\"sandbox\",\"currency\":\"usd\",\"plans\":[{\"id\":\"starter\",\"name\":\"Starter\",\"monthlyCredits\":100,\"monthlyPriceCents\":1900}],\"features\":[{\"id\":\"api_call\",\"name\":\"API call\",\"creditCost\":1}],\"addOns\":[],\"policy\":{\"onInsufficientCredits\":\"block\"}}'"},{"label":"Python SDK (source only)","lang":"python","source":"import os\nfrom ledger_sdk import Ledger\n\nledger = Ledger(api_key=os.environ[\"LEDGER_API_KEY\"])\nledger.publish_catalog({\"schemaVersion\": 1, \"environment\": \"sandbox\", \"currency\": \"usd\", \"plans\": [{\"id\": \"starter\", \"name\": \"Starter\", \"monthlyCredits\": 100, \"monthlyPriceCents\": 1900}], \"features\": [{\"id\": \"api_call\", \"name\": \"API call\", \"creditCost\": 1}], \"addOns\": [], \"policy\": {\"onInsufficientCredits\": \"block\"}})"},{"label":"TypeScript SDK (source only)","lang":"typescript","source":"import { Ledger } from \"@ledger/sdk\";\n\nconst ledger = new Ledger({ apiKey: process.env.LEDGER_API_KEY ?? \"\" });\nawait ledger.publishCatalog({ schemaVersion: 1, environment: \"sandbox\", currency: \"usd\", plans: [{ id: \"starter\", name: \"Starter\", monthlyCredits: 100, monthlyPriceCents: 1900 }], features: [{ id: \"api_call\", name: \"API call\", creditCost: 1 }], addOns: [], policy: { onInsufficientCredits: \"block\" } });"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"schemaVersion":{"type":"integer","enum":[1],"isRequired":true,"uniqueKey":"schemaVersion","typeLabel":"enum\u003cinteger>"},"environment":{"type":"string","enum":["sandbox","live"],"isRequired":true,"uniqueKey":"environment","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["usd"],"isRequired":true,"uniqueKey":"currency","typeLabel":"enum\u003cstring>"},"plans":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9_-]+$","isRequired":true,"uniqueKey":"plans.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"plans.items.[INDEX].name","typeLabel":"string"},"monthlyCredits":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647,"isRequired":true,"uniqueKey":"plans.items.[INDEX].monthlyCredits","typeLabel":"integer"},"monthlyPriceCents":{"type":"integer","minimum":0,"maximum":2147483647,"isRequired":true,"uniqueKey":"plans.items.[INDEX].monthlyPriceCents","typeLabel":"integer"}},"required":["id","name","monthlyCredits","monthlyPriceCents"],"additionalProperties":false,"uniqueKey":"plans.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"plans","typeLabel":"object[]"},"features":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9_-]+$","isRequired":true,"uniqueKey":"features.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"features.items.[INDEX].name","typeLabel":"string"},"creditCost":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647,"isRequired":true,"uniqueKey":"features.items.[INDEX].creditCost","typeLabel":"integer"}},"required":["id","name","creditCost"],"additionalProperties":false,"uniqueKey":"features.items.[INDEX]","typeLabel":"object"},"minItems":1,"isRequired":true,"uniqueKey":"features","typeLabel":"object[]"},"addOns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[a-zA-Z0-9_-]+$","isRequired":true,"uniqueKey":"addOns.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"addOns.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["credit_pack"],"isRequired":true,"uniqueKey":"addOns.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"creditAmount":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647,"isRequired":true,"uniqueKey":"addOns.items.[INDEX].creditAmount","typeLabel":"integer"},"priceCents":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647,"isRequired":true,"uniqueKey":"addOns.items.[INDEX].priceCents","typeLabel":"integer"}},"required":["id","name","type","creditAmount","priceCents"],"additionalProperties":false,"uniqueKey":"addOns.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"addOns","typeLabel":"object[]"},"policy":{"type":"object","properties":{"onInsufficientCredits":{"type":"string","enum":["block"],"isRequired":true,"uniqueKey":"policy.onInsufficientCredits","typeLabel":"enum\u003cstring>"}},"required":["onInsufficientCredits"],"additionalProperties":false,"isRequired":true,"uniqueKey":"policy","typeLabel":"object"}},"required":["schemaVersion","environment","currency","plans","features","addOns","policy"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"schemaVersion":1,"currency":"usd","plans":[{"id":"\u003cstring>","name":"\u003cstring>","monthlyCredits":123,"monthlyPriceCents":1073741823}],"features":[{"id":"\u003cstring>","name":"\u003cstring>","creditCost":123}],"addOns":[{"id":"\u003cstring>","name":"\u003cstring>","type":"credit_pack","creditAmount":123,"priceCents":123}],"policy":{"onInsufficientCredits":"block"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"c70fee6f-2246-454a-a5cb-371281a2616d":{"description":"Catalog accepted. changed is false when the Ledger catalog is unchanged. stripeSync reports paid-plan Stripe Product sync after commit.","content":{"application/json":{"schema":{"type":"object","properties":{"changed":{"type":"boolean","isRequired":true,"uniqueKey":"changed","typeLabel":"boolean"},"stripeSync":{"type":"string","enum":["synced","pending","failed","awaiting_connection"],"isRequired":true,"uniqueKey":"stripeSync","typeLabel":"enum\u003cstring>"}},"required":["changed","stripeSync"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"changed":true,"stripeSync":"synced"}}},"exampleType":"generated"}},"exampleType":"generated"},"e04e3b6d-e929-4eb1-9063-3d9a393acf4f":{"description":"Invalid catalog","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","issues":[{"path":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"673ea69b-8432-4260-b9e7-20a5807ba9ac":{"description":"Missing or invalid Ledger API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","issues":[{"path":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"5c9ef490-59f2-484b-9756-7e26ed1ed6a4":{"description":"An add-on with a pending Checkout cannot change credits or price","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"issues.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"issues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"issues","typeLabel":"object[]"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","issues":[{"path":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"34b3be25-c322-4cca-9c1f-f5a97aad3bf8":{"ApiKey":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"ApiKey"}}},"servers":{"1fe4bd1d-1f41-4581-9576-f34617198c4c":{"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":"Publish an organization's catalog - Ledger","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T09:20:11.425Z","originalFileLocation":"api-reference/catalog/publish.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Publish an entire desired catalog for declarative sync. Items omitted from the input are archived.\">\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/dVEbDGNkgU1tesDh/_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/dVEbDGNkgU1tesDh/_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/dVEbDGNkgU1tesDh/_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/dVEbDGNkgU1tesDh/_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/dVEbDGNkgU1tesDh/_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/dVEbDGNkgU1tesDh/_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/dVEbDGNkgU1tesDh/_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/dVEbDGNkgU1tesDh/_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/dVEbDGNkgU1tesDh/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Publish an organization\u0026#x27;s catalog - Ledger\">\u003cmeta data-mint-head property=\"og:description\" content=\"Publish an entire desired catalog for declarative sync. Items omitted from the input are archived.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ledger\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.integrateledger.com/api-reference/catalog/publish\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://the-monetization-company.mintlify.app/_mintlify/api/og/v2?division=Catalog+sync\u0026amp;title=Publish+an+organization%27s+catalog\u0026amp;description=Publish+an+entire+desired+catalog+for+declarative+sync.+Items+omitted+from+the+input+are+archived.\u0026amp;theme=54d2f4cf4fed3d5b52057591\u0026amp;signature=91c566a709343bd4f48c9807d6d18f43b58260b1fbcb2f182694bf0a8df94991\">\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=\"Publish an organization\u0026#x27;s catalog - Ledger\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Publish an entire desired catalog for declarative sync. Items omitted from the input are archived.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://the-monetization-company.mintlify.app/_mintlify/api/og/v2?division=Catalog+sync\u0026amp;title=Publish+an+organization%27s+catalog\u0026amp;description=Publish+an+entire+desired+catalog+for+declarative+sync.+Items+omitted+from+the+input+are+archived.\u0026amp;theme=54d2f4cf4fed3d5b52057591\u0026amp;signature=91c566a709343bd4f48c9807d6d18f43b58260b1fbcb2f182694bf0a8df94991\">\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/dVEbDGNkgU1tesDh/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ledger\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#14110f\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.integrateledger.com/api-reference/catalog/publish\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/catalog/publish.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/qn4cqzAsWKBiDg3y/logo/light.svg?fit=max\u0026auto=format\u0026n=qn4cqzAsWKBiDg3y\u0026q=85\u0026s=c43f0b298b0376f480fd807a74b0ceee\"}},{\"@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/catalog/publish#webpage\",\"url\":\"https://docs.integrateledger.com/api-reference/catalog/publish\",\"name\":\"Publish an organization's catalog\",\"description\":\"Publish an entire desired catalog for declarative sync. Items omitted from the input are archived.\",\"dateModified\":\"2026-10-29T09:20:11.425Z\",\"isPartOf\":{\"@id\":\"https://docs.integrateledger.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.integrateledger.com/api-reference/catalog/publish#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.integrateledger.com/api-reference/catalog/publish#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Ledger\",\"item\":\"https://docs.integrateledger.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Publish an organization's catalog\",\"item\":\"https://docs.integrateledger.com/api-reference/catalog/publish\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.integrateledger.com/api-reference/catalog/publish#apireference\",\"headline\":\"Publish an organization's catalog\",\"name\":\"Publish an organization's catalog\",\"description\":\"Publish an entire desired catalog for declarative sync. Items omitted from the input are archived.\",\"url\":\"https://docs.integrateledger.com/api-reference/catalog/publish\",\"mainEntityOfPage\":{\"@id\":\"https://docs.integrateledger.com/api-reference/catalog/publish#webpage\"},\"dateModified\":\"2026-10-29T09:20:11.425Z\",\"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":"Plans","pages":[{"title":"List active plans","openapi":"openapi.json GET /v1/plans","href":"/api-reference/plans/list"},{"title":"Create a plan","openapi":"openapi.json POST /v1/plans","href":"/api-reference/plans/create"},{"title":"Get a plan","openapi":"openapi.json GET /v1/plans/{id}","href":"/api-reference/plans/get"},{"title":"Update a plan","openapi":"openapi.json PUT /v1/plans/{id}","href":"/api-reference/plans/update"},{"title":"Archive a plan","openapi":"openapi.json DELETE /v1/plans/{id}","href":"/api-reference/plans/archive"}]},{"group":"Features","pages":[{"title":"List active features","openapi":"openapi.json GET /v1/features","href":"/api-reference/features/list"},{"title":"Create a feature","openapi":"openapi.json POST /v1/features","href":"/api-reference/features/create"},{"title":"Get a feature","openapi":"openapi.json GET /v1/features/{id}","href":"/api-reference/features/get"},{"title":"Update a feature","openapi":"openapi.json PUT /v1/features/{id}","href":"/api-reference/features/update"},{"title":"Archive a feature","openapi":"openapi.json DELETE /v1/features/{id}","href":"/api-reference/features/archive"}]},{"group":"Add-ons","pages":[{"title":"List active add-ons","openapi":"openapi.json GET /v1/add-ons","href":"/api-reference/add-ons/list"},{"title":"Create an add-on","openapi":"openapi.json POST /v1/add-ons","href":"/api-reference/add-ons/create"},{"title":"Get an add-on","openapi":"openapi.json GET /v1/add-ons/{id}","href":"/api-reference/add-ons/get"},{"title":"Update an add-on","openapi":"openapi.json PUT /v1/add-ons/{id}","href":"/api-reference/add-ons/update"},{"title":"Archive an add-on","openapi":"openapi.json DELETE /v1/add-ons/{id}","href":"/api-reference/add-ons/archive"}]},{"group":"Customers and usage","pages":[{"title":"Create or get a customer","openapi":"openapi.json POST /v1/customers","href":"/api-reference/customers/create"},{"title":"Get a customer","openapi":"openapi.json GET /v1/customers","href":"/api-reference/customers/get"},{"title":"Check a customer's available credits","openapi":"openapi.json POST /v1/check","href":"/api-reference/usage/check"},{"title":"Record feature usage","openapi":"openapi.json POST /v1/track","href":"/api-reference/usage/track"}]},{"group":"Billing","pages":[{"title":"Attach a plan or add-on to a customer","openapi":"openapi.json POST /v1/billing/attach","href":"/api-reference/billing/attach"},{"title":"Upgrade a paid plan","description":"Start an idempotent paid plan upgrade for an existing subscription.","openapi":"openapi.json POST /v1/billing/upgrade","href":"/api-reference/billing/upgrade"}]},{"group":"Catalog sync","pages":[{"title":"Publish an organization's catalog","openapi":"openapi.json PUT /v1/catalog","href":"/api-reference/catalog/publish"}]}]}]},"title":"Publish an organization's catalog - Ledger","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}