Filter presentation_breakdowns by a JSON-encoded array of presentation group key values. Only breakdowns matching the provided values will be returned. Pass an empty array to disable presentation_breakdowns entirely.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Lago","description":"Developer documentation for Lago, the open-source billing platform for usage metering, subscriptions, invoicing, payments, and revenue operations.","colors":{"primary":"#006CFA","light":"#006CFA","dark":"#006CFA"},"logo":{"light":"https://mintcdn.com/lago-docs/zZSJbpe68PHhSs3x/logo/light.svg?fit=max\u0026auto=format\u0026n=zZSJbpe68PHhSs3x\u0026q=85\u0026s=b4af3001527c985b81858b9a0928534c","dark":"https://mintcdn.com/lago-docs/zZSJbpe68PHhSs3x/logo/dark.svg?fit=max\u0026auto=format\u0026n=zZSJbpe68PHhSs3x\u0026q=85\u0026s=1eb7aacac796b0cc6bf05be790a792b1"},"favicon":"https://mintcdn.com/lago-docs/8N-yOElNGe9jRGG5/favicon.svg?fit=max\u0026auto=format\u0026n=8N-yOElNGe9jRGG5\u0026q=85\u0026s=5c319e58dd9b5c5b8a31cf2ad8009a1c","api":{"openapi":"https://swagger.getlago.com/openapi.yaml","mdx":{"server":"https://api.getlago.com/api/v1"}},"background":{"color":{"light":"#F5F5EF","dark":"#131923"}},"navbar":{"links":[{"href":"https://getlago.com/book-a-demo","label":"Book a Demo"}],"primary":{"type":"button","label":"Get Started","href":"https://getlago.com/book-a-demo"}},"footer":{"socials":{"github":"https://github.com/getlago/lago","slack":"https://getlago.com/slack","x":"https://x.com/getlago","linkedin":"https://www.linkedin.com/company/getlago","youtube":"https://www.youtube.com/channel/UCp6ltp7n3SgDVsmerJ7O7ZA"},"links":[{"header":"Documentation","items":[{"label":"Get started","href":"https://getlago.com/docs/guide/introduction/welcome-to-lago"},{"label":"API reference","href":"https://getlago.com/docs/api-reference/intro"},{"label":"Integrations","href":"https://getlago.com/docs/integrations/introduction"},{"label":"Templates","href":"https://getlago.com/docs/templates/introduction"},{"label":"Changelog","href":"https://getlago.com/docs/changelog/product"},{"label":"FAQ","href":"https://getlago.com/docs/faq/about-lago"}]},{"header":"Developers","items":[{"label":"Developer hub","href":"https://getlago.com/docs/developers"},{"label":"Authentication","href":"https://getlago.com/docs/auth"},{"label":"Webhooks","href":"https://getlago.com/docs/guide/webhooks"},{"label":"SDKs","href":"https://getlago.com/docs/developers"},{"label":"OpenAPI spec","href":"https://swagger.getlago.com/"},{"label":"MCP server","href":"https://getlago.com/docs/guide/ai-agents/mcp-server"},{"label":"Self-hosted","href":"https://getlago.com/docs/guide/lago-self-hosted/overview"},{"label":"llms.txt","href":"https://getlago.com/docs/llms.txt"}]},{"header":"Platform","items":[{"label":"Usage metering","href":"https://getlago.com/platform/usage-metering"},{"label":"Billing \u0026 invoicing","href":"https://getlago.com/platform/billing-invoicing"},{"label":"Cash collection","href":"https://getlago.com/platform/cash-collection"},{"label":"Revenue analytics","href":"https://getlago.com/platform/revenue-analytics"},{"label":"Entitlements","href":"https://getlago.com/platform/entitlements"},{"label":"Lago AI","href":"https://getlago.com/platform/ai"},{"label":"Pricing","href":"https://getlago.com/pricing"}]},{"header":"Company","items":[{"label":"About Lago","href":"https://getlago.com/docs/about"},{"label":"Customers","href":"https://getlago.com/customers"},{"label":"Blog","href":"https://getlago.com/blog"},{"label":"Contact","href":"https://getlago.com/docs/contact"},{"label":"Trust center","href":"https://security.getlago.com"},{"label":"Status","href":"https://status.getlago.com"}]}]},"seo":{"metatags":{"canonical":"https://getlago.com/docs","description":"Developer documentation for Lago's API-first billing platform, including OpenAPI, SDKs, webhooks, MCP, authentication, and implementation guides.","keywords":"Lago API, billing API, usage metering API, OpenAPI, billing SDK, Lago MCP"},"organization":{"id":"https://getlago.com/#organization","name":"Lago","legalName":"Get Lago Corp.","url":"https://getlago.com","logo":"https://getlago.com/docs/logo/light.svg","sameAs":["https://github.com/getlago","https://www.linkedin.com/company/getlago","https://x.com/GetLago","https://www.youtube.com/channel/UCp6ltp7n3SgDVsmerJ7O7ZA"]},"indexing":"all"},"fonts":{"heading":{"family":"GT America","weight":700,"source":"fonts/GT-America-Standard-Medium.woff2","format":"woff2"},"body":{"family":"GT America","source":"fonts/GT-America-Standard-Regular.woff2","format":"woff2"}},"styling":{"codeblocks":"dark","latex":true},"integrations":{"ga4":{"measurementId":"G-743BQ9THCG"},"cookies":{"key":"lago_docs_analytics","value":"granted"}},"errors":{"404":{"redirect":false,"title":"Documentation page not found","description":"No Lago documentation exists at this URL. Start at [Lago Developer Documentation](/welcome), browse [Developer Resources](/developers), inspect the [documentation index](/llms.txt) or [sitemap](/sitemap.xml), or search the [API reference](/api-reference/intro)."}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://getlago.com/blog"},{"anchor":"Community","icon":"slack","href":"https://getlago.com/slack"},{"anchor":"GitHub","icon":"github","href":"https://github.com/getlago/lago"},{"anchor":"Status","icon":"signal-bars","href":"https://status.getlago.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lago-docs","hasAudioNarration":false,"actualSubdomain":"lago-docs","customDomains":["getlago.com"],"gitSource":{"type":"github","owner":"getlago","repo":"lago-doc","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf4e12d7cf896c8ad837f6","collectionId":"ef513b95-75bf-42ca-a474-434543e00351","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf4e12d7cf896c8ad837f6"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adf4e12d7cf896c8ad837f6","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API References","count":235},{"language":"default","tag":"API Reference","count":235},{"language":"default","tag":"Guide","count":198},{"language":"default","tag":"Integrations","count":54},{"language":"default","tag":"Plans","count":46},{"language":"default","tag":"Resources","count":44},{"language":"default","tag":"Charges","count":39},{"language":"default","tag":"Pricing \u0026 Subscriptions","count":35},{"language":"default","tag":"Subscriptions","count":31},{"language":"default","tag":"Invoices","count":27}]},"assistantConfig":{},"basePath":"/docs","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":"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":"workos-sso-scim","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-enabled","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html{visibility:hidden;background-color:#f5f5ef}@media (prefers-color-scheme:dark){html{background-color:#131923}}html.ready{visibility:visible}.dark .welcome-card{background-color:#1c2535!important;border-color:rgba(255,255,255,.1)!important;box-shadow:0 1px 2px 0 rgba(0,0,0,.3)!important;color:#e5e7eb}.dark .welcome-card:hover{background-color:#243044!important}.dark #changelog-month-nav .changelog-month-nav__list a:hover,.dark .welcome-card h3{color:#fff}.dark .welcome-card p{color:#9ca3af!important}#changelog-month-nav{padding-left:2.5rem;width:19rem;box-sizing:border-box;margin-bottom:1.75rem;max-height:45vh;overflow-y:auto}#changelog-month-nav .changelog-month-nav__year{margin:0 0 .5rem;font-size:.875rem;line-height:1.5rem;font-weight:500;color:#364152}#changelog-month-nav .changelog-month-nav__list{list-style:none;margin:0;padding:0;border-left:1px solid rgba(0,0,0,.08)}#changelog-month-nav .changelog-month-nav__list a{display:block;padding:.25rem 0 .25rem .75rem;margin-left:-1px;border-left:1px solid transparent;font-size:.875rem;line-height:1.5rem;color:#697586;text-decoration:none;transition:color .15s ease,border-color .15s ease}#changelog-month-nav .changelog-month-nav__list a:hover{color:#121926}#changelog-month-nav .changelog-month-nav__list a.is-active{color:#006cfa;border-left-color:#006cfa;font-weight:500}.dark #changelog-month-nav .changelog-month-nav__year{color:#cdd5df}.dark #changelog-month-nav .changelog-month-nav__list{border-left-color:rgba(255,255,255,.12)}.dark #changelog-month-nav .changelog-month-nav__list a{color:#9aa4b2}.dark #changelog-month-nav .changelog-month-nav__list a.is-active{color:#4d9bff;border-left-color:#4d9bff}.update-container>div:first-child{display:none}.update-container>div:nth-child(2){flex:1 1 100%;max-width:100%;width:100%}.update-container{gap:0}#footer a[href*=\"utm_campaign=poweredBy\"]{display:none}"}],"page":{"pagePath":"api-reference/customer-usage/get-projected","slug":"/api-reference/customer-usage/get-projected","pageMetadata":{"openapi":"GET /customers/{external_customer_id}/projected_usage","authMethod":"bearer","title":"Retrieve projected usage","description":"Retrieve real-time projected usage data for the current open billing period.","href":"/api-reference/customer-usage/get-projected"},"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: \"Retrieve real-time projected usage data for the current open billing period.\"\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":{"codeStyling":"dark","config":{},"pageMetadata":{"openapi":"GET /customers/{external_customer_id}/projected_usage","authMethod":"bearer","title":"Retrieve projected usage","description":"Retrieve real-time projected usage data for the current open billing period.","href":"/api-reference/customer-usage/get-projected"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/lago-docs/a0e77058367d9146/canonical.js","/docs/_mintlify/custom/lago-docs/fa2446312177e9c6/loader.js","/docs/_mintlify/custom/lago-docs/c55d8403f7fc83ad/changelog-anchor-redirect.js","/docs/_mintlify/custom/lago-docs/8c326c8b67b47933/changelog-month-nav.js","/docs/_mintlify/custom/lago-docs/103c90943d27f62a/webmcp.js","/docs/_mintlify/custom/lago-docs/1219fb859e5c496e/github-outbound.js"],"openApiReferenceData":{"operation":{"tags":["customers"],"summary":"Retrieve customer current and projected usage","description":"Retrieve real-time projected usage data for the current open billing period.","parameters":["a4a11275-d8bd-4f69-8e3c-94da1f53155f","1052d3bf-daaf-4cea-96f8-681d88c5d329","940d7eb4-fcff-4146-8911-a29e38aeeda6","174fd338-e4f6-4fb9-a7f5-d9540ad231c6","f38689a7-9c87-4cb7-9378-ae73b62463af","a717377d-814c-4e9f-a9ce-0086e5a8687f","930b31f5-32d7-45b3-9356-b95120022ae2","37600243-eab0-46eb-a0d6-f1fc60536ca7"],"operationId":"findCustomerProjectedUsage","responses":{"200":"4d1802d8-e694-41a0-84d7-700f71ae4233","401":"b36361f8-9451-44a6-bd9b-ae2446676cd7","403":"191cb6ce-5693-4aaa-9bd4-07eb6884dd54","404":"2b859b60-4ba4-48f7-869c-1956eab8b242","405":"ce067a5d-8e4b-4eb8-8c6c-dfb6a340f86d"},"method":"get","type":"path","servers":["8acb974b-84ea-4ba8-8f1b-6bb856b1dc1f","75be9aa2-d642-43b0-860c-fd15dc223a9e"],"security":["74776f71-77a9-46c5-8da8-e9de8d8550cc"],"path":"/customers/{external_customer_id}/projected_usage","baseUrlOptions":["https://api.getlago.com/api/v1","https://api.eu.getlago.com/api/v1"],"title":"Retrieve customer current and projected usage","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a4a11275-d8bd-4f69-8e3c-94da1f53155f":{"name":"external_customer_id","in":"path","description":"The customer external unique identifier (provided by your own application).","required":true,"schema":{"type":"string","example":"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba","isRequired":true,"description":"The customer external unique identifier (provided by your own application).","uniqueKey":"","typeLabel":"string"}},"1052d3bf-daaf-4cea-96f8-681d88c5d329":{"name":"external_subscription_id","in":"query","description":"The unique identifier of the subscription within your application.","required":true,"explode":true,"schema":{"type":"string","example":"sub_1234567890","isRequired":true,"description":"The unique identifier of the subscription within your application.","uniqueKey":"","typeLabel":"string"}},"940d7eb4-fcff-4146-8911-a29e38aeeda6":{"name":"apply_taxes","in":"query","description":"Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null.\n","required":false,"schema":{"type":"boolean","default":true,"example":true,"isRequired":false,"description":"Optional flag to determine if taxes should be applied. Defaults to `true` if not provided or if null.\n","uniqueKey":"","typeLabel":"boolean"}},"174fd338-e4f6-4fb9-a7f5-d9540ad231c6":{"name":"charge_id","in":"query","description":"Filter usage to a specific charge by its Lago ID (UUID).","required":false,"schema":{"type":"string","format":"uuid","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","isRequired":false,"description":"Filter usage to a specific charge by its Lago ID (UUID).","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"f38689a7-9c87-4cb7-9378-ae73b62463af":{"name":"charge_code","in":"query","description":"Filter usage to a specific charge by its code.","required":false,"schema":{"type":"string","example":"storage","isRequired":false,"description":"Filter usage to a specific charge by its code.","uniqueKey":"","typeLabel":"string"}},"a717377d-814c-4e9f-a9ce-0086e5a8687f":{"name":"billable_metric_code","in":"query","description":"Filter usage to a specific billable metric by its code.","required":false,"schema":{"type":"string","example":"storage","isRequired":false,"description":"Filter usage to a specific billable metric by its code.","uniqueKey":"","typeLabel":"string"}},"930b31f5-32d7-45b3-9356-b95120022ae2":{"name":"group","in":"query","description":"Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `group[cloud]=aws`.\n","required":false,"style":"deepObject","explode":true,"schema":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"additionalProperties","typeLabel":"string"},"example":{"cloud":"aws"},"isRequired":false,"description":"Filter usage by pricing group. Pass key/value pairs as query parameters, e.g. `group[cloud]=aws`.\n","uniqueKey":"","typeLabel":"object"}},"37600243-eab0-46eb-a0d6-f1fc60536ca7":{"name":"filter_by_presentation","in":"query","description":"Filter `presentation_breakdowns` by a JSON-encoded array of presentation group key values. Only breakdowns matching the provided values will be returned. Pass an empty array to disable `presentation_breakdowns` entirely.\n","required":false,"schema":{"type":"string","example":"[\"engineering\", \"operations\"]","isRequired":false,"description":"Filter `presentation_breakdowns` by a JSON-encoded array of presentation group key values. Only breakdowns matching the provided values will be returned. Pass an empty array to disable `presentation_breakdowns` entirely.\n","uniqueKey":"","typeLabel":"string"}}},"responses":{"4d1802d8-e694-41a0-84d7-700f71ae4233":{"description":"Customer usage","content":{"application/json":{"schema":{"type":"object","required":["customer_projected_usage"],"properties":{"customer_projected_usage":{"type":"object","required":["from_datetime","to_datetime","issuing_date","lago_invoice_id","currency","amount_cents","projected_amount_cents","taxes_amount_cents","total_amount_cents","charges_usage"],"properties":{"from_datetime":{"type":"string","format":"date-time","description":"The lower bound of the billing period, expressed in the ISO 8601 datetime format in Coordinated Universal Time (UTC).","example":"2022-07-01T00:00:00Z","isRequired":true,"uniqueKey":"customer_projected_usage.from_datetime","typeLabel":"string\u003cdate-time>"},"to_datetime":{"type":"string","format":"date-time","description":"The upper bound of the billing period, expressed in the ISO 8601 datetime format in Coordinated Universal Time (UTC).","example":"2022-07-31T23:59:59Z","isRequired":true,"uniqueKey":"customer_projected_usage.to_datetime","typeLabel":"string\u003cdate-time>"},"issuing_date":{"type":"string","format":"date","description":"The date of creation of the invoice.","example":"2022-08-01","isRequired":true,"uniqueKey":"customer_projected_usage.issuing_date","typeLabel":"string\u003cdate>"},"lago_invoice_id":{"oneOf":[{"type":"string","format":"uuid","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","description":"A unique identifier associated with the invoice related to this particular usage record. It is always `null` here, because the projected usage is not attached to an invoice.","isRequired":true,"uniqueKey":"customer_projected_usage.lago_invoice_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","description":"A unique identifier associated with the invoice related to this particular usage record. It is always `null` here, because the projected usage is not attached to an invoice.","isRequired":true,"uniqueKey":"customer_projected_usage.lago_invoice_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"customer_projected_usage.lago_invoice_id","typeLabel":"string\u003cuuid> | null"},"currency":{"type":"string","example":"EUR","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BIF","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","ISK","JMD","JPY","KES","KGS","KHR","KMF","KRW","KYD","KZT","LAK","LBP","LKR","LRD","LSL","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW"],"description":"The currency of the customer's current usage.","isRequired":true,"uniqueKey":"customer_projected_usage.currency","typeLabel":"enum\u003cstring>"},"amount_cents":{"type":"integer","description":"The amount in cents, tax excluded.","example":123,"isRequired":true,"uniqueKey":"customer_projected_usage.amount_cents","typeLabel":"integer"},"projected_amount_cents":{"type":"integer","description":"The projected amount in cents, tax excluded.","example":256,"isRequired":true,"uniqueKey":"customer_projected_usage.projected_amount_cents","typeLabel":"integer"},"taxes_amount_cents":{"type":"integer","description":"The tax amount in cents.","example":200,"isRequired":true,"uniqueKey":"customer_projected_usage.taxes_amount_cents","typeLabel":"integer"},"total_amount_cents":{"type":"integer","description":"The total amount in cents, tax included.","example":123,"isRequired":true,"uniqueKey":"customer_projected_usage.total_amount_cents","typeLabel":"integer"},"charges_usage":{"type":"array","description":"Array of charges that comprise the current usage. It contains detailed information about individual charge items associated with the usage.","items":{"type":"object","required":["units","projected_units","events_count","amount_cents","projected_amount_cents","amount_currency","charge","billable_metric","grouped_usage"],"properties":{"units":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","example":"1.0","description":"The number of units consumed by the customer for a specific charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].units","typeLabel":"string"},"projected_units":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","example":"2.0","description":"The projected number of units that can be consumed by the customer for a specific charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].projected_units","typeLabel":"string"},"events_count":{"type":"integer","example":10,"description":"The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].events_count","typeLabel":"integer"},"amount_cents":{"type":"integer","example":123,"description":"The amount in cents, tax excluded, consumed by the customer for a specific charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].amount_cents","typeLabel":"integer"},"projected_amount_cents":{"type":"integer","example":256,"description":"The projected amount in cents, tax excluded, that can be consumed by the customer for a specific charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].projected_amount_cents","typeLabel":"integer"},"amount_currency":{"type":"string","example":"EUR","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BIF","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","ISK","JMD","JPY","KES","KGS","KHR","KMF","KRW","KYD","KZT","LAK","LBP","LKR","LRD","LSL","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW"],"description":"The currency of a usage item consumed by the customer.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].amount_currency","typeLabel":"enum\u003cstring>"},"charge":{"type":"object","description":"Object listing all the properties for a specific charge item.","required":["lago_id","charge_model"],"properties":{"lago_id":{"type":"string","format":"uuid","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","description":"Unique identifier assigned to the charge within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the charge's record within the Lago system.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].charge.lago_id","typeLabel":"string\u003cuuid>"},"charge_model":{"type":"string","description":"Specifies the pricing model used for the calculation of the final fee. It can be any of the following values:\n - [`dynamic`](https://docs.getlago.com/guide/plans/charges/charge-models/dynamic)\n - [`graduated_percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated-percentage)\n - [`graduated`](https://docs.getlago.com/guide/plans/charges/charge-models/graduated)\n - [`package`](https://docs.getlago.com/guide/plans/charges/charge-models/package)\n - [`percentage`](https://docs.getlago.com/guide/plans/charges/charge-models/percentage)\n - [`standard`](https://docs.getlago.com/guide/plans/charges/charge-models/standard)\n - [`volume`](https://docs.getlago.com/guide/plans/charges/charge-models/volume)\n","enum":["dynamic","graduated","graduated_percentage","package","percentage","standard","volume"],"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].charge.charge_model","typeLabel":"enum\u003cstring>"},"invoice_display_name":{"oneOf":[{"type":"string","description":"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.","example":"Setup","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].charge.invoice_display_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.","example":"Setup","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].charge.invoice_display_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].charge.invoice_display_name","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].charge","typeLabel":"object"},"billable_metric":{"type":"object","description":"The related billable metric object.","required":["lago_id","name","code","aggregation_type"],"properties":{"lago_id":{"type":"string","format":"uuid","example":"1a901a90-1a90-1a90-1a90-1a901a901a90","description":"Unique identifier assigned to the billable metric within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the billable metric's record within the Lago system.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].billable_metric.lago_id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","example":"Storage","description":"The name of the billable metric used for this charge.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].billable_metric.name","typeLabel":"string"},"code":{"type":"string","example":"storage","description":"The code of the billable metric used for this charge.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].billable_metric.code","typeLabel":"string"},"aggregation_type":{"type":"string","description":"The aggregation type of the billable metric used for this charge.","enum":["count_agg","sum_agg","max_agg","unique_count_agg","weighted_sum_agg","latest_agg"],"example":"sum_agg","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].billable_metric.aggregation_type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].billable_metric","typeLabel":"object"},"grouped_usage":{"type":"array","description":"Array of aggregated fees, grouped by the event properties defined in a `standard` charge model.","items":{"type":"object","required":["amount_cents","projected_amount_cents","events_count","units","projected_units","grouped_by"],"properties":{"amount_cents":{"type":"integer","example":1000,"description":"The amount in cents, tax excluded, consumed for a specific group related to a charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].amount_cents","typeLabel":"integer"},"projected_amount_cents":{"type":"integer","example":2000,"description":"The projected amount in cents, tax excluded, that can be consumed for a specific group related to a charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].projected_amount_cents","typeLabel":"integer"},"events_count":{"type":"integer","example":10,"description":"The quantity of usage events that have been recorded for a particular charge during the specified time period. These events may also be referred to as the number of transactions in some contexts.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].events_count","typeLabel":"integer"},"units":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","example":"0.9","description":"The number of units consumed for a specific group related to a charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].units","typeLabel":"string"},"projected_units":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","example":"1.8","description":"The projected number of units that can be consumed for a specific group related to a charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].projected_units","typeLabel":"string"},"grouped_by":{"type":"object","description":"Key value list of event properties aggregated by the charge model","additionalProperties":{"type":"string","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].grouped_by.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].grouped_by","typeLabel":"object"},"pricing_unit_details":{"oneOf":[{"type":"object","required":["amount_cents","short_name","conversion_rate"],"description":"Details about the pricing unit used for charge usage.","properties":{"amount_cents":{"type":"integer","description":"The amount in cents in the pricing unit.","example":200,"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].pricing_unit_details.oneOf.0.amount_cents","typeLabel":"integer"},"short_name":{"type":"string","example":"CR","description":"The short name of the pricing unit.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].pricing_unit_details.oneOf.0.short_name","typeLabel":"string"},"conversion_rate":{"type":"string","description":"The conversion rate from pricing units to the plan's currency.","example":"0.5","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].pricing_unit_details.oneOf.0.conversion_rate","typeLabel":"string"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].pricing_unit_details.oneOf.0","typeLabel":"object"},{"type":"null","required":["amount_cents","short_name","conversion_rate"],"description":"Details about the pricing unit used for charge usage.","properties":{"amount_cents":{"type":"integer","description":"The amount in cents in the pricing unit.","example":200},"short_name":{"type":"string","example":"CR","description":"The short name of the pricing unit."},"conversion_rate":{"type":"string","description":"The conversion rate from pricing units to the plan's currency.","example":"0.5"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].pricing_unit_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].pricing_unit_details","typeLabel":"object | null"},"filters":{"type":"array","description":"Array of filter object, representing multiple dimensions for a charge item.","items":{"type":"object","required":["values","units","projected_units","events_count","amount_cents","projected_amount_cents"],"properties":{"units":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","example":"0.9","description":"The number of units consumed for a specific charge filter related to a charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].units","typeLabel":"string"},"projected_units":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","example":"1.8","description":"The projected number of units that can be consumed for a specific charge filter related to a charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].projected_units","typeLabel":"string"},"amount_cents":{"type":"integer","example":1000,"description":"The amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].amount_cents","typeLabel":"integer"},"projected_amount_cents":{"type":"integer","example":2000,"description":"The projected amount in cents, tax excluded, that can be consumed for a specific charge filter related to a charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].projected_amount_cents","typeLabel":"integer"},"events_count":{"type":"integer","example":10,"description":"The quantity of usage events that have been recorded for a particular charge filter during the specified time period. These events may also be referred to as the number of transactions in some contexts.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].events_count","typeLabel":"integer"},"values":{"oneOf":[{"type":"object","description":"List of filter values applied to the usage. It is `null` for the entry that holds the usage recorded outside of any charge filter.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].values.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].values.oneOf.0.additionalProperties","typeLabel":"string[]"},"example":{"region":["us-east-1"]},"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].values.oneOf.0","typeLabel":"object"},{"type":"null","description":"List of filter values applied to the usage. It is `null` for the entry that holds the usage recorded outside of any charge filter.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].values.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].values.oneOf.1.additionalProperties","typeLabel":"string[]"},"example":{"region":["us-east-1"]},"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].values.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].values","typeLabel":"object | null"},"invoice_display_name":{"oneOf":[{"type":"string","description":"Specifies the name that will be displayed on an invoice. It is `null` for the entry that holds the usage recorded outside of any charge filter.","example":"AWS eu-east-1","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].invoice_display_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Specifies the name that will be displayed on an invoice. It is `null` for the entry that holds the usage recorded outside of any charge filter.","example":"AWS eu-east-1","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].invoice_display_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].invoice_display_name","typeLabel":"string | null"},"pricing_unit_details":{"oneOf":[{"type":"object","required":["amount_cents","short_name","conversion_rate"],"description":"Details about the pricing unit used for charge usage.","properties":{"amount_cents":{"type":"integer","description":"The amount in cents in the pricing unit.","example":200,"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].pricing_unit_details.oneOf.0.amount_cents","typeLabel":"integer"},"short_name":{"type":"string","example":"CR","description":"The short name of the pricing unit.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].pricing_unit_details.oneOf.0.short_name","typeLabel":"string"},"conversion_rate":{"type":"string","description":"The conversion rate from pricing units to the plan's currency.","example":"0.5","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].pricing_unit_details.oneOf.0.conversion_rate","typeLabel":"string"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].pricing_unit_details.oneOf.0","typeLabel":"object"},{"type":"null","required":["amount_cents","short_name","conversion_rate"],"description":"Details about the pricing unit used for charge usage.","properties":{"amount_cents":{"type":"integer","description":"The amount in cents in the pricing unit.","example":200},"short_name":{"type":"string","example":"CR","description":"The short name of the pricing unit."},"conversion_rate":{"type":"string","description":"The conversion rate from pricing units to the plan's currency.","example":"0.5"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].pricing_unit_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].pricing_unit_details","typeLabel":"object | null"},"presentation_breakdowns":{"type":"array","description":"Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation.","items":{"type":"object","properties":{"presentation_by":{"type":"object","description":"Key value list of event properties used for presentation grouping.","additionalProperties":{"type":"string","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].presentation_breakdowns.items.[INDEX].presentation_by.additionalProperties","typeLabel":"string"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].presentation_breakdowns.items.[INDEX].presentation_by","typeLabel":"object"},"units":{"type":"string","example":"9.0","description":"The number of units consumed for a specific presentation group.","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].presentation_breakdowns.items.[INDEX].units","typeLabel":"string"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].presentation_breakdowns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].presentation_breakdowns","typeLabel":"object[]"},"projected_presentation_breakdowns":{"type":"array","description":"Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation.","items":{"type":"object","properties":{"presentation_by":{"type":"object","description":"Key value list of event properties used for presentation grouping.","additionalProperties":{"type":"string","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].projected_presentation_breakdowns.items.[INDEX].presentation_by.additionalProperties","typeLabel":"string"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].projected_presentation_breakdowns.items.[INDEX].presentation_by","typeLabel":"object"},"units":{"type":"string","example":"9.0","description":"The number of units consumed for a specific presentation group.","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].projected_presentation_breakdowns.items.[INDEX].units","typeLabel":"string"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].projected_presentation_breakdowns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX].projected_presentation_breakdowns","typeLabel":"object[]"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].filters","typeLabel":"object[]"},"presentation_breakdowns":{"type":"array","description":"Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation.","items":{"type":"object","properties":{"presentation_by":{"type":"object","description":"Key value list of event properties used for presentation grouping.","additionalProperties":{"type":"string","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].presentation_breakdowns.items.[INDEX].presentation_by.additionalProperties","typeLabel":"string"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].presentation_breakdowns.items.[INDEX].presentation_by","typeLabel":"object"},"units":{"type":"string","example":"9.0","description":"The number of units consumed for a specific presentation group.","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].presentation_breakdowns.items.[INDEX].units","typeLabel":"string"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].presentation_breakdowns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].presentation_breakdowns","typeLabel":"object[]"},"projected_presentation_breakdowns":{"type":"array","description":"Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation.","items":{"type":"object","properties":{"presentation_by":{"type":"object","description":"Key value list of event properties used for presentation grouping.","additionalProperties":{"type":"string","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].projected_presentation_breakdowns.items.[INDEX].presentation_by.additionalProperties","typeLabel":"string"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].projected_presentation_breakdowns.items.[INDEX].presentation_by","typeLabel":"object"},"units":{"type":"string","example":"9.0","description":"The number of units consumed for a specific presentation group.","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].projected_presentation_breakdowns.items.[INDEX].units","typeLabel":"string"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].projected_presentation_breakdowns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX].projected_presentation_breakdowns","typeLabel":"object[]"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].grouped_usage","typeLabel":"object[]"},"pricing_unit_details":{"oneOf":[{"type":"object","required":["amount_cents","short_name","conversion_rate"],"description":"Details about the pricing unit used for charge usage.","properties":{"amount_cents":{"type":"integer","description":"The amount in cents in the pricing unit.","example":200,"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].pricing_unit_details.oneOf.0.amount_cents","typeLabel":"integer"},"short_name":{"type":"string","example":"CR","description":"The short name of the pricing unit.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].pricing_unit_details.oneOf.0.short_name","typeLabel":"string"},"conversion_rate":{"type":"string","description":"The conversion rate from pricing units to the plan's currency.","example":"0.5","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].pricing_unit_details.oneOf.0.conversion_rate","typeLabel":"string"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].pricing_unit_details.oneOf.0","typeLabel":"object"},{"type":"null","required":["amount_cents","short_name","conversion_rate"],"description":"Details about the pricing unit used for charge usage.","properties":{"amount_cents":{"type":"integer","description":"The amount in cents in the pricing unit.","example":200},"short_name":{"type":"string","example":"CR","description":"The short name of the pricing unit."},"conversion_rate":{"type":"string","description":"The conversion rate from pricing units to the plan's currency.","example":"0.5"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].pricing_unit_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].pricing_unit_details","typeLabel":"object | null"},"filters":{"type":"array","description":"Array of filter object, representing multiple dimensions for a charge item.","items":{"type":"object","required":["values","units","projected_units","events_count","amount_cents","projected_amount_cents"],"properties":{"units":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","example":"0.9","description":"The number of units consumed for a specific charge filter related to a charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].units","typeLabel":"string"},"projected_units":{"type":"string","pattern":"^[0-9]+.?[0-9]*$","example":"1.8","description":"The projected number of units that can be consumed for a specific charge filter related to a charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].projected_units","typeLabel":"string"},"amount_cents":{"type":"integer","example":1000,"description":"The amount in cents, tax excluded, consumed for a specific charge filter related to a charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].amount_cents","typeLabel":"integer"},"projected_amount_cents":{"type":"integer","example":2000,"description":"The projected amount in cents, tax excluded, that can be consumed for a specific charge filter related to a charge item.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].projected_amount_cents","typeLabel":"integer"},"events_count":{"type":"integer","example":10,"description":"The quantity of usage events that have been recorded for a particular charge filter during the specified time period. These events may also be referred to as the number of transactions in some contexts.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].events_count","typeLabel":"integer"},"values":{"oneOf":[{"type":"object","description":"List of filter values applied to the usage. It is `null` for the entry that holds the usage recorded outside of any charge filter.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].values.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].values.oneOf.0.additionalProperties","typeLabel":"string[]"},"example":{"region":["us-east-1"]},"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].values.oneOf.0","typeLabel":"object"},{"type":"null","description":"List of filter values applied to the usage. It is `null` for the entry that holds the usage recorded outside of any charge filter.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].values.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].values.oneOf.1.additionalProperties","typeLabel":"string[]"},"example":{"region":["us-east-1"]},"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].values.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].values","typeLabel":"object | null"},"invoice_display_name":{"oneOf":[{"type":"string","description":"Specifies the name that will be displayed on an invoice. It is `null` for the entry that holds the usage recorded outside of any charge filter.","example":"AWS eu-east-1","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].invoice_display_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Specifies the name that will be displayed on an invoice. It is `null` for the entry that holds the usage recorded outside of any charge filter.","example":"AWS eu-east-1","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].invoice_display_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].invoice_display_name","typeLabel":"string | null"},"pricing_unit_details":{"oneOf":[{"type":"object","required":["amount_cents","short_name","conversion_rate"],"description":"Details about the pricing unit used for charge usage.","properties":{"amount_cents":{"type":"integer","description":"The amount in cents in the pricing unit.","example":200,"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].pricing_unit_details.oneOf.0.amount_cents","typeLabel":"integer"},"short_name":{"type":"string","example":"CR","description":"The short name of the pricing unit.","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].pricing_unit_details.oneOf.0.short_name","typeLabel":"string"},"conversion_rate":{"type":"string","description":"The conversion rate from pricing units to the plan's currency.","example":"0.5","isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].pricing_unit_details.oneOf.0.conversion_rate","typeLabel":"string"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].pricing_unit_details.oneOf.0","typeLabel":"object"},{"type":"null","required":["amount_cents","short_name","conversion_rate"],"description":"Details about the pricing unit used for charge usage.","properties":{"amount_cents":{"type":"integer","description":"The amount in cents in the pricing unit.","example":200},"short_name":{"type":"string","example":"CR","description":"The short name of the pricing unit."},"conversion_rate":{"type":"string","description":"The conversion rate from pricing units to the plan's currency.","example":"0.5"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].pricing_unit_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].pricing_unit_details","typeLabel":"object | null"},"presentation_breakdowns":{"type":"array","description":"Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation.","items":{"type":"object","properties":{"presentation_by":{"type":"object","description":"Key value list of event properties used for presentation grouping.","additionalProperties":{"type":"string","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].presentation_breakdowns.items.[INDEX].presentation_by.additionalProperties","typeLabel":"string"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].presentation_breakdowns.items.[INDEX].presentation_by","typeLabel":"object"},"units":{"type":"string","example":"9.0","description":"The number of units consumed for a specific presentation group.","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].presentation_breakdowns.items.[INDEX].units","typeLabel":"string"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].presentation_breakdowns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].presentation_breakdowns","typeLabel":"object[]"},"projected_presentation_breakdowns":{"type":"array","description":"Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation.","items":{"type":"object","properties":{"presentation_by":{"type":"object","description":"Key value list of event properties used for presentation grouping.","additionalProperties":{"type":"string","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].projected_presentation_breakdowns.items.[INDEX].presentation_by.additionalProperties","typeLabel":"string"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].projected_presentation_breakdowns.items.[INDEX].presentation_by","typeLabel":"object"},"units":{"type":"string","example":"9.0","description":"The number of units consumed for a specific presentation group.","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].projected_presentation_breakdowns.items.[INDEX].units","typeLabel":"string"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].projected_presentation_breakdowns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX].projected_presentation_breakdowns","typeLabel":"object[]"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].filters","typeLabel":"object[]"},"presentation_breakdowns":{"type":"array","description":"Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation.","items":{"type":"object","properties":{"presentation_by":{"type":"object","description":"Key value list of event properties used for presentation grouping.","additionalProperties":{"type":"string","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].presentation_breakdowns.items.[INDEX].presentation_by.additionalProperties","typeLabel":"string"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].presentation_breakdowns.items.[INDEX].presentation_by","typeLabel":"object"},"units":{"type":"string","example":"9.0","description":"The number of units consumed for a specific presentation group.","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].presentation_breakdowns.items.[INDEX].units","typeLabel":"string"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].presentation_breakdowns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].presentation_breakdowns","typeLabel":"object[]"},"projected_presentation_breakdowns":{"type":"array","description":"Array of usage breakdowns split by presentation group keys without affecting pricing or aggregation.","items":{"type":"object","properties":{"presentation_by":{"type":"object","description":"Key value list of event properties used for presentation grouping.","additionalProperties":{"type":"string","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].projected_presentation_breakdowns.items.[INDEX].presentation_by.additionalProperties","typeLabel":"string"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].projected_presentation_breakdowns.items.[INDEX].presentation_by","typeLabel":"object"},"units":{"type":"string","example":"9.0","description":"The number of units consumed for a specific presentation group.","uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].projected_presentation_breakdowns.items.[INDEX].units","typeLabel":"string"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].projected_presentation_breakdowns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX].projected_presentation_breakdowns","typeLabel":"object[]"}},"uniqueKey":"customer_projected_usage.charges_usage.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"customer_projected_usage.charges_usage","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"customer_projected_usage","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customer_projected_usage":{"from_datetime":"2022-07-01T00:00:00Z","to_datetime":"2022-07-31T23:59:59Z","issuing_date":"2022-08-01","lago_invoice_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","currency":"EUR","amount_cents":123,"projected_amount_cents":256,"taxes_amount_cents":200,"total_amount_cents":123,"charges_usage":[{"units":"1.0","projected_units":"2.0","events_count":10,"amount_cents":123,"projected_amount_cents":256,"amount_currency":"EUR","charge":{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","charge_model":"dynamic","invoice_display_name":"Setup"},"billable_metric":{"lago_id":"1a901a90-1a90-1a90-1a90-1a901a901a90","name":"Storage","code":"storage","aggregation_type":"sum_agg"},"grouped_usage":[{"amount_cents":1000,"projected_amount_cents":2000,"events_count":10,"units":"0.9","projected_units":"1.8","grouped_by":{},"pricing_unit_details":{"amount_cents":200,"short_name":"CR","conversion_rate":"0.5"},"filters":[{"units":"0.9","projected_units":"1.8","amount_cents":1000,"projected_amount_cents":2000,"events_count":10,"values":{"region":["us-east-1"]},"invoice_display_name":"AWS eu-east-1","pricing_unit_details":{"amount_cents":200,"short_name":"CR","conversion_rate":"0.5"},"presentation_breakdowns":[{"presentation_by":{},"units":"9.0"}],"projected_presentation_breakdowns":[{"presentation_by":{},"units":"9.0"}]}],"presentation_breakdowns":[{"presentation_by":{},"units":"9.0"}],"projected_presentation_breakdowns":[{"presentation_by":{},"units":"9.0"}]}],"pricing_unit_details":{"amount_cents":200,"short_name":"CR","conversion_rate":"0.5"},"filters":[{"units":"0.9","projected_units":"1.8","amount_cents":1000,"projected_amount_cents":2000,"events_count":10,"values":{"region":["us-east-1"]},"invoice_display_name":"AWS eu-east-1","pricing_unit_details":{"amount_cents":200,"short_name":"CR","conversion_rate":"0.5"},"presentation_breakdowns":[{"presentation_by":{},"units":"9.0"}],"projected_presentation_breakdowns":[{"presentation_by":{},"units":"9.0"}]}],"presentation_breakdowns":[{"presentation_by":{},"units":"9.0"}],"projected_presentation_breakdowns":[{"presentation_by":{},"units":"9.0"}]}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"b36361f8-9451-44a6-bd9b-ae2446676cd7":{"description":"Unauthorized error","content":{"application/json":{"schema":{"type":"object","required":["status","error"],"properties":{"status":{"type":"integer","format":"int32","example":401,"isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"error":{"type":"string","example":"Unauthorized","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":401,"error":"Unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"191cb6ce-5693-4aaa-9bd4-07eb6884dd54":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["status","error","code"],"properties":{"status":{"type":"integer","format":"int32","example":403,"isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"error":{"type":"string","example":"Forbidden","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","example":"feature_unavailable","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":403,"error":"Forbidden","code":"feature_unavailable"}}},"exampleType":"generated"}},"exampleType":"generated"},"2b859b60-4ba4-48f7-869c-1956eab8b242":{"description":"Not Found error","content":{"application/json":{"schema":{"type":"object","required":["status","error","code"],"properties":{"status":{"type":"integer","format":"int32","example":404,"isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"error":{"type":"string","example":"Not Found","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","example":"object_not_found","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":404,"error":"Not Found","code":"object_not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"ce067a5d-8e4b-4eb8-8c6c-dfb6a340f86d":{"description":"Not Allowed error","content":{"application/json":{"schema":{"type":"object","required":["status","error","code"],"properties":{"status":{"type":"integer","format":"int32","example":405,"isRequired":true,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"error":{"type":"string","example":"Method Not Allowed","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","example":"not_allowed","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":405,"error":"Method Not Allowed","code":"not_allowed"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"74776f71-77a9-46c5-8da8-e9de8d8550cc":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"8acb974b-84ea-4ba8-8f1b-6bb856b1dc1f":{"url":"https://api.getlago.com/api/v1","description":"US Lago cluster"},"75be9aa2-d642-43b0-860c-fd15dc223a9e":{"url":"https://api.eu.getlago.com/api/v1","description":"EU Lago cluster"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"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":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://swagger.getlago.com/openapi.yaml"},"subdomain":"lago-docs","siteName":"Lago","title":"Retrieve projected usage - Lago","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T09:36:38.422Z","originalFileLocation":"api-reference/customer-usage/get-projected.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=\"Retrieve real-time projected usage data for the current open billing period.\">\u003cmeta data-mint-head name=\"keywords\" content=\"Lago API, billing API, usage metering API, OpenAPI, billing SDK, Lago MCP\">\u003cmeta data-mint-head name=\"application-name\" content=\"Lago\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve projected usage - Lago\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve real-time projected usage data for the current open billing period.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Lago\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://getlago.com/docs/api-reference/customer-usage/get-projected\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lago-docs.mintlify.app/_mintlify/api/og/v2?division=Customer+usage\u0026amp;title=Retrieve+projected+usage\u0026amp;description=Retrieve+real-time+projected+usage+data+for+the+current+open+billing+period.\u0026amp;theme=eb987f771609ccd12d360d11\u0026amp;signature=6ba6c50d3871e19a65985d6153e92f8f9d703c3d67a933282de3f4e10867e47c\">\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=\"Retrieve projected usage - Lago\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve real-time projected usage data for the current open billing period.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lago-docs.mintlify.app/_mintlify/api/og/v2?division=Customer+usage\u0026amp;title=Retrieve+projected+usage\u0026amp;description=Retrieve+real-time+projected+usage+data+for+the+current+open+billing+period.\u0026amp;theme=eb987f771609ccd12d360d11\u0026amp;signature=6ba6c50d3871e19a65985d6153e92f8f9d703c3d67a933282de3f4e10867e47c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/lago-docs/PXUAhcpsneOuo3Dn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Lago\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#006CFA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://getlago.com/docs/api-reference/customer-usage/get-projected\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/customer-usage/get-projected.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://getlago.com/#organization\",\"name\":\"Lago\",\"legalName\":\"Get Lago Corp.\",\"url\":\"https://getlago.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://getlago.com/docs/logo/light.svg\"},\"sameAs\":[\"https://github.com/getlago\",\"https://www.linkedin.com/company/getlago\",\"https://x.com/GetLago\",\"https://www.youtube.com/channel/UCp6ltp7n3SgDVsmerJ7O7ZA\"]},{\"@type\":\"WebSite\",\"@id\":\"https://getlago.com/docs#website\",\"name\":\"Lago\",\"url\":\"https://getlago.com/docs\",\"publisher\":{\"@id\":\"https://getlago.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://getlago.com/docs/api-reference/customer-usage/get-projected#webpage\",\"url\":\"https://getlago.com/docs/api-reference/customer-usage/get-projected\",\"name\":\"Retrieve projected usage\",\"description\":\"Retrieve real-time projected usage data for the current open billing period.\",\"dateModified\":\"2026-01-28T09:36:38.422Z\",\"isPartOf\":{\"@id\":\"https://getlago.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://getlago.com/docs/api-reference/customer-usage/get-projected#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://getlago.com/docs/api-reference/customer-usage/get-projected#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://getlago.com/docs/api-reference/intro\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customer usage\",\"item\":\"https://getlago.com/docs/api-reference/customer-usage/customer-usage-object\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve projected usage\",\"item\":\"https://getlago.com/docs/api-reference/customer-usage/get-projected\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://getlago.com/docs/api-reference/customer-usage/get-projected#apireference\",\"headline\":\"Retrieve projected usage\",\"name\":\"Retrieve projected usage\",\"description\":\"Retrieve real-time projected usage data for the current open billing period.\",\"url\":\"https://getlago.com/docs/api-reference/customer-usage/get-projected\",\"mainEntityOfPage\":{\"@id\":\"https://getlago.com/docs/api-reference/customer-usage/get-projected#webpage\"},\"dateModified\":\"2026-01-28T09:36:38.422Z\",\"publisher\":{\"@id\":\"https://getlago.com/#organization\"},\"isPartOf\":{\"@id\":\"https://getlago.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Lago\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Lago","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://getlago.com/blog"},{"anchor":"Community","icon":"slack","href":"https://getlago.com/slack"},{"anchor":"GitHub","icon":"github","href":"https://github.com/getlago/lago"},{"anchor":"Status","icon":"signal-bars","href":"https://status.getlago.com/"}]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/welcome"}]},{"tab":"Guide","pages":[{"title":"Guide","href":"/guide/introduction/welcome-to-lago"}]},{"tab":"API References","groups":[{"group":"API Reference","pages":[{"group":"Getting started","pages":[{"title":"Introduction","href":"/api-reference/intro"},{"title":"API standards","href":"/api-reference/api-standards"},{"title":"API versioning and deprecation policy","href":"/api-reference/versioning"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Rate limits","href":"/api-reference/rate-limits"}]},{"group":"Add-ons","pages":[{"title":"The add-on object","href":"/api-reference/add-ons/add-on-object"},{"openapi":"POST /add_ons","title":"Create an add-on","href":"/api-reference/add-ons/create"},{"openapi":"PUT /add_ons/{code}","title":"Update an add-on","href":"/api-reference/add-ons/update"},{"openapi":"DELETE /add_ons/{code}","title":"Delete an add-on","href":"/api-reference/add-ons/destroy"},{"openapi":"GET /add_ons/{code}","title":"Retrieve an add-on","href":"/api-reference/add-ons/get-specific"},{"openapi":"GET /add_ons","title":"List all add-ons","href":"/api-reference/add-ons/get-all"}]},{"group":"Alerts","pages":[{"title":"The alert object","href":"/api-reference/alerts/alert-object"},{"openapi":"POST /subscriptions/{external_id}/alerts","title":"Create an alert","href":"/api-reference/alerts/create"},{"openapi":"PUT /subscriptions/{external_id}/alerts/{code}","title":"Update an alert","href":"/api-reference/alerts/update"},{"openapi":"DELETE /subscriptions/{external_id}/alerts/{code}","title":"Delete an alert","href":"/api-reference/alerts/delete"},{"openapi":"GET /subscriptions/{external_id}/alerts/{code}","title":"Retrieve an alert","href":"/api-reference/alerts/get-specific"},{"openapi":"GET /subscriptions/{external_id}/alerts","title":"List all alerts","href":"/api-reference/alerts/get-all"}]},{"group":"Audit logs","pages":[{"title":"The activity log object","href":"/api-reference/audit-logs/activity-logs-object"},{"openapi":"GET /activity_logs","title":"List all activity logs","href":"/api-reference/audit-logs/get-all-activity-logs"},{"openapi":"GET /activity_logs/{activity_id}","title":"Retrieve an activity log","href":"/api-reference/audit-logs/get-specific-activity-log"},{"title":"The API log object","href":"/api-reference/audit-logs/api-logs-object"},{"openapi":"GET /api_logs","title":"List all API logs","href":"/api-reference/audit-logs/get-all-api-logs"},{"openapi":"GET /api_logs/{request_id}","title":"Retrieve an API log","href":"/api-reference/audit-logs/get-specific-api-log"}]},{"group":"Billable metrics","pages":[{"title":"The billable metric object","href":"/api-reference/billable-metrics/object"},{"title":"Create a billable metric","openapi":"POST /billable_metrics","href":"/api-reference/billable-metrics/create"},{"title":"Update a billable metric","openapi":"PUT /billable_metrics/{code}","href":"/api-reference/billable-metrics/update"},{"openapi":"DELETE /billable_metrics/{code}","title":"Delete a billable metric","href":"/api-reference/billable-metrics/destroy"},{"openapi":"GET /billable_metrics/{code}","title":"Retrieve a billable metric","href":"/api-reference/billable-metrics/get-specific"},{"openapi":"GET /billable_metrics","title":"List all billable metrics","href":"/api-reference/billable-metrics/get-all"}]},{"group":"Billing entities","pages":[{"title":"The billing entity object","href":"/api-reference/billing-entities/object"},{"title":"Create a billing entity","openapi":"POST /billing_entities","href":"/api-reference/billing-entities/create"},{"title":"Update a billing entity","openapi":"PUT /billing_entities/{code}","href":"/api-reference/billing-entities/update"},{"title":"Retrieve a billing entity","openapi":"GET /billing_entities/{code}","href":"/api-reference/billing-entities/get-specific"},{"title":"List all billing entities","openapi":"GET /billing_entities","href":"/api-reference/billing-entities/get-all"}]},{"group":"Coupons","pages":[{"title":"The coupon object","href":"/api-reference/coupons/coupon-object"},{"openapi":"POST /coupons","title":"Create a coupon","href":"/api-reference/coupons/create"},{"openapi":"PUT /coupons/{code}","title":"Update a coupon","href":"/api-reference/coupons/update"},{"openapi":"DELETE /coupons/{code}","title":"Delete a coupon","href":"/api-reference/coupons/destroy"},{"openapi":"GET /coupons/{code}","title":"Retrieve a coupon","href":"/api-reference/coupons/get-specific"},{"openapi":"GET /coupons","title":"List all coupons","href":"/api-reference/coupons/get-all"},{"title":"The applied coupon object","href":"/api-reference/coupons/applied-coupon-object"},{"openapi":"POST /applied_coupons","title":"Apply a coupon","href":"/api-reference/coupons/apply"},{"openapi":"DELETE /customers/{external_customer_id}/applied_coupons/{applied_coupon_id}","title":"Delete an applied coupon","href":"/api-reference/coupons/destroy-applied-coupon"},{"openapi":"GET /applied_coupons","title":"List all applied coupons","href":"/api-reference/coupons/get-all-applied"}]},{"group":"Credit notes","pages":[{"title":"The credit note object","href":"/api-reference/credit-notes/credit-note-object"},{"openapi":"POST /credit_notes/estimate","title":"Estimate a credit note","href":"/api-reference/credit-notes/estimate"},{"openapi":"POST /credit_notes","title":"Create a credit note","href":"/api-reference/credit-notes/create"},{"openapi":"POST /credit_notes/{lago_id}/download","title":"Download a credit note","href":"/api-reference/credit-notes/download"},{"openapi":"PUT /credit_notes/{lago_id}","title":"Update a credit note","href":"/api-reference/credit-notes/update"},{"openapi":"PUT /credit_notes/{lago_id}/void","title":"Void available credit","href":"/api-reference/credit-notes/void"},{"openapi":"GET /credit_notes/{lago_id}","title":"Retrieve a credit note","href":"/api-reference/credit-notes/get-specific"},{"openapi":"GET /credit_notes","title":"List all credit notes","href":"/api-reference/credit-notes/get-all"},{"group":"Metadata","pages":[{"openapi":"POST /credit_notes/{lago_id}/metadata","title":"Replace all metadata","href":"/api-reference/credit-notes/metadata/create-metadata-cn"},{"openapi":"PATCH /credit_notes/{lago_id}/metadata","title":"Update metadata","href":"/api-reference/credit-notes/metadata/update-metadata-cn"},{"openapi":"DELETE /credit_notes/{lago_id}/metadata/{key}","title":"Delete a metadata","href":"/api-reference/credit-notes/metadata/delete-a-metadata-cn"},{"openapi":"DELETE /credit_notes/{lago_id}/metadata","title":"Delete all metadata","href":"/api-reference/credit-notes/metadata/delete-all-metadata-cn"}]}]},{"group":"Customer usage","pages":[{"title":"The customer usage object","href":"/api-reference/customer-usage/customer-usage-object"},{"openapi":"GET /analytics/usage","title":"Retrieve usages","href":"/api-reference/customer-usage/usages"},{"openapi":"GET /customers/{external_customer_id}/current_usage","title":"Retrieve current usage","description":"Retrieve real-time customer usage data for the current open billing period.","href":"/api-reference/customer-usage/get-current"},{"openapi":"GET /customers/{external_customer_id}/projected_usage","title":"Retrieve projected usage","href":"/api-reference/customer-usage/get-projected"},{"openapi":"GET /customers/{external_customer_id}/past_usage","title":"Retrieve past usage","description":"Fetch historical customer usage data for closed billing periods.","href":"/api-reference/customer-usage/get-past"}]},{"group":"Customers","pages":[{"title":"The customer object","href":"/api-reference/customers/object"},{"openapi":"POST /customers","title":"Create a customer","href":"/api-reference/customers/create"},{"openapi":"POST /customers","title":"Update a customer","href":"/api-reference/customers/update"},{"openapi":"POST /customers/{external_customer_id}/checkout_url","title":"Regenerate checkout URL","href":"/api-reference/customers/psp-checkout-url"},{"openapi":"DELETE /customers/{external_customer_id}","title":"Delete a customer","href":"/api-reference/customers/delete"},{"openapi":"GET /customers/{external_customer_id}","title":"Retrieve a customer","href":"/api-reference/customers/get-specific"},{"openapi":"GET /customers","title":"List all customers","href":"/api-reference/customers/get-all"},{"openapi":"GET /customers/{external_customer_id}/portal_url","title":"Retrieve customer portal URL","href":"/api-reference/customers/customer-portal"}]},{"group":"Entitlements","pages":[{"title":"The feature object","href":"/api-reference/entitlements/features/feature-object"},{"openapi":"POST /features","title":"Create a feature","href":"/api-reference/entitlements/features/create-feature"},{"openapi":"PUT /features/{code}","title":"Update a feature","href":"/api-reference/entitlements/features/update-feature"},{"openapi":"DELETE /features/{code}","title":"Delete a feature","href":"/api-reference/entitlements/features/delete-feature"},{"openapi":"DELETE /features/{code}/privileges/{privilege_code}","title":"Delete a feature privilege","href":"/api-reference/entitlements/features/delete-privilege"},{"openapi":"GET /features/{code}","title":"Retrieve a feature","href":"/api-reference/entitlements/features/get-feature"},{"openapi":"GET /features","title":"List all features","href":"/api-reference/entitlements/features/get-all-features"},{"title":"The plan entitlement object","href":"/api-reference/entitlements/plan-entitlements/plan-entitlement-object"},{"openapi":"POST /plans/{code}/entitlements","title":"Create plan entitlements","href":"/api-reference/entitlements/plan-entitlements/create-plan-entitlement"},{"openapi":"PATCH /plans/{code}/entitlements","title":"Update plan entitlements","href":"/api-reference/entitlements/plan-entitlements/update-plan-entitlement"},{"openapi":"DELETE /plans/{code}/entitlements/{feature_code}","title":"Delete a plan entitlement","href":"/api-reference/entitlements/plan-entitlements/delete-plan-entitlement"},{"openapi":"DELETE /plans/{code}/entitlements/{feature_code}/privileges/{privilege_code}","title":"Delete a plan entitlement privilege","href":"/api-reference/entitlements/plan-entitlements/delete-plan-entitlement-privilege"},{"openapi":"GET /plans/{code}/entitlements/{feature_code}","title":"Retrieve a plan entitlement","href":"/api-reference/entitlements/plan-entitlements/get-specific-plan-entitlement"},{"openapi":"GET /plans/{code}/entitlements","title":"List plan entitlements","href":"/api-reference/entitlements/plan-entitlements/get-all-plan-entitlements"},{"title":"The subscription entitlement object","href":"/api-reference/entitlements/subscription-entitlements/subscription-entitlement-object"},{"openapi":"PATCH /subscriptions/{external_id}/entitlements","title":"Update subscription entitlements","href":"/api-reference/entitlements/subscription-entitlements/update-subscription-entitlement"},{"openapi":"DELETE /subscriptions/{external_id}/entitlements/{feature_code}","title":"Delete a subscription entitlement","href":"/api-reference/entitlements/subscription-entitlements/delete-subscription-entitlement"},{"openapi":"DELETE /subscriptions/{external_id}/entitlements/{feature_code}/privileges/{privilege_code}","title":"Delete a subscription entitlement privilege","href":"/api-reference/entitlements/subscription-entitlements/delete-subscription-entitlement-privilege"},{"openapi":"GET /subscriptions/{external_id}/entitlements","title":"List subscription entitlements","href":"/api-reference/entitlements/subscription-entitlements/get-all-subscription-entitlements"}]},{"group":"Events","pages":[{"title":"The event object","href":"/api-reference/events/event-object"},{"openapi":"POST /events","title":"Send usage event","href":"/api-reference/events/usage"},{"openapi":"POST /events/batch","title":"Batch usage events","href":"/api-reference/events/batch"},{"openapi":"POST /events/estimate_fees","title":"Estimate an upcoming fee","href":"/api-reference/events/estimated-fee"},{"openapi":"GET /events/{transaction_id}","title":"Retrieve an event","href":"/api-reference/events/get-specific"},{"openapi":"GET /events","title":"List all events","href":"/api-reference/events/list-events"}]},{"group":"Fees","pages":[{"title":"The fee object","href":"/api-reference/fees/fee-object"},{"openapi":"PUT /fees/{lago_id}","title":"Update a fee","href":"/api-reference/fees/update-fee"},{"openapi":"DELETE /fees/{lago_id}","title":"Delete a fee","href":"/api-reference/fees/destroy-fee"},{"openapi":"GET /fees/{lago_id}","title":"Retrieve a fee","href":"/api-reference/fees/retrieve-fee"},{"openapi":"GET /fees","title":"List all fees","href":"/api-reference/fees/list-fees"}]},{"group":"Invoices","pages":[{"title":"The invoice object","href":"/api-reference/invoices/invoice-object"},{"openapi":"POST /invoices","title":"Create a one-off invoice","href":"/api-reference/invoices/create-oneoff"},{"openapi":"POST /invoices/preview","title":"Preview an invoice","href":"/api-reference/invoices/preview"},{"openapi":"POST /invoices/{lago_id}/download","title":"Download an invoice","href":"/api-reference/invoices/download"},{"openapi":"POST /invoices/{lago_id}/void","title":"Void an invoice","href":"/api-reference/invoices/void"},{"openapi":"POST /invoices/{lago_id}/retry","title":"Retry an invoice finalization","href":"/api-reference/invoices/retry_finalization"},{"openapi":"POST /invoices/{lago_id}/retry_payment","title":"Retry an invoice payment","href":"/api-reference/invoices/retry"},{"openapi":"POST /invoices/{lago_id}/payment_url","title":"Generate a payment URL","href":"/api-reference/invoices/payment-url"},{"openapi":"PUT /invoices/{lago_id}/refresh","title":"Refresh an invoice","href":"/api-reference/invoices/refresh"},{"openapi":"PUT /invoices/{lago_id}/finalize","title":"Finalize an invoice","href":"/api-reference/invoices/finalize"},{"openapi":"PUT /invoices/{lago_id}","title":"Update an invoice","href":"/api-reference/invoices/update"},{"openapi":"GET /invoices/{lago_id}","title":"Retrieve an invoice","href":"/api-reference/invoices/get-specific"},{"openapi":"GET /invoices","title":"List all invoices","href":"/api-reference/invoices/get-all"}]},{"group":"Organizations","pages":[{"title":"The organization object","href":"/api-reference/organizations/organization-object"},{"openapi":"PUT /organizations","title":"Update organization (deprecated)","href":"/api-reference/organizations/update"}]},{"group":"Payments","pages":[{"title":"The payment object","href":"/api-reference/payments/payment-object"},{"title":"Create a payment","openapi":"POST /payments","href":"/api-reference/payments/create"},{"title":"Retrieve a payment","openapi":"GET /payments/{lago_id}","href":"/api-reference/payments/get-specific"},{"title":"List all payments","openapi":"GET /payments","href":"/api-reference/payments/get-all"}]},{"group":"Payment methods","pages":[{"title":"The payment method object","href":"/api-reference/payment-methods/payment-method-object"},{"openapi":"PUT /customers/{external_customer_id}/payment_methods/{lago_id}/set_as_default","title":"Update a payment method","href":"/api-reference/payment-methods/update"},{"openapi":"DELETE /customers/{external_customer_id}/payment_methods/{lago_id}","title":"Delete a payment method from a customer","href":"/api-reference/payment-methods/delete"},{"openapi":"GET /customers/{external_customer_id}/payment_methods","title":"List all payment methods for a customer","href":"/api-reference/payment-methods/get-all"}]},{"group":"Payment receipts","pages":[{"title":"The payment receipt object","href":"/api-reference/payment-receipts/payment-receipt-object"},{"openapi":"GET /payment_receipts/{lago_id}","title":"Retrieve a payment receipt","href":"/api-reference/payment-receipts/get-specific"},{"openapi":"GET /payment_receipts","title":"List all payment receipts","href":"/api-reference/payment-receipts/get-all"}]},{"group":"Payment requests","pages":[{"title":"The payment request object","href":"/api-reference/payment-requests/payment-request-object"},{"title":"Create a payment request","openapi":"POST /payment_requests","href":"/api-reference/payment-requests/create"},{"title":"List all payment requests","openapi":"GET /payment_requests","href":"/api-reference/payment-requests/get-all"}]},{"group":"Plans","pages":[{"title":"The plan object","href":"/api-reference/plans/object"},{"title":"Create a plan","openapi":"POST /plans","href":"/api-reference/plans/create"},{"title":"Update a plan","openapi":"PUT /plans/{code}","href":"/api-reference/plans/update"},{"openapi":"DELETE /plans/{code}","title":"Delete a plan","href":"/api-reference/plans/destroy"},{"openapi":"GET /plans/{code}","title":"Retrieve a plan","href":"/api-reference/plans/get-specific"},{"openapi":"GET /plans","title":"List all plans","href":"/api-reference/plans/get-all-plans"},{"group":"Charges","pages":[{"title":"The charge object","href":"/api-reference/plans/charges/object"},{"title":"Create a charge","openapi":"POST /plans/{code}/charges","href":"/api-reference/plans/charges/create"},{"title":"Update a charge","openapi":"PUT /plans/{code}/charges/{charge_code}","href":"/api-reference/plans/charges/update"},{"title":"Delete a charge","openapi":"DELETE /plans/{code}/charges/{charge_code}","href":"/api-reference/plans/charges/destroy"},{"title":"Retrieve a charge","openapi":"GET /plans/{code}/charges/{charge_code}","href":"/api-reference/plans/charges/get-specific"},{"title":"List all charges","openapi":"GET /plans/{code}/charges","href":"/api-reference/plans/charges/get-all"},{"group":"Filters","pages":[{"title":"The charge filter object","href":"/api-reference/plans/charges/filters/object"},{"title":"Create a charge filter","openapi":"POST /plans/{code}/charges/{charge_code}/filters","href":"/api-reference/plans/charges/filters/create"},{"title":"Update a charge filter","openapi":"PUT /plans/{code}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/plans/charges/filters/update"},{"title":"Delete a charge filter","openapi":"DELETE /plans/{code}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/plans/charges/filters/destroy"},{"title":"Retrieve a charge filter","openapi":"GET /plans/{code}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/plans/charges/filters/get-specific"},{"title":"List all charge filters","openapi":"GET /plans/{code}/charges/{charge_code}/filters","href":"/api-reference/plans/charges/filters/get-all"}]}]},{"group":"Fixed Charges","pages":[{"title":"The fixed charge object","href":"/api-reference/plans/fixed-charges/object"},{"title":"Create a fixed charge","openapi":"POST /plans/{code}/fixed_charges","href":"/api-reference/plans/fixed-charges/create"},{"title":"Update a fixed charge","openapi":"PUT /plans/{code}/fixed_charges/{fixed_charge_code}","href":"/api-reference/plans/fixed-charges/update"},{"title":"Delete a fixed charge","openapi":"DELETE /plans/{code}/fixed_charges/{fixed_charge_code}","href":"/api-reference/plans/fixed-charges/destroy"},{"title":"Retrieve a fixed charge","openapi":"GET /plans/{code}/fixed_charges/{fixed_charge_code}","href":"/api-reference/plans/fixed-charges/get-specific"},{"title":"List all fixed charges","openapi":"GET /plans/{code}/fixed_charges","href":"/api-reference/plans/fixed-charges/get-all"}]}]},{"group":"Quotes \u0026 Order forms","pages":[{"group":"Quotes","pages":[{"title":"The quote object","href":"/api-reference/quotes/quote-object"},{"title":"The quote version object","href":"/api-reference/quotes/quote-version-object"},{"openapi":"POST /quote_versions/{lago_id}/approve","title":"Approve a quote version","href":"/api-reference/quotes/approve-version"},{"openapi":"POST /quote_versions/{lago_id}/void","title":"Void a quote version","href":"/api-reference/quotes/void-version"},{"openapi":"POST /quote_versions/{lago_id}/clone","title":"Clone a quote version","href":"/api-reference/quotes/clone-version"},{"openapi":"GET /quotes/{lago_id}","title":"Retrieve a quote","href":"/api-reference/quotes/get-specific"},{"openapi":"GET /quotes","title":"List all quotes","href":"/api-reference/quotes/get-all"},{"openapi":"GET /quote_versions/{lago_id}","title":"Retrieve a quote version","href":"/api-reference/quotes/get-specific-version"},{"openapi":"GET /quotes/{lago_id}/versions","title":"List all versions of a quote","href":"/api-reference/quotes/get-all-versions"}]},{"group":"Order forms","pages":[{"title":"The order form object","href":"/api-reference/quotes/order-forms/order-form-object"},{"openapi":"POST /order_forms/{lago_id}/mark_as_signed","title":"Mark an order form as signed","href":"/api-reference/quotes/order-forms/mark-as-signed"},{"openapi":"POST /order_forms/{lago_id}/void","title":"Void an order form","href":"/api-reference/quotes/order-forms/void"},{"openapi":"GET /order_forms/{lago_id}","title":"Retrieve an order form","href":"/api-reference/quotes/order-forms/get-specific"},{"openapi":"GET /order_forms","title":"List all order forms","href":"/api-reference/quotes/order-forms/get-all"}]},{"group":"Orders","pages":[{"title":"The order object","href":"/api-reference/quotes/orders/order-object"},{"openapi":"POST /orders/{lago_id}/execute","title":"Execute an order","href":"/api-reference/quotes/orders/execute"},{"openapi":"GET /orders/{lago_id}","title":"Retrieve an order","href":"/api-reference/quotes/orders/get-specific"},{"openapi":"GET /orders","title":"List all orders","href":"/api-reference/quotes/orders/get-all"}]}]},{"group":"Resources","pages":[{"title":"Currencies","href":"/api-reference/resources/currencies"},{"title":"Timezones","href":"/api-reference/resources/timezones"},{"title":"Document locales","href":"/api-reference/resources/locales"}]},{"group":"Subscriptions","pages":[{"title":"The subscription object","href":"/api-reference/subscriptions/subscription-object"},{"title":"Create a subscription","openapi":"POST /subscriptions","href":"/api-reference/subscriptions/assign-plan"},{"title":"Update a subscription","openapi":"PUT /subscriptions/{external_id}","href":"/api-reference/subscriptions/update"},{"title":"Terminate a subscription","openapi":"DELETE /subscriptions/{external_id}","href":"/api-reference/subscriptions/terminate"},{"title":"Retrieve a subscription","openapi":"GET /subscriptions/{external_id}","href":"/api-reference/subscriptions/get-specific"},{"title":"List all subscriptions","openapi":"GET /subscriptions","href":"/api-reference/subscriptions/get-all"},{"group":"Lifetime Usage","pages":[{"title":"The lifetime usage object","href":"/api-reference/subscriptions/lifetime-usage-object"},{"title":"Update subscription lifetime usage","openapi":"PUT /subscriptions/{external_id}/lifetime_usage","href":"/api-reference/subscriptions/update-lifetime-usage"},{"title":"Retrieve subscription lifetime usage","openapi":"GET /subscriptions/{external_id}/lifetime_usage","href":"/api-reference/subscriptions/get-lifetime-usage"}]},{"group":"Charges","pages":[{"title":"The charge object","href":"/api-reference/subscriptions/charges/object"},{"title":"Update a charge","openapi":"PUT /subscriptions/{external_id}/charges/{charge_code}","href":"/api-reference/subscriptions/charges/update"},{"title":"Retrieve a charge","openapi":"GET /subscriptions/{external_id}/charges/{charge_code}","href":"/api-reference/subscriptions/charges/get-specific"},{"title":"List all charges","openapi":"GET /subscriptions/{external_id}/charges","href":"/api-reference/subscriptions/charges/get-all"},{"group":"Filters","pages":[{"title":"The charge filter object","href":"/api-reference/subscriptions/charges/filters/object"},{"title":"Create a charge filter","openapi":"POST /subscriptions/{external_id}/charges/{charge_code}/filters","href":"/api-reference/subscriptions/charges/filters/create"},{"title":"Update a charge filter","openapi":"PUT /subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/subscriptions/charges/filters/update"},{"title":"Delete a charge filter","openapi":"DELETE /subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/subscriptions/charges/filters/destroy"},{"title":"Retrieve a charge filter","openapi":"GET /subscriptions/{external_id}/charges/{charge_code}/filters/{filter_id}","href":"/api-reference/subscriptions/charges/filters/get-specific"},{"title":"List all charge filters","openapi":"GET /subscriptions/{external_id}/charges/{charge_code}/filters","href":"/api-reference/subscriptions/charges/filters/get-all"}]}]},{"group":"Fixed Charges","pages":[{"title":"The fixed charge object","href":"/api-reference/subscriptions/fixed-charges/object"},{"title":"Update a fixed charge","openapi":"PUT /subscriptions/{external_id}/fixed_charges/{fixed_charge_code}","href":"/api-reference/subscriptions/fixed-charges/update"},{"title":"Retrieve a fixed charge","openapi":"GET /subscriptions/{external_id}/fixed_charges/{fixed_charge_code}","href":"/api-reference/subscriptions/fixed-charges/get-specific"},{"title":"List all fixed charges","openapi":"GET /subscriptions/{external_id}/fixed_charges","href":"/api-reference/subscriptions/fixed-charges/get-all"}]}]},{"group":"Taxes","pages":[{"title":"The tax object","href":"/api-reference/taxes/tax-object"},{"openapi":"POST /taxes","title":"Create a tax rate","href":"/api-reference/taxes/create"},{"openapi":"PUT /taxes/{code}","title":"Update a tax rate","href":"/api-reference/taxes/update"},{"openapi":"DELETE /taxes/{code}","title":"Delete a tax rate","href":"/api-reference/taxes/destroy"},{"openapi":"GET /taxes/{code}","title":"Retrieve a tax rate","href":"/api-reference/taxes/get-specific"},{"openapi":"GET /taxes","title":"List all tax rates","href":"/api-reference/taxes/get-all"}]},{"group":"Wallets","pages":[{"title":"The wallet object","href":"/api-reference/wallets/wallet-object"},{"openapi":"POST /wallets","title":"Create a wallet","href":"/api-reference/wallets/create"},{"openapi":"PUT /wallets/{lago_id}","title":"Update a wallet","href":"/api-reference/wallets/update"},{"openapi":"DELETE /wallets/{lago_id}","title":"Terminate a wallet","href":"/api-reference/wallets/terminate"},{"openapi":"GET /wallets/{lago_id}","title":"Retrieve a wallet","href":"/api-reference/wallets/get-specific"},{"openapi":"GET /wallets","title":"List all wallets","href":"/api-reference/wallets/get-all"},{"group":"Wallets by code","pages":[{"openapi":"POST /customers/{external_customer_id}/wallets","title":"Create a wallet for a customer","href":"/api-reference/wallets/create-for-customer"},{"openapi":"PUT /customers/{external_customer_id}/wallets/{code}","title":"Update a wallet by code","href":"/api-reference/wallets/update-by-code"},{"openapi":"DELETE /customers/{external_customer_id}/wallets/{code}","title":"Terminate a wallet by code","href":"/api-reference/wallets/terminate-by-code"},{"openapi":"GET /customers/{external_customer_id}/wallets/{code}","title":"Retrieve a wallet by code","href":"/api-reference/wallets/get-specific-by-code"},{"openapi":"GET /customers/{external_customer_id}/wallets","title":"List all wallets for a customer","href":"/api-reference/wallets/get-all-for-customer"}]},{"group":"Wallet transactions","pages":[{"title":"The wallet transaction object","href":"/api-reference/wallets/wallet-transaction-object"},{"openapi":"POST /wallet_transactions","title":"Top-up a wallet","href":"/api-reference/wallets/top-up"},{"openapi":"POST /wallet_transactions/{lago_id}/payment_url","title":"Generate a payment URL","href":"/api-reference/wallets/wallet-transaction-payment-url"},{"openapi":"GET /wallet_transactions/{lago_id}","title":"Retrieve a transaction","href":"/api-reference/wallets/get-specific-transaction"},{"openapi":"GET /wallets/{lago_id}/wallet_transactions","title":"List all wallet transactions","href":"/api-reference/wallets/get-all-transactions"},{"openapi":"GET /wallet_transactions/{lago_id}/consumptions","title":"List all consumptions for a wallet transaction","href":"/api-reference/wallets/get-all-consumptions"},{"openapi":"GET /wallet_transactions/{lago_id}/fundings","title":"List all fundings for a wallet transaction","href":"/api-reference/wallets/get-all-fundings"}]},{"group":"Wallet alerts","pages":[{"title":"The wallet alert object","href":"/api-reference/wallets/wallet-alert-object"},{"openapi":"POST /customers/{external_customer_id}/wallets/{wallet_code}/alerts","title":"Create a wallet alert","href":"/api-reference/wallets/create-alert"},{"openapi":"PUT /customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}","title":"Update a wallet alert","href":"/api-reference/wallets/update-alert"},{"openapi":"DELETE /customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}","title":"Delete a wallet alert","href":"/api-reference/wallets/delete-alert"},{"openapi":"GET /customers/{external_customer_id}/wallets/{wallet_code}/alerts/{code}","title":"Retrieve a wallet alert","href":"/api-reference/wallets/get-specific-alert"},{"openapi":"GET /customers/{external_customer_id}/wallets/{wallet_code}/alerts","title":"List all wallet alerts","href":"/api-reference/wallets/get-all-alerts"}]}]},{"group":"Webhook endpoints","pages":[{"title":"The webhook endpoint object","href":"/api-reference/webhook-endpoints/webhook-endpoint-object"},{"openapi":"POST /webhook_endpoints","title":"Create a webhook endpoint","href":"/api-reference/webhook-endpoints/create"},{"openapi":"PUT /webhook_endpoints/{lago_id}","title":"Update a webhook endpoint","href":"/api-reference/webhook-endpoints/update"},{"openapi":"DELETE /webhook_endpoints/{lago_id}","title":"Delete a webhook endpoint","href":"/api-reference/webhook-endpoints/destroy"},{"openapi":"GET /webhook_endpoints","title":"List all webhook endpoints","href":"/api-reference/webhook-endpoints/get-all"},{"openapi":"GET /webhook_endpoints/{lago_id}","title":"Retrieve a webhook endpoint","href":"/api-reference/webhook-endpoints/get-specific"}]},{"group":"Webhooks","pages":[{"title":"Format and signature","href":"/api-reference/webhooks/format---signature"},{"title":"Messages","href":"/api-reference/webhooks/messages"}]}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/introduction"}]},{"tab":"Templates","pages":[{"title":"Templates","href":"/templates/introduction"}]},{"tab":"FAQ","pages":[{"title":"FAQ","href":"/faq/about-lago"}]},{"tab":"Knowledge Base","href":"https://knowledge.getlago.com"},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/product"}]}]},"title":"Retrieve projected usage - Lago","buildId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","deploymentId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bg4Z7D_G.js","utils-Biz734EK.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6F9YHs6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BoJjY_VP.js","snippetPresets-CnZ-mOFh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DC_SB2pp.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BYKtOiIP.js","shallow-COAac_UD.js","getApiPlaygroundDisplay-BV4Viqi2.js","CodeSnippet-DDgW-JXl.js","CodeSnippets-CP1LpNhG.js","Page-BeiUfucV.js","getPastedJson-Cvgvbfmv.js","icon-D-H368xH.js","MethodPill-CXSxH1VW.js","DuplicateIcon-JcbBzF1x.js","createIcon-BDt_aHZM.js","DynamicMarkdown-DO1Fz7ar.js","SectionHeading-mwKBArs3.js","axios-vUo_bRtp.js","Markdown-C3KUTGJN.js","clsx-C6CAjViH.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C3vb5JQZ.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C8Hisf3g.js"]}