An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create. Only platform keys can hold businesses:create and users:create.
The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"LobbyStack","description":"Help Center and developer documentation for LobbyStack.","colors":{"primary":"#0B0B0D","light":"#FFFFFF","dark":"#0B0B0D"},"logo":{"light":"https://mintcdn.com/lobbystack/U5lIHanZzQwzxaKz/logo.svg?fit=max\u0026auto=format\u0026n=U5lIHanZzQwzxaKz\u0026q=85\u0026s=f0ca27eea3705edeadc68d16f27acac3","dark":"https://mintcdn.com/lobbystack/U5lIHanZzQwzxaKz/logo-dark.svg?fit=max\u0026auto=format\u0026n=U5lIHanZzQwzxaKz\u0026q=85\u0026s=dd0eb694e7bee2d9198a59d78de1bfbc"},"favicon":"https://mintcdn.com/lobbystack/U5lIHanZzQwzxaKz/favicon.svg?fit=max\u0026auto=format\u0026n=U5lIHanZzQwzxaKz\u0026q=85\u0026s=0c7754331a8da46e372619ee14837a28","navbar":{"links":[{"href":"https://lobbystack.com","label":"Lobbystack.com"},{"icon":"github","href":"https://github.com/lobbystack/lobbystack","label":""},{"href":"https://app.lobbystack.com/login","label":"Log in"}],"primary":{"type":"button","label":"Try for free","href":"https://app.lobbystack.com/signup"}},"fonts":{"family":"Geist"},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","default":true,"href":"introduction"},{"language":"fr","navbar":{"links":[{"href":"https://lobbystack.com/fr/","label":"Lobbystack.com"},{"icon":"github","href":"https://github.com/lobbystack/lobbystack","label":""},{"href":"https://app.lobbystack.com/fr/login","label":"Se connecter"}],"primary":{"type":"button","label":"Essayer gratuitement","href":"https://app.lobbystack.com/fr/signup"}},"href":"fr/introduction"},{"language":"es","navbar":{"links":[{"href":"https://lobbystack.com/es/","label":"Lobbystack.com"},{"icon":"github","href":"https://github.com/lobbystack/lobbystack","label":""},{"href":"https://app.lobbystack.com/es/login","label":"Iniciar sesión"}],"primary":{"type":"button","label":"Pruébelo gratis","href":"https://app.lobbystack.com/es/signup"}},"href":"es/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lobbystack","hasAudioNarration":false,"actualSubdomain":"lobbystack","customDomains":["docs.lobbystack.com"],"gitSource":{"type":"github","owner":"lobbystack","repo":"lobbystack","deployBranch":"main","contentDirectory":"mintlify","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ada631e649217a4405d1b0f","collectionId":"c29bce5b-6195-4ab0-a374-46080ede4fc9","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada631e649217a4405d1b0f"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ada7a27db0346df9f5e1099","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"en","tag":"API reference","count":92},{"language":"es","tag":"Referencia de la API","count":92},{"language":"fr","tag":"Référence de l'API","count":92},{"language":"en","tag":"Knowledge","count":15},{"language":"es","tag":"Knowledge","count":15},{"language":"fr","tag":"Knowledge","count":15},{"language":"en","tag":"Manage","count":13},{"language":"es","tag":"Gestionar","count":13},{"language":"fr","tag":"Gestion","count":13},{"language":"en","tag":"Billing","count":9},{"language":"en","tag":"Business","count":8},{"language":"es","tag":"Business","count":8},{"language":"fr","tag":"Business","count":8},{"language":"en","tag":"Agent","count":7},{"language":"en","tag":"API Reference","count":7},{"language":"en","tag":"Receptionist","count":7},{"language":"es","tag":"Agente","count":7},{"language":"es","tag":"API Reference","count":7},{"language":"es","tag":"Receptionist","count":7},{"language":"fr","tag":"Agent","count":7},{"language":"fr","tag":"API Reference","count":7},{"language":"fr","tag":"Receptionist","count":7},{"language":"en","tag":"General","count":6},{"language":"en","tag":"Get started","count":6},{"language":"es","tag":"General","count":6},{"language":"es","tag":"Primeros pasos","count":6},{"language":"es","tag":"Appointments","count":6},{"language":"fr","tag":"Général","count":6},{"language":"fr","tag":"Premiers pas","count":6},{"language":"fr","tag":"Appointments","count":6},{"language":"default","tag":"AI assistants","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#navbar :has(>a[href*=\"app.lobbystack.com/login\"]),#navbar :has(>a[href*=\"github.com/lobbystack/lobbystack\"]),#navbar :has(>a[href=\"https://lobbystack.com\"]),#navbar a[href*=\"app.lobbystack.com/login\"],#navbar a[href*=\"github.com/lobbystack/lobbystack\"],#navbar a[href=\"https://lobbystack.com\"],.login-link,.navbar-link,.topbar-right-container .navbar-link,[data-component-name=login-link],[data-component-name=navbar-link],[data-component-name=topbar-right-container] .navbar-link,login-link,navbar-link[href*=\"app.lobbystack.com/login\"],navbar-link[href*=\"github.com/lobbystack/lobbystack\"],navbar-link[href=\"https://lobbystack.com\"],topbar-right-container navbar-link{min-width:auto!important;width:auto!important;padding:0!important;border:0!important;background:0 0!important;box-shadow:none!important;border-radius:0!important;font-weight:400!important}#navbar :has(>a[href*=\"github.com/lobbystack/lobbystack\"]) p,#navbar :has(>a[href*=\"github.com/lobbystack/lobbystack\"]) span,#navbar a[href*=\"github.com/lobbystack/lobbystack\"] p,#navbar a[href*=\"github.com/lobbystack/lobbystack\"] span,navbar-link[href*=\"github.com/lobbystack/lobbystack\"] p,navbar-link[href*=\"github.com/lobbystack/lobbystack\"] span{display:none!important}#navbar :has(>a[href*=\"github.com/lobbystack/lobbystack\"]) svg,#navbar a[href*=\"github.com/lobbystack/lobbystack\"] svg,navbar-link[href*=\"github.com/lobbystack/lobbystack\"] svg{margin:0!important}#navbar :has(>a[href=\"https://lobbystack.com\"]),#navbar a[href=\"https://lobbystack.com\"],navbar-link[href=\"https://lobbystack.com\"]{margin-right:8px!important}#navbar a[href*=\"app.lobbystack.com/signup\"],#topbar-cta-button,[data-component-name=primary-header-button]{border:1px solid #0b0b0d!important;border-radius:26px!important;background:#0b0b0d!important;box-shadow:none!important}#navbar a[href*=\"app.lobbystack.com/signup\"],#navbar a[href*=\"app.lobbystack.com/signup\"] *,#topbar-cta-button,#topbar-cta-button *,[data-component-name=primary-header-button],[data-component-name=primary-header-button] *{color:#fff!important;font-weight:400!important}#topbar-cta-button:empty::before,[data-component-name=primary-header-button]:empty::before{content:\"Try for free\"}#navbar .nav-tabs-item,#navbar .nav-tabs-item *,nav-tabs-item,nav-tabs-item *{font-weight:400!important}"}],"page":{"pagePath":"api-reference/billing/set-the-spending-cap","slug":"/api-reference/billing/set-the-spending-cap","pageMetadata":{"title":"Set the spending cap","description":"Sets or removes the cap on a Starter or Pro plan's usage over its allowance each month. Another plan is a 409.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /billing","href":"/api-reference/billing/set-the-spending-cap","autogeneratedByOpenApi":true},"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: \"Sets or removes the cap on a Starter or Pro plan’s usage over its allowance each month. Another plan is a 409.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Set the spending cap","description":"Sets or removes the cap on a Starter or Pro plan's usage over its allowance each month. Another plan is a 409.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /billing","href":"/api-reference/billing/set-the-spending-cap","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"updateBilling","summary":"Set the spending cap","description":"Sets or removes the cap on a Starter or Pro plan's usage over its allowance each month. Another plan is a 409.","tags":["Billing"],"security":["184b1649-6209-46b9-aaac-b6c6e5b02fe5"],"x-required-scope":"billing:manage","parameters":["56129a37-a470-4feb-ab98-e2eb6f9e3ef0"],"requestBody":"eb8a4bee-00be-4e31-ac5d-892cd1bb5a8f","responses":{"200":"68214434-adb6-4963-9ad4-ee7795fd9d01","400":"025c5e6f-e982-476c-9230-2b7725b936c0","401":"2c08dc24-d1a5-4bd4-a215-fd6890591e73","403":"42023e5f-c1ef-4308-9985-a771d71865fe","404":"08d74d11-8a9f-4dcb-9968-c9bb7642c46d","409":"022bc4cd-f113-4e78-895c-73c77becb307","429":"f37b56d0-0d0d-4e0b-9ab7-c68f0e6fe508"},"method":"patch","type":"path","servers":["d5067309-8f25-4e51-9859-b9f47141a1dd"],"path":"/billing","baseUrlOptions":["https://app.lobbystack.com/api/v1"],"title":"Set the spending cap","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"56129a37-a470-4feb-ab98-e2eb6f9e3ef0":{"name":"LobbyStack-Business","in":"header","description":"The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.","schema":{"type":"string","format":"uuid","description":"The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"spending_cap_cents":{"oneOf":[{"type":"integer","description":"Cents. null removes the cap. Only Starter and Pro plans have one.","maximum":9007199254740991,"minimum":0,"isRequired":true,"uniqueKey":"spending_cap_cents.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Cents. null removes the cap. Only Starter and Pro plans have one.","isRequired":true,"uniqueKey":"spending_cap_cents.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"spending_cap_cents","typeLabel":"integer | null"}},"required":["spending_cap_cents"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"spending_cap_cents":4503599627370495}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"68214434-adb6-4963-9ad4-ee7795fd9d01":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"plan":{"type":"string","enum":["self_host","free_cloud","starter","pro","enterprise"],"description":"The plan in force now. A Starter or Pro subscription that lapsed reads as free_cloud.","isRequired":true,"uniqueKey":"data.plan","typeLabel":"enum\u003cstring>"},"managed":{"type":"boolean","description":"true when the LobbyStack operator runs the plan outside Polar and bills the business directly.","isRequired":true,"uniqueKey":"data.managed","typeLabel":"boolean"},"subscription_state":{"oneOf":[{"description":"The subscription's state, such as active, trialing, past_due or canceled. Null without a subscription.","type":"string","isRequired":true,"uniqueKey":"data.subscription_state.oneOf.0","typeLabel":"string"},{"description":"The subscription's state, such as active, trialing, past_due or canceled. Null without a subscription.","type":"null","isRequired":true,"uniqueKey":"data.subscription_state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.subscription_state","typeLabel":"string | null"},"billing_interval":{"oneOf":[{"type":"string","description":"Null unless the plan is Starter or Pro.","enum":["monthly","annual"],"isRequired":true,"uniqueKey":"data.billing_interval.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Null unless the plan is Starter or Pro.","isRequired":true,"uniqueKey":"data.billing_interval.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.billing_interval","typeLabel":"enum\u003cstring> | null"},"current_period_end":{"oneOf":[{"type":"string","description":"When the paid period ends. Null unless the plan is Starter or Pro.","format":"date-time","isRequired":true,"uniqueKey":"data.current_period_end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the paid period ends. Null unless the plan is Starter or Pro.","isRequired":true,"uniqueKey":"data.current_period_end.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.current_period_end","typeLabel":"string\u003cdate-time> | null"},"spending_cap_cents":{"oneOf":[{"type":"integer","description":"The most a Starter or Pro plan spends on usage over its allowance each month. Null means no cap, and is always null on other plans.","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"data.spending_cap_cents.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The most a Starter or Pro plan spends on usage over its allowance each month. Null means no cap, and is always null on other plans.","isRequired":true,"uniqueKey":"data.spending_cap_cents.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.spending_cap_cents","typeLabel":"integer | null"},"overage_spend_cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Usage over the allowance this month.","isRequired":true,"uniqueKey":"data.overage_spend_cents","typeLabel":"integer"},"spending_cap_reached":{"type":"boolean","description":"true once this month's overage reached the cap, which stops further billable usage.","isRequired":true,"uniqueKey":"data.spending_cap_reached","typeLabel":"boolean"}},"required":["plan","managed","subscription_state","billing_interval","current_period_end","spending_cap_cents","overage_spend_cents","spending_cap_reached"],"additionalProperties":false,"description":"The business's plan and what it spends.","isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"plan":"self_host","managed":true,"subscription_state":"\u003cstring>","billing_interval":"monthly","current_period_end":"2023-11-07T05:31:56Z","spending_cap_cents":0,"overage_spend_cents":0,"spending_cap_reached":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"025c5e6f-e982-476c-9230-2b7725b936c0":{"description":"The request is invalid (invalid_request), or a platform key sent no LobbyStack-Business header (business_required).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","forbidden","insufficient_scope","not_found","conflict","idempotency_key_reused","idempotency_request_in_progress","booking_disabled","booking_requires_confirmation","slot_unavailable","rate_limited","rate_limit_unavailable","method_not_allowed","internal_error","business_required","key_owner_inactive","plan_limit_reached"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"2c08dc24-d1a5-4bd4-a215-fd6890591e73":{"description":"The API key is missing, invalid, or revoked (unauthorized).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","forbidden","insufficient_scope","not_found","conflict","idempotency_key_reused","idempotency_request_in_progress","booking_disabled","booking_requires_confirmation","slot_unavailable","rate_limited","rate_limit_unavailable","method_not_allowed","internal_error","business_required","key_owner_inactive","plan_limit_reached"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"42023e5f-c1ef-4308-9985-a771d71865fe":{"description":"Refused. insufficient_scope: the key lacks the billing:manage scope. forbidden: a per-business key named another business in LobbyStack-Business. key_owner_inactive: the person the key acts for can't any more: a per-business key's creator is no longer an owner or admin, or a platform key's owner_email has no verified LobbyStack account.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","forbidden","insufficient_scope","not_found","conflict","idempotency_key_reused","idempotency_request_in_progress","booking_disabled","booking_requires_confirmation","slot_unavailable","rate_limited","rate_limit_unavailable","method_not_allowed","internal_error","business_required","key_owner_inactive","plan_limit_reached"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"08d74d11-8a9f-4dcb-9968-c9bb7642c46d":{"description":"A platform key named a business it cannot act on (not_found).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","forbidden","insufficient_scope","not_found","conflict","idempotency_key_reused","idempotency_request_in_progress","booking_disabled","booking_requires_confirmation","slot_unavailable","rate_limited","rate_limit_unavailable","method_not_allowed","internal_error","business_required","key_owner_inactive","plan_limit_reached"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"022bc4cd-f113-4e78-895c-73c77becb307":{"description":"The request conflicts with the current state.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","forbidden","insufficient_scope","not_found","conflict","idempotency_key_reused","idempotency_request_in_progress","booking_disabled","booking_requires_confirmation","slot_unavailable","rate_limited","rate_limit_unavailable","method_not_allowed","internal_error","business_required","key_owner_inactive","plan_limit_reached"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"f37b56d0-0d0d-4e0b-9ab7-c68f0e6fe508":{"description":"Too many requests (rate_limited). Wait for the Retry-After header's number of seconds.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invalid_request","unauthorized","forbidden","insufficient_scope","not_found","conflict","idempotency_key_reused","idempotency_request_in_progress","booking_disabled","booking_requires_confirmation","slot_unavailable","rate_limited","rate_limit_unavailable","method_not_allowed","internal_error","business_required","key_owner_inactive","plan_limit_reached"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"additionalProperties":false,"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}},"exampleType":"generated"}},"security":{"184b1649-6209-46b9-aaac-b6c6e5b02fe5":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create. Only platform keys can hold businesses:create and users:create.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"d5067309-8f25-4e51-9859-b9f47141a1dd":{"url":"https://app.lobbystack.com/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create. Only platform keys can hold businesses:create and users:create.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create. Only platform keys can hold businesses:create and users:create.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"lobbystack","siteName":"LobbyStack","title":"Set the spending cap - LobbyStack","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/billing/set-the-spending-cap","matchLevel":0},"fr":{"href":"/fr/api-reference/billing/set-the-spending-cap","matchLevel":1},"es":{"href":"/es/api-reference/billing/set-the-spending-cap","matchLevel":1}}},"lastModified":"2026-10-22T19:25:57.906Z","originalFileLocation":"api-reference/billing/set-the-spending-cap.mdx","locale":"en"},"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=\"Sets or removes the cap on a Starter or Pro plan\u0026#x27;s usage over its allowance each month. Another plan is a 409.\">\u003cmeta data-mint-head name=\"application-name\" content=\"LobbyStack\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lobbystack/EJimo-tIIBnHZf4C/_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/lobbystack/EJimo-tIIBnHZf4C/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lobbystack/EJimo-tIIBnHZf4C/_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/lobbystack/EJimo-tIIBnHZf4C/_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/lobbystack/EJimo-tIIBnHZf4C/_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/lobbystack/EJimo-tIIBnHZf4C/_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/lobbystack/EJimo-tIIBnHZf4C/_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/lobbystack/EJimo-tIIBnHZf4C/_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/lobbystack/EJimo-tIIBnHZf4C/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Set the spending cap - LobbyStack\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sets or removes the cap on a Starter or Pro plan\u0026#x27;s usage over its allowance each month. Another plan is a 409.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LobbyStack\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lobbystack.com/api-reference/billing/set-the-spending-cap\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lobbystack.mintlify.app/_mintlify/api/og/v2?division=Billing\u0026amp;title=Set+the+spending+cap\u0026amp;description=Sets+or+removes+the+cap+on+a+Starter+or+Pro+plan%27s+usage+over+its+allowance+each+month.+Another+plan+is+a+409.\u0026amp;theme=18b1b0decc2451e1b7a6973b\u0026amp;signature=745981b3d498fabcc68960d299a7456d99ddb964e122c5ac1278efdecefde9e7\">\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=\"Set the spending cap - LobbyStack\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sets or removes the cap on a Starter or Pro plan\u0026#x27;s usage over its allowance each month. Another plan is a 409.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lobbystack.mintlify.app/_mintlify/api/og/v2?division=Billing\u0026amp;title=Set+the+spending+cap\u0026amp;description=Sets+or+removes+the+cap+on+a+Starter+or+Pro+plan%27s+usage+over+its+allowance+each+month.+Another+plan+is+a+409.\u0026amp;theme=18b1b0decc2451e1b7a6973b\u0026amp;signature=745981b3d498fabcc68960d299a7456d99ddb964e122c5ac1278efdecefde9e7\">\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/lobbystack/EJimo-tIIBnHZf4C/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"LobbyStack\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0B0B0D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lobbystack.com/api-reference/billing/set-the-spending-cap\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/billing/set-the-spending-cap.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.lobbystack.com/api-reference/billing/set-the-spending-cap\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.lobbystack.com/fr/api-reference/billing/set-the-spending-cap\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.lobbystack.com/es/api-reference/billing/set-the-spending-cap\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.lobbystack.com/api-reference/billing/set-the-spending-cap\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.lobbystack.com/#organization\",\"name\":\"LobbyStack\",\"url\":\"https://docs.lobbystack.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/lobbystack/U5lIHanZzQwzxaKz/logo.svg?fit=max\u0026auto=format\u0026n=U5lIHanZzQwzxaKz\u0026q=85\u0026s=f0ca27eea3705edeadc68d16f27acac3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lobbystack.com#website\",\"name\":\"LobbyStack\",\"url\":\"https://docs.lobbystack.com\",\"publisher\":{\"@id\":\"https://docs.lobbystack.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lobbystack.com/api-reference/billing/set-the-spending-cap#webpage\",\"url\":\"https://docs.lobbystack.com/api-reference/billing/set-the-spending-cap\",\"name\":\"Set the spending cap\",\"description\":\"Sets or removes the cap on a Starter or Pro plan's usage over its allowance each month. Another plan is a 409.\",\"dateModified\":\"2026-10-22T19:25:57.906Z\",\"isPartOf\":{\"@id\":\"https://docs.lobbystack.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lobbystack.com/api-reference/billing/set-the-spending-cap#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lobbystack.com/api-reference/billing/set-the-spending-cap#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.lobbystack.com/api-reference/business/check-an-api-key\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Billing\",\"item\":\"https://docs.lobbystack.com/api-reference/billing/get-the-plan-and-spending\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Set the spending cap\",\"item\":\"https://docs.lobbystack.com/api-reference/billing/set-the-spending-cap\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lobbystack.com/api-reference/billing/set-the-spending-cap#apireference\",\"headline\":\"Set the spending cap\",\"name\":\"Set the spending cap\",\"description\":\"Sets or removes the cap on a Starter or Pro plan's usage over its allowance each month. Another plan is a 409.\",\"url\":\"https://docs.lobbystack.com/api-reference/billing/set-the-spending-cap\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lobbystack.com/api-reference/billing/set-the-spending-cap#webpage\"},\"dateModified\":\"2026-10-22T19:25:57.906Z\",\"publisher\":{\"@id\":\"https://docs.lobbystack.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lobbystack.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"LobbyStack\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"LobbyStack","nav":{"global":null,"languages":[{"language":"en","default":true,"groups":[{"group":"Get started","pages":[{"title":"Understand LobbyStack","sidebarTitle":"Introduction","href":"/introduction"},{"title":"Set up LobbyStack","sidebarTitle":"Setup guide","href":"/quickstart"},{"title":"Create and secure your account","sidebarTitle":"Account setup","href":"/getting-started/account-setup"},{"title":"Claim a business phone number","sidebarTitle":"Claim your number","href":"/getting-started/claim-your-number"},{"title":"Forward your business line to LobbyStack","sidebarTitle":"Forward your calls","href":"/getting-started/forward-calls"},{"title":"Which countries can I get a number in?","sidebarTitle":"Available countries","href":"/getting-started/number-countries"}]},{"group":"General","pages":[{"title":"Review your workspace from Home","sidebarTitle":"Home","href":"/dashboard/home"},{"title":"Review calls and follow-up work","sidebarTitle":"Calls","href":"/dashboard/calls"},{"title":"Manage customer conversations","sidebarTitle":"Messages","href":"/dashboard/messages"},{"title":"Add the website widget","sidebarTitle":"Website widget","href":"/settings/widget"},{"title":"Manage contacts and consent","sidebarTitle":"Contacts","href":"/dashboard/contacts"},{"title":"Review upcoming appointments","sidebarTitle":"Appointments","href":"/dashboard/appointments"}]},{"group":"Agent","pages":[{"title":"Configure your AI receptionist","sidebarTitle":"Agent overview","href":"/agent/overview"},{"group":"AI settings","pages":[{"title":"Configure voice and behavior","sidebarTitle":"AI settings","href":"/agent/ai-settings/overview"},{"title":"Configure appointment changes","sidebarTitle":"Appointment changes","href":"/agent/ai-settings/appointment-changes"}]},{"title":"Add business knowledge","sidebarTitle":"Knowledge","href":"/agent/knowledge"},{"title":"Add bookable services","sidebarTitle":"Services","href":"/agent/services"},{"title":"Add employees callers can book","sidebarTitle":"Employees","href":"/agent/employees"},{"title":"Write receptionist rules","sidebarTitle":"Rules","href":"/agent/rules"}]},{"group":"Manage","pages":[{"title":"Review receptionist analytics","sidebarTitle":"Analytics","href":"/dashboard/analytics"},{"title":"Choose an integration","sidebarTitle":"Integrations","href":"/integrations/overview"},{"title":"Connect Google Calendar","sidebarTitle":"Google Calendar","href":"/integrations/google-calendar"},{"title":"Configure SMS alerts and consent","sidebarTitle":"SMS alerts and consent","href":"/integrations/sms"},{"title":"Set up webhooks","sidebarTitle":"Webhooks","href":"/integrations/webhooks"},{"group":"Settings","pages":[{"title":"Manage workspace settings","sidebarTitle":"Settings","href":"/settings/overview"},{"title":"Manage account security","sidebarTitle":"Account security","href":"/settings/account"},{"title":"Manage workspace members","sidebarTitle":"Team","href":"/settings/team"},{"title":"Configure workspace notifications","sidebarTitle":"Notifications","href":"/settings/notifications"},{"title":"Manage your business phone number","sidebarTitle":"Phone number","href":"/settings/phone-number"}]},{"group":"Billing","pages":[{"title":"Choose a plan and manage billing","sidebarTitle":"Plans and billing","href":"/billing/plans"},{"title":"Track usage and limits","sidebarTitle":"Usage and limits","href":"/billing/usage"},{"title":"Use the affiliate program","sidebarTitle":"Affiliate program","href":"/billing/affiliate-program"}]}]},{"group":"API","pages":[{"title":"LobbyStack API","sidebarTitle":"Overview","href":"/api/overview"},{"title":"Authenticate with API keys","sidebarTitle":"Authentication","href":"/api/authentication"},{"title":"Requests and errors","sidebarTitle":"Requests and errors","href":"/api/requests"},{"title":"Receive webhooks","sidebarTitle":"Webhooks","href":"/api/webhooks"},{"title":"Onboard a business from the command line","sidebarTitle":"Command line","href":"/api/cli"}]},{"group":"AI assistants","pages":[{"title":"Run your receptionist from an AI assistant","sidebarTitle":"MCP server","href":"/ai/mcp"},{"title":"Connect Claude","sidebarTitle":"Claude","href":"/ai/connect-claude"},{"title":"Connect ChatGPT and OpenAI agents","sidebarTitle":"ChatGPT","href":"/ai/connect-chatgpt"},{"title":"Connect other MCP clients","sidebarTitle":"Other clients","href":"/ai/connect-other-clients"},{"title":"LobbyStack skill for AI agents","sidebarTitle":"Skill for agents","href":"/ai/lobbystack-skill"}]},{"group":"API reference","pages":[{"group":"Business","pages":[{"title":"Check an API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /me","href":"/api-reference/business/check-an-api-key"},{"title":"Get the business","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /business","href":"/api-reference/business/get-the-business"},{"title":"Update the business","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /business","href":"/api-reference/business/update-the-business"},{"title":"List services","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /services","href":"/api-reference/business/list-services"},{"title":"Add a service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /services","href":"/api-reference/business/add-a-service"},{"title":"Delete a service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /services/{service_id}","href":"/api-reference/business/delete-a-service"},{"title":"Update a service","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /services/{service_id}","href":"/api-reference/business/update-a-service"},{"title":"List staff","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /staff","href":"/api-reference/business/list-staff"}]},{"group":"Platform","pages":[{"title":"List onboarded businesses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /businesses","href":"/api-reference/platform/list-onboarded-businesses"},{"title":"Create a business","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /businesses","href":"/api-reference/platform/create-a-business"},{"title":"Invite an owner to make an account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /users","href":"/api-reference/platform/invite-an-owner-to-make-an-account"}]},{"group":"Receptionist","pages":[{"title":"Get the receptionist settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /receptionist","href":"/api-reference/receptionist/get-the-receptionist-settings"},{"title":"Update the receptionist settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /receptionist","href":"/api-reference/receptionist/update-the-receptionist-settings"},{"title":"List rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rules","href":"/api-reference/receptionist/list-rules"},{"title":"Add a rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rules","href":"/api-reference/receptionist/add-a-rule"},{"title":"Delete a rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /rules/{rule_id}","href":"/api-reference/receptionist/delete-a-rule"},{"title":"Update a rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /rules/{rule_id}","href":"/api-reference/receptionist/update-a-rule"},{"title":"Put the rules in order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rules/reorder","href":"/api-reference/receptionist/put-the-rules-in-order"}]},{"group":"Billing","pages":[{"title":"Get the plan and spending","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /billing","href":"/api-reference/billing/get-the-plan-and-spending"},{"title":"Set the spending cap","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /billing","href":"/api-reference/billing/set-the-spending-cap"},{"title":"Start a checkout","description":"Asks Polar for a page where the customer pays for a plan. Poll GET /billing/checkout/{checkout_id} until status is ready, then send them checkout_url. As in the dashboard, only a business on the free plan can start one, and only while nobody else's checkout for it is open; a business that already pays changes plan in Polar's billing portal. Those, a managed plan and a plan this deployment doesn't sell are a 409. With a platform key the checkout is made out to the business's owner, so a business nobody has claimed yet is a 409.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/checkout","href":"/api-reference/billing/start-a-checkout"},{"title":"Check a checkout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /billing/checkout/{checkout_id}","href":"/api-reference/billing/check-a-checkout"},{"title":"Put the business on a managed plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/managed-plan","href":"/api-reference/billing/put-the-business-on-a-managed-plan"},{"title":"End the managed plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /billing/managed-plan","href":"/api-reference/billing/end-the-managed-plan"}]},{"group":"Phone numbers","pages":[{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"title":"Find numbers to claim","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /phone-numbers/search","href":"/api-reference/phone-numbers/find-numbers-to-claim"},{"title":"Claim a number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /phone-numbers/claims","href":"/api-reference/phone-numbers/claim-a-number"},{"title":"Check a claim","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers/claims/{claim_id}","href":"/api-reference/phone-numbers/check-a-claim"},{"title":"Release a number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /phone-numbers/{phone_number_id}","href":"/api-reference/phone-numbers/release-a-number"},{"title":"Replace a number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /phone-numbers/{phone_number_id}/replace","href":"/api-reference/phone-numbers/replace-a-number"}]},{"group":"Onboarding","pages":[{"title":"Get onboarding progress","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /onboarding","href":"/api-reference/onboarding/get-onboarding-progress"},{"title":"Skip setup steps","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /onboarding","href":"/api-reference/onboarding/skip-setup-steps"},{"title":"Finish onboarding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboarding/complete","href":"/api-reference/onboarding/finish-onboarding"}]},{"group":"Team","pages":[{"title":"Get the team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /team","href":"/api-reference/team/get-the-team"},{"title":"Invite someone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /team/invitations","href":"/api-reference/team/invite-someone"},{"title":"Revoke an invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /team/invitations/{invitation_id}","href":"/api-reference/team/revoke-an-invitation"},{"title":"Remove someone from the team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /team/members/{membership_id}","href":"/api-reference/team/remove-someone-from-the-team"},{"title":"Change someone's role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /team/members/{membership_id}","href":"/api-reference/team/change-someones-role"},{"title":"Hand the business over","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /team/claim-link","href":"/api-reference/team/hand-the-business-over"}]},{"group":"Website chat","pages":[{"title":"List widget keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /widget-keys","href":"/api-reference/website-chat/list-widget-keys"},{"title":"Add the chat widget to a website","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /widget-keys","href":"/api-reference/website-chat/add-the-chat-widget-to-a-website"},{"title":"Update a widget key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /widget-keys/{widget_key_id}","href":"/api-reference/website-chat/update-a-widget-key"}]},{"group":"Calendars","pages":[{"title":"Get a link that connects Google Calendar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /calendars/google/connect","href":"/api-reference/calendars/get-a-link-that-connects-google-calendar"},{"title":"List calendar connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calendars","href":"/api-reference/calendars/list-calendar-connections"},{"title":"List a connected account's calendars","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calendars/{connection_id}/calendars","href":"/api-reference/calendars/list-a-connected-accounts-calendars"},{"title":"Disconnect a calendar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /calendars/{connection_id}","href":"/api-reference/calendars/disconnect-a-calendar"},{"title":"Pick a calendar or a staff member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /calendars/{connection_id}","href":"/api-reference/calendars/pick-a-calendar-or-a-staff-member"}]},{"group":"Notifications","pages":[{"title":"Get alert settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notification-preferences","href":"/api-reference/notifications/get-alert-settings"},{"title":"Change alert settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /notification-preferences","href":"/api-reference/notifications/change-alert-settings"}]},{"group":"Calls","pages":[{"title":"List calls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls","href":"/api-reference/calls/list-calls"},{"title":"Get a call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{call_id}","href":"/api-reference/calls/get-a-call"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contacts/{contact_id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /contacts/{contact_id}","href":"/api-reference/contacts/update-a-contact"},{"title":"Set or remove keypad PINs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /contacts/passcodes","href":"/api-reference/contacts/set-or-remove-keypad-pins"},{"title":"Generate keypad PINs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /contacts/passcodes/generate","href":"/api-reference/contacts/generate-keypad-pins"}]},{"group":"Appointments","pages":[{"title":"List appointments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /appointments","href":"/api-reference/appointments/list-appointments"},{"title":"Book an appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /appointments","href":"/api-reference/appointments/book-an-appointment"},{"title":"List open appointment times","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /availability","href":"/api-reference/appointments/list-open-appointment-times"},{"title":"Get an appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /appointments/{appointment_id}","href":"/api-reference/appointments/get-an-appointment"},{"title":"Cancel an appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /appointments/{appointment_id}/cancel","href":"/api-reference/appointments/cancel-an-appointment"},{"title":"Reschedule an appointment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /appointments/{appointment_id}/reschedule","href":"/api-reference/appointments/reschedule-an-appointment"}]},{"group":"Messages","pages":[{"title":"List messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /messages","href":"/api-reference/messages/list-messages"}]},{"group":"Knowledge","pages":[{"title":"List knowledge entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /knowledge","href":"/api-reference/knowledge/list-knowledge-entries"},{"title":"Add a knowledge entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge","href":"/api-reference/knowledge/add-a-knowledge-entry"},{"title":"Get a knowledge entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /knowledge/{entry_id}","href":"/api-reference/knowledge/get-a-knowledge-entry"},{"title":"Delete a knowledge entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /knowledge/{entry_id}","href":"/api-reference/knowledge/delete-a-knowledge-entry"},{"title":"Update a knowledge entry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /knowledge/{entry_id}","href":"/api-reference/knowledge/update-a-knowledge-entry"},{"title":"List knowledge sources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /knowledge/sources","href":"/api-reference/knowledge/list-knowledge-sources"},{"title":"Add a website","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge/sources","href":"/api-reference/knowledge/add-a-website"},{"title":"Get a knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /knowledge/sources/{source_id}","href":"/api-reference/knowledge/get-a-knowledge-source"},{"title":"Delete a knowledge source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /knowledge/sources/{source_id}","href":"/api-reference/knowledge/delete-a-knowledge-source"},{"title":"Turn a knowledge source off or on","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /knowledge/sources/{source_id}","href":"/api-reference/knowledge/turn-a-knowledge-source-off-or-on"},{"title":"Read the rest of a website","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge/sources/{source_id}/expand","href":"/api-reference/knowledge/read-the-rest-of-a-website"},{"title":"Read a source again","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge/sources/{source_id}/retry","href":"/api-reference/knowledge/read-a-source-again"},{"title":"Start a file upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge/uploads","href":"/api-reference/knowledge/start-a-file-upload"},{"title":"Finish a file upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge/uploads/{upload_id}/complete","href":"/api-reference/knowledge/finish-a-file-upload"},{"title":"Stop reading a source","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge/sources/{source_id}/cancel","href":"/api-reference/knowledge/stop-reading-a-source"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/{webhook_id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /webhooks/{webhook_id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /webhooks/{webhook_id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/{webhook_id}/test","href":"/api-reference/webhooks/send-a-test-event"}]},{"group":"API Reference","pages":[{"title":"Callcompleted","version":null,"deprecated":null,"openapi":"/api-reference/openapi.json webhook call.completed","href":"/api-reference/callcompleted"},{"title":"Appointmentbooked","version":null,"deprecated":null,"openapi":"/api-reference/openapi.json webhook appointment.booked","href":"/api-reference/appointmentbooked"},{"title":"Appointmentrescheduled","version":null,"deprecated":null,"openapi":"/api-reference/openapi.json webhook appointment.rescheduled","href":"/api-reference/appointmentrescheduled"},{"title":"Appointmentcancelled","version":null,"deprecated":null,"openapi":"/api-reference/openapi.json webhook appointment.cancelled","href":"/api-reference/appointmentcancelled"},{"title":"Messagetaken","version":null,"deprecated":null,"openapi":"/api-reference/openapi.json webhook message.taken","href":"/api-reference/messagetaken"},{"title":"Contactcreated","version":null,"deprecated":null,"openapi":"/api-reference/openapi.json webhook contact.created","href":"/api-reference/contactcreated"},{"title":"Webhooktest","version":null,"deprecated":null,"openapi":"/api-reference/openapi.json webhook webhook.test","href":"/api-reference/webhooktest"}]}]},{"group":"Self-hosting","pages":[{"title":"Understand self-hosting","sidebarTitle":"Self-hosting overview","href":"/self-hosting/overview"},{"title":"Deploy with Docker Compose","sidebarTitle":"Docker Compose","href":"/self-hosting/docker-compose"},{"title":"Configure environment variables","sidebarTitle":"Environment variables","href":"/self-hosting/environment-variables"},{"title":"Configure third-party providers","sidebarTitle":"Third-party providers","href":"/self-hosting/providers"}]}]},{"language":"fr","navbar":{"links":[{"href":"https://lobbystack.com/fr/","label":"Lobbystack.com"},{"icon":"github","href":"https://github.com/lobbystack/lobbystack","label":""},{"href":"https://app.lobbystack.com/fr/login","label":"Se connecter"}],"primary":{"type":"button","label":"Essayer gratuitement","href":"https://app.lobbystack.com/fr/signup"}},"pages":[{"title":"fr","href":"/fr/api-reference/billing/set-the-spending-cap"}]},{"language":"es","navbar":{"links":[{"href":"https://lobbystack.com/es/","label":"Lobbystack.com"},{"icon":"github","href":"https://github.com/lobbystack/lobbystack","label":""},{"href":"https://app.lobbystack.com/es/login","label":"Iniciar sesión"}],"primary":{"type":"button","label":"Pruébelo gratis","href":"https://app.lobbystack.com/es/signup"}},"pages":[{"title":"es","href":"/es/api-reference/billing/set-the-spending-cap"}]}]},"title":"Set the spending cap - LobbyStack","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}