{ "object": "usage_estimate", "period": { "from": "2026-08-01T00:00:00.000Z", "to": "2026-09-01T00:00:00.000Z" }, "schedule_version": 2, "credits": { "charged": 31500, "nominal": 33500, "beta_free": 2000, "per_month": { "charged": 30484, "nominal": 32419, "beta_free": 1935 } }, "requests": { "total": 3155, "unrouted": 2, "unmapped": 0 }, "by_action": [ { "action_id": "search", "name": "Search", "requests": 3000, "quantity": 3000, "credits": 30000, "nominal_credits": 30000, "disposition": "charged" }, { "action_id": "read", "name": "Retrieve", "requests": 153, "quantity": 1500, "credits": 1500, "nominal_credits": 1500, "disposition": "charged" }, { "action_id": "screen", "name": "Screening", "requests": 2, "quantity": 2, "credits": 0, "nominal_credits": 2000, "disposition": "beta_free" } ], "unmapped": [], "plan_for": { "id": "growth", "name": "Growth", "credits_included": 100000, "per_month_annual": 399, "monthly": 529 }, "packs_needed": null, "above_self_serve": false, "offer": { "percent_off": 25, "months": 12, "price_per_month": 299.25 }, "coverage": { "pre_cutover_unmetered_actions": ["class_lookup", "rules_lookup"], "note": "Class and rules lookups were free and not counted before the switch to credits, so this estimate cannot show how many you made before then. Everything since the switch is included. Monitoring (mark watch, filing watch, marks under management) is priced by the day, not per request, so it is not part of this estimate." }, "request_id": "req_abc123"}
Credits: 0.
Beta. This is an estimate of what past traffic would cost on the published credit schedule, not a bill, an invoice, or a commitment. The response shape may still change.
Prices the authenticated organization’s recorded API traffic at the published credit schedule and shows which plan that traffic lands on. Use it to answer “what would last month have cost” before anything is charged.Requests recorded before the credit cutover carry the old placeholder weights, so they are re-priced from their route; requests recorded after it already carry credits and are reported at face value. Traffic the launch beta gives away is metered at its full list price and reported separately under credits.beta_free, so credits.charged is always what you would actually pay.plan_for, packs_needed and offer are derived from credits.per_month (the window scaled to 30 days), so a two-day window and a quarter recommend comparable plans rather than plans two sizes apart.Defaults to the last 30 days. Requires the billing:read scope. Querying the estimate is not billed.
End of the window (YYYY-MM-DD), inclusive. Must be provided together with from, may not be in the future, and the window may not exceed 92 days. Today is accepted; the window then ends at the moment you ask, so the projection divides only by time that has elapsed.
The same three totals scaled to a 30-day month. Everything about the plan is decided on these, because a pooled monthly allowance can only be compared to a monthly figure.
Purchases needed to buy them. 1 unless the shortfall costs more than the $10,000 limit on a single purchase.</ResponseField> <ResponseField name="usd" type="number">The whole-dollar extra-credit purchase that covers the projected shortfall at the plan's rate, USD. At least $10, the smallest purchase.
true when the projected month is beyond what the plan ladder plus extra credits sells; plan_for is then null and the right next step is a conversation.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Signa Docs","colors":{"primary":"#555555","light":"#FFFFFF","dark":"#1A1A1A"},"logo":{"light":"https://mintcdn.com/signa-3e9d3658/B1ZmV_4e8OQAWS8j/logo/light.svg?fit=max\u0026auto=format\u0026n=B1ZmV_4e8OQAWS8j\u0026q=85\u0026s=94809fd9be711ab731742afa4d4e58e7","dark":"https://mintcdn.com/signa-3e9d3658/B1ZmV_4e8OQAWS8j/logo/dark.svg?fit=max\u0026auto=format\u0026n=B1ZmV_4e8OQAWS8j\u0026q=85\u0026s=e06fe8c94a3c42e39ba5c55e2e7b60c6","href":"https://signa.so"},"favicon":"https://mintcdn.com/signa-3e9d3658/B1ZmV_4e8OQAWS8j/favicon.png?fit=max\u0026auto=format\u0026n=B1ZmV_4e8OQAWS8j\u0026q=85\u0026s=4d3fc789bb946d02e70cc7f637a2ef2c","api":{"openapi":"https://api.signa.so/v1/openapi.json","playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.signa.so"}},"background":{},"navbar":{"links":[{"href":"mailto:support@signa.so","label":"Support"}],"primary":{"type":"button","label":"Get API Key","href":"https://app.signa.so"}},"footer":{"socials":{"x":"https://x.com/signa_so","github":"https://github.com/signa-so","linkedin":"https://linkedin.com/company/signa-so"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"signa-3e9d3658","hasAudioNarration":false,"actualSubdomain":"signa-3e9d3658","customDomains":["docs.signa.so"],"gitSource":{"type":"github","owner":"signa-so","repo":"signa","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae8f84817da5592aa5cce4a","collectionId":"c11bb59e-919c-45a2-a5be-9019782e9456","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae8f84817da5592aa5cce4a"},"entitlements":{},"buildId":"6aee8437618e65732e2faf31","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":127},{"language":"default","tag":"Documentation","count":43},{"language":"default","tag":"Monitoring","count":38},{"language":"default","tag":"Filing \u0026 docketing","count":24},{"language":"default","tag":"Administration","count":18},{"language":"default","tag":"Parties","count":16},{"language":"default","tag":"Watches","count":12},{"language":"default","tag":"Records","count":11},{"language":"default","tag":"Reference","count":11},{"language":"default","tag":"Webhooks","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"a[href=\"https://app.signa.so\"]:not(.link){background-color:transparent!important}a[href=\"https://app.signa.so\"]:not(.link)>span:first-child{background-color:#0A0A0A!important}a[href=\"https://app.signa.so\"]:not(.link),a[href=\"https://app.signa.so\"]:not(.link) *{color:#FFFFFF!important}a[href=\"https://app.signa.so\"][target=\"_blank\"]:not(.link) svg{display:none!important}.dark a[href=\"https://app.signa.so\"]:not(.link),html.dark a[href=\"https://app.signa.so\"]:not(.link){background-color:transparent!important}.dark a[href=\"https://app.signa.so\"]:not(.link)>span:first-child,html.dark a[href=\"https://app.signa.so\"]:not(.link)>span:first-child{background-color:#F0F0F0!important}.dark a[href=\"https://app.signa.so\"]:not(.link),.dark a[href=\"https://app.signa.so\"]:not(.link) *,html.dark a[href=\"https://app.signa.so\"]:not(.link),html.dark a[href=\"https://app.signa.so\"]:not(.link) *{color:#0A0A0A!important}a[href=\"https://app.signa.so\"]:not(.link),a[href=\"https://app.signa.so\"]:not(.link)>span:first-child,button:not([role=\"switch\"]):not([role=\"tab\"]),.sidebar-group a,#search-bar-entry,#search-bar-entry-mobile{border-radius:9999px!important}#page-context-menu-button{border-radius:0.75rem 0 0 0.75rem!important}#page-context-menu-button+button{border-radius:0 0.75rem 0.75rem 0!important}#topbar-cta-button>a{padding:0.375rem 0.875rem!important;font-size:0.8125rem!important}[data-component-part=\"update-tag\"],[data-component-part=\"update-description\"]{font-size:0.75rem;line-height:1.25rem}[data-component-part=\"update-tag-list\"]{flex-direction:column;gap:0.25rem}[data-component-part=\"update-tag\"]{opacity:0.7}[data-component-part=\"update-content\"]>h2:first-child{margin-top:0;font-size:1.5rem;line-height:2rem}[data-component-part=\"update-content\"] h3{font-size:1rem;margin-top:1.75rem}"}],"page":{"pagePath":"api-reference/administration/get-usage-estimate","slug":"/api-reference/administration/get-usage-estimate","pageMetadata":{"title":"Get Usage Estimate","description":"Your recorded traffic priced at the published credit schedule","api":"GET /v1/organization/usage/estimate","href":"/api-reference/administration/get-usage-estimate"},"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: \"Your recorded traffic priced at the published credit schedule\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,em:`em`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Expandable,Heading,Note,ParamField,ResponseField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Credits:`}),` 0.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Beta.`}),` This is an `,_jsx(_components.em,{children:`estimate`}),` of what past traffic would cost on the published credit schedule, not a bill, an invoice, or a commitment. The response shape may still change.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsx(_components.p,{children:`Prices the authenticated organization’s recorded API traffic at the published credit schedule and shows which plan that traffic lands on. Use it to answer “what would last month have cost” before anything is charged.`}),`\n`,_jsxs(_components.p,{children:[`Requests recorded `,_jsx(_components.em,{children:`before`}),` the credit cutover carry the old placeholder weights, so they are re-priced from their route; requests recorded after it already carry credits and are reported at face value. Traffic the launch beta gives away is metered at its full list price and reported separately under `,_jsx(_components.code,{children:`credits.beta_free`}),`, so `,_jsx(_components.code,{children:`credits.charged`}),` is always what you would actually pay.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`plan_for`}),`, `,_jsx(_components.code,{children:`packs_needed`}),` and `,_jsx(_components.code,{children:`offer`}),` are derived from `,_jsx(_components.code,{children:`credits.per_month`}),` (the window scaled to 30 days), so a two-day window and a quarter recommend comparable plans rather than plans two sizes apart.`]}),`\n`,_jsxs(_components.p,{children:[`Defaults to the last 30 days. Requires the `,_jsx(_components.code,{children:`billing:read`}),` scope. Querying the estimate is not billed.`]}),`\n`,_jsx(Heading,{level:`2`,id:`query-parameters`,children:`Query Parameters`}),`\n`,_jsx(ParamField,{query:`from`,type:`string`,id:`param-from`,children:_jsxs(_components.p,{children:[`Start of the window (`,_jsx(_components.code,{children:`YYYY-MM-DD`}),`). Must be provided together with `,_jsx(_components.code,{children:`to`}),`. Omit both for the last 30 days.`]})}),`\n`,_jsx(ParamField,{query:`to`,type:`string`,id:`param-to`,children:_jsxs(_components.p,{children:[`End of the window (`,_jsx(_components.code,{children:`YYYY-MM-DD`}),`), inclusive. Must be provided together with `,_jsx(_components.code,{children:`from`}),`, may not be in the future, and the window may not exceed 92 days. Today is accepted; the window then ends at the moment you ask, so the projection divides only by time that has elapsed.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(ResponseField,{name:`object`,type:`string`,id:`param-object`,children:[`Always `,_jsx(_components.code,{children:`\"usage_estimate\"`}),`.`]}),`\n`,_jsx(ResponseField,{name:`period`,type:`object`,id:`param-period`,children:_jsxs(Expandable,{title:`Window priced`,children:[_jsx(ResponseField,{name:`from`,type:`string`,id:`param-from-1`,children:`ISO timestamp, inclusive.`}),_jsx(ResponseField,{name:`to`,type:`string`,id:`param-to-1`,children:`ISO timestamp, exclusive. Never later than the moment of the request: a window ending today ends now, not at tomorrow’s midnight.`})]})}),`\n`,_jsx(ResponseField,{name:`schedule_version`,type:`integer`,id:`param-schedule-version`,children:`Version of the credit schedule used to price the window.`}),`\n`,_jsx(ResponseField,{name:`credits`,type:`object`,id:`param-credits`,children:_jsxs(Expandable,{title:`Credit totals`,children:[_jsx(ResponseField,{name:`charged`,type:`integer`,id:`param-charged`,children:`What this traffic would cost you.`}),_jsx(ResponseField,{name:`nominal`,type:`integer`,id:`param-nominal`,children:`The same traffic at list price, including anything the beta waives.`}),_jsxs(ResponseField,{name:`beta_free`,type:`integer`,id:`param-beta-free`,children:[`List-price credits waived by the launch beta (`,_jsx(_components.code,{children:`nominal - charged`}),`).`]}),_jsx(ResponseField,{name:`per_month`,type:`object`,id:`param-per-month`,children:`The same three totals scaled to a 30-day month. Everything about the plan is decided on these, because a pooled monthly allowance can only be compared to a monthly figure.`})]})}),`\n`,_jsx(ResponseField,{name:`requests`,type:`object`,id:`param-requests`,children:_jsxs(Expandable,{title:`Request counts`,children:[_jsx(ResponseField,{name:`total`,type:`integer`,id:`param-total`,children:`Requests recorded in the window, billable or not.`}),_jsx(ResponseField,{name:`unrouted`,type:`integer`,id:`param-unrouted`,children:`Authenticated requests that matched no route (404s).`}),_jsx(ResponseField,{name:`unmapped`,type:`integer`,id:`param-unmapped`,children:`Requests on a route the schedule does not recognize. Reported, never silently priced at zero.`})]})}),`\n`,_jsx(ResponseField,{name:`by_action`,type:`object[]`,id:`param-by-action`,children:_jsxs(Expandable,{title:`Per-action breakdown, most expensive first`,children:[_jsxs(ResponseField,{name:`action_id`,type:`string`,id:`param-action-id`,children:[`Schedule action id (e.g. `,_jsx(_components.code,{children:`search`}),`), or a synthetic bucket: `,_jsx(_components.code,{children:`unmapped`}),`, `,_jsx(_components.code,{children:`unrouted`}),`, `,_jsx(_components.code,{children:`removed:\u003cpath>`}),`, `,_jsx(_components.code,{children:`unpriced:\u003cpath>`}),`, `,_jsx(_components.code,{children:`free:\u003ctype>`}),`.`]}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name`,children:`Human name for the action.`}),_jsx(ResponseField,{name:`requests`,type:`integer`,id:`param-requests-1`,children:`Requests in this bucket.`}),_jsx(ResponseField,{name:`quantity`,type:`number`,id:`param-quantity`,children:`Charged quantity in the action’s own unit (pages, records, items, requests).`}),_jsx(ResponseField,{name:`credits`,type:`integer`,id:`param-credits-1`,children:`Credits you would be charged.`}),_jsx(ResponseField,{name:`nominal_credits`,type:`integer`,id:`param-nominal-credits`,children:`The same rows at list price.`}),_jsxs(ResponseField,{name:`disposition`,type:`string`,id:`param-disposition`,children:[_jsx(_components.code,{children:`charged`}),`, `,_jsx(_components.code,{children:`beta_free`}),` (metered, never debited), `,_jsx(_components.code,{children:`free`}),` (zero-price or non-billable), `,_jsx(_components.code,{children:`mixed`}),` (both, for a window spanning a change), or `,_jsx(_components.code,{children:`unpriced`}),`.`]})]})}),`\n`,_jsx(ResponseField,{name:`unmapped`,type:`object[]`,id:`param-unmapped-1`,children:_jsxs(Expandable,{title:`Routes the schedule does not recognize`,children:[_jsx(ResponseField,{name:`route`,type:`string`,id:`param-route`,children:`Route pattern as recorded.`}),_jsx(ResponseField,{name:`method`,type:`string`,id:`param-method`,children:`HTTP method.`}),_jsx(ResponseField,{name:`endpoint_type`,type:`string`,id:`param-endpoint-type`,children:`Endpoint type the request was billed under at the time.`}),_jsx(ResponseField,{name:`requests`,type:`integer`,id:`param-requests-2`,children:`Requests on this route.`}),_jsx(ResponseField,{name:`credits`,type:`integer`,id:`param-credits-2`,children:`Credits they actually cost.`})]})}),`\n`,_jsx(ResponseField,{name:`plan_for`,type:`object | null`,id:`param-plan-for`,children:_jsxs(Expandable,{title:`Smallest plan that fits the projected month`,children:[_jsxs(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:[`Plan id (`,_jsx(_components.code,{children:`free`}),`, `,_jsx(_components.code,{children:`starter`}),`, `,_jsx(_components.code,{children:`growth`}),`, `,_jsx(_components.code,{children:`scale`}),`).`]}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-1`,children:`Plan name.`}),_jsx(ResponseField,{name:`credits_included`,type:`integer | null`,id:`param-credits-included`,children:`Pooled credits per month.`}),_jsx(ResponseField,{name:`per_month_annual`,type:`number | null`,id:`param-per-month-annual`,children:`Price per month when billed yearly, USD.`}),_jsx(ResponseField,{name:`monthly`,type:`number | null`,id:`param-monthly`,children:`Price per month when billed monthly, USD.`})]})}),`\n`,_jsx(ResponseField,{name:`packs_needed`,type:`object | null`,id:`param-packs-needed`,children:_jsxs(Expandable,{title:`The extra-credit purchase that covers the shortfall`,children:[_jsxs(ResponseField,{name:`credits`,type:`integer`,id:`param-credits-3`,children:[`Extra credits the purchase adds: `,_jsx(_components.code,{children:`usd`}),` times the plan’s credits per dollar.`]}),_jsxs(ResponseField,{name:`count`,type:`integer`,id:`param-count`,children:[`Purchases needed to buy them. `,_jsx(_components.code,{children:`1`}),` unless the shortfall costs more than the `,`$10,000 limit on a single purchase.\u003c/ResponseField> \u003cResponseField name=\"usd\" type=\"number\">The whole-dollar extra-credit purchase that covers the projected shortfall at the plan's rate, USD. At least $`,`10, the smallest purchase.`]})]})}),`\n`,_jsxs(ResponseField,{name:`above_self_serve`,type:`boolean`,id:`param-above-self-serve`,children:[_jsx(_components.code,{children:`true`}),` when the projected month is beyond what the plan ladder plus extra credits sells; `,_jsx(_components.code,{children:`plan_for`}),` is then `,_jsx(_components.code,{children:`null`}),` and the right next step is a conversation.`]}),`\n`,_jsx(ResponseField,{name:`offer`,type:`object | null`,id:`param-offer`,children:_jsxs(Expandable,{title:`Beta thank-you discount on that plan`,children:[_jsx(ResponseField,{name:`percent_off`,type:`number`,id:`param-percent-off`,children:`Discount percentage.`}),_jsx(ResponseField,{name:`months`,type:`integer`,id:`param-months`,children:`How many months it runs.`}),_jsx(ResponseField,{name:`price_per_month`,type:`number`,id:`param-price-per-month`,children:`The annual per-month price with the discount applied, USD.`})]})}),`\n`,_jsx(ResponseField,{name:`coverage`,type:`object`,id:`param-coverage`,children:_jsxs(Expandable,{title:`What the estimate cannot see`,children:[_jsx(ResponseField,{name:`pre_cutover_unmetered_actions`,type:`string[]`,id:`param-pre-cutover-unmetered-actions`,children:`Actions with no recorded volume before the cutover, because their routes were free and unmetered then.`}),_jsx(ResponseField,{name:`note`,type:`string`,id:`param-note`,children:`Plain-language explanation of the gap.`})]})}),`\n`,_jsx(ResponseField,{name:`request_id`,type:`string`,id:`param-request-id`,children:`Request ID for debugging.`}),`\n`,`\n`,_jsx(Heading,{level:`2`,id:`code-examples`,children:`Code Examples`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.signa.so/v1/organization/usage/estimate?from=2026-08-01\u0026to=2026-08-31\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer sig_xxxxxxxxxxxx\"`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`TypeScript`,numberOfLines:`8`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Signa`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"@signa-so/sdk\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` signa`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` Signa`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({ `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`api_key:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"sig_xxxxxxxxxxxx\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` });`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` estimate`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` signa`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`organization`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`usageEstimate`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` from:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"2026-08-01\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` to:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"2026-08-31\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`8`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`resp `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.get(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.signa.so/v1/organization/usage/estimate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Authorization\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Bearer sig_xxxxxxxxxxxx\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` params`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"from\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-01\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"to\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-31\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`estimate `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` resp.json()`})]}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`related-endpoints`,children:`Related Endpoints`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-reference/administration/get-usage-summary`,children:`Get Usage Summary`}),` — real-time daily usage breakdown`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-reference/administration/get-usage`,children:`Get Usage`}),` — current billing period totals by endpoint type`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-reference/administration/get-credits`,children:`Get Credits`}),` — pooled credit balance`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Usage Estimate","description":"Your recorded traffic priced at the published credit schedule","api":"GET /v1/organization/usage/estimate","href":"/api-reference/administration/get-usage-estimate"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,em:`em`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Expandable,Heading,Note,ParamField,ResponseExample,ResponseField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Credits:`}),` 0.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Beta.`}),` This is an `,_jsx(_components.em,{children:`estimate`}),` of what past traffic would cost on the published credit schedule, not a bill, an invoice, or a commitment. The response shape may still change.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsx(_components.p,{children:`Prices the authenticated organization’s recorded API traffic at the published credit schedule and shows which plan that traffic lands on. Use it to answer “what would last month have cost” before anything is charged.`}),`\n`,_jsxs(_components.p,{children:[`Requests recorded `,_jsx(_components.em,{children:`before`}),` the credit cutover carry the old placeholder weights, so they are re-priced from their route; requests recorded after it already carry credits and are reported at face value. Traffic the launch beta gives away is metered at its full list price and reported separately under `,_jsx(_components.code,{children:`credits.beta_free`}),`, so `,_jsx(_components.code,{children:`credits.charged`}),` is always what you would actually pay.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`plan_for`}),`, `,_jsx(_components.code,{children:`packs_needed`}),` and `,_jsx(_components.code,{children:`offer`}),` are derived from `,_jsx(_components.code,{children:`credits.per_month`}),` (the window scaled to 30 days), so a two-day window and a quarter recommend comparable plans rather than plans two sizes apart.`]}),`\n`,_jsxs(_components.p,{children:[`Defaults to the last 30 days. Requires the `,_jsx(_components.code,{children:`billing:read`}),` scope. Querying the estimate is not billed.`]}),`\n`,_jsx(Heading,{level:`2`,id:`query-parameters`,children:`Query Parameters`}),`\n`,_jsx(ParamField,{query:`from`,type:`string`,id:`param-from`,children:_jsxs(_components.p,{children:[`Start of the window (`,_jsx(_components.code,{children:`YYYY-MM-DD`}),`). Must be provided together with `,_jsx(_components.code,{children:`to`}),`. Omit both for the last 30 days.`]})}),`\n`,_jsx(ParamField,{query:`to`,type:`string`,id:`param-to`,children:_jsxs(_components.p,{children:[`End of the window (`,_jsx(_components.code,{children:`YYYY-MM-DD`}),`), inclusive. Must be provided together with `,_jsx(_components.code,{children:`from`}),`, may not be in the future, and the window may not exceed 92 days. Today is accepted; the window then ends at the moment you ask, so the projection divides only by time that has elapsed.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(ResponseField,{name:`object`,type:`string`,id:`param-object`,children:[`Always `,_jsx(_components.code,{children:`\"usage_estimate\"`}),`.`]}),`\n`,_jsx(ResponseField,{name:`period`,type:`object`,id:`param-period`,children:_jsxs(Expandable,{title:`Window priced`,children:[_jsx(ResponseField,{name:`from`,type:`string`,id:`param-from-1`,children:`ISO timestamp, inclusive.`}),_jsx(ResponseField,{name:`to`,type:`string`,id:`param-to-1`,children:`ISO timestamp, exclusive. Never later than the moment of the request: a window ending today ends now, not at tomorrow’s midnight.`})]})}),`\n`,_jsx(ResponseField,{name:`schedule_version`,type:`integer`,id:`param-schedule-version`,children:`Version of the credit schedule used to price the window.`}),`\n`,_jsx(ResponseField,{name:`credits`,type:`object`,id:`param-credits`,children:_jsxs(Expandable,{title:`Credit totals`,children:[_jsx(ResponseField,{name:`charged`,type:`integer`,id:`param-charged`,children:`What this traffic would cost you.`}),_jsx(ResponseField,{name:`nominal`,type:`integer`,id:`param-nominal`,children:`The same traffic at list price, including anything the beta waives.`}),_jsxs(ResponseField,{name:`beta_free`,type:`integer`,id:`param-beta-free`,children:[`List-price credits waived by the launch beta (`,_jsx(_components.code,{children:`nominal - charged`}),`).`]}),_jsx(ResponseField,{name:`per_month`,type:`object`,id:`param-per-month`,children:`The same three totals scaled to a 30-day month. Everything about the plan is decided on these, because a pooled monthly allowance can only be compared to a monthly figure.`})]})}),`\n`,_jsx(ResponseField,{name:`requests`,type:`object`,id:`param-requests`,children:_jsxs(Expandable,{title:`Request counts`,children:[_jsx(ResponseField,{name:`total`,type:`integer`,id:`param-total`,children:`Requests recorded in the window, billable or not.`}),_jsx(ResponseField,{name:`unrouted`,type:`integer`,id:`param-unrouted`,children:`Authenticated requests that matched no route (404s).`}),_jsx(ResponseField,{name:`unmapped`,type:`integer`,id:`param-unmapped`,children:`Requests on a route the schedule does not recognize. Reported, never silently priced at zero.`})]})}),`\n`,_jsx(ResponseField,{name:`by_action`,type:`object[]`,id:`param-by-action`,children:_jsxs(Expandable,{title:`Per-action breakdown, most expensive first`,children:[_jsxs(ResponseField,{name:`action_id`,type:`string`,id:`param-action-id`,children:[`Schedule action id (e.g. `,_jsx(_components.code,{children:`search`}),`), or a synthetic bucket: `,_jsx(_components.code,{children:`unmapped`}),`, `,_jsx(_components.code,{children:`unrouted`}),`, `,_jsx(_components.code,{children:`removed:\u003cpath>`}),`, `,_jsx(_components.code,{children:`unpriced:\u003cpath>`}),`, `,_jsx(_components.code,{children:`free:\u003ctype>`}),`.`]}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name`,children:`Human name for the action.`}),_jsx(ResponseField,{name:`requests`,type:`integer`,id:`param-requests-1`,children:`Requests in this bucket.`}),_jsx(ResponseField,{name:`quantity`,type:`number`,id:`param-quantity`,children:`Charged quantity in the action’s own unit (pages, records, items, requests).`}),_jsx(ResponseField,{name:`credits`,type:`integer`,id:`param-credits-1`,children:`Credits you would be charged.`}),_jsx(ResponseField,{name:`nominal_credits`,type:`integer`,id:`param-nominal-credits`,children:`The same rows at list price.`}),_jsxs(ResponseField,{name:`disposition`,type:`string`,id:`param-disposition`,children:[_jsx(_components.code,{children:`charged`}),`, `,_jsx(_components.code,{children:`beta_free`}),` (metered, never debited), `,_jsx(_components.code,{children:`free`}),` (zero-price or non-billable), `,_jsx(_components.code,{children:`mixed`}),` (both, for a window spanning a change), or `,_jsx(_components.code,{children:`unpriced`}),`.`]})]})}),`\n`,_jsx(ResponseField,{name:`unmapped`,type:`object[]`,id:`param-unmapped-1`,children:_jsxs(Expandable,{title:`Routes the schedule does not recognize`,children:[_jsx(ResponseField,{name:`route`,type:`string`,id:`param-route`,children:`Route pattern as recorded.`}),_jsx(ResponseField,{name:`method`,type:`string`,id:`param-method`,children:`HTTP method.`}),_jsx(ResponseField,{name:`endpoint_type`,type:`string`,id:`param-endpoint-type`,children:`Endpoint type the request was billed under at the time.`}),_jsx(ResponseField,{name:`requests`,type:`integer`,id:`param-requests-2`,children:`Requests on this route.`}),_jsx(ResponseField,{name:`credits`,type:`integer`,id:`param-credits-2`,children:`Credits they actually cost.`})]})}),`\n`,_jsx(ResponseField,{name:`plan_for`,type:`object | null`,id:`param-plan-for`,children:_jsxs(Expandable,{title:`Smallest plan that fits the projected month`,children:[_jsxs(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:[`Plan id (`,_jsx(_components.code,{children:`free`}),`, `,_jsx(_components.code,{children:`starter`}),`, `,_jsx(_components.code,{children:`growth`}),`, `,_jsx(_components.code,{children:`scale`}),`).`]}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-1`,children:`Plan name.`}),_jsx(ResponseField,{name:`credits_included`,type:`integer | null`,id:`param-credits-included`,children:`Pooled credits per month.`}),_jsx(ResponseField,{name:`per_month_annual`,type:`number | null`,id:`param-per-month-annual`,children:`Price per month when billed yearly, USD.`}),_jsx(ResponseField,{name:`monthly`,type:`number | null`,id:`param-monthly`,children:`Price per month when billed monthly, USD.`})]})}),`\n`,_jsx(ResponseField,{name:`packs_needed`,type:`object | null`,id:`param-packs-needed`,children:_jsxs(Expandable,{title:`The extra-credit purchase that covers the shortfall`,children:[_jsxs(ResponseField,{name:`credits`,type:`integer`,id:`param-credits-3`,children:[`Extra credits the purchase adds: `,_jsx(_components.code,{children:`usd`}),` times the plan’s credits per dollar.`]}),_jsxs(ResponseField,{name:`count`,type:`integer`,id:`param-count`,children:[`Purchases needed to buy them. `,_jsx(_components.code,{children:`1`}),` unless the shortfall costs more than the `,`$10,000 limit on a single purchase.\u003c/ResponseField> \u003cResponseField name=\"usd\" type=\"number\">The whole-dollar extra-credit purchase that covers the projected shortfall at the plan's rate, USD. At least $`,`10, the smallest purchase.`]})]})}),`\n`,_jsxs(ResponseField,{name:`above_self_serve`,type:`boolean`,id:`param-above-self-serve`,children:[_jsx(_components.code,{children:`true`}),` when the projected month is beyond what the plan ladder plus extra credits sells; `,_jsx(_components.code,{children:`plan_for`}),` is then `,_jsx(_components.code,{children:`null`}),` and the right next step is a conversation.`]}),`\n`,_jsx(ResponseField,{name:`offer`,type:`object | null`,id:`param-offer`,children:_jsxs(Expandable,{title:`Beta thank-you discount on that plan`,children:[_jsx(ResponseField,{name:`percent_off`,type:`number`,id:`param-percent-off`,children:`Discount percentage.`}),_jsx(ResponseField,{name:`months`,type:`integer`,id:`param-months`,children:`How many months it runs.`}),_jsx(ResponseField,{name:`price_per_month`,type:`number`,id:`param-price-per-month`,children:`The annual per-month price with the discount applied, USD.`})]})}),`\n`,_jsx(ResponseField,{name:`coverage`,type:`object`,id:`param-coverage`,children:_jsxs(Expandable,{title:`What the estimate cannot see`,children:[_jsx(ResponseField,{name:`pre_cutover_unmetered_actions`,type:`string[]`,id:`param-pre-cutover-unmetered-actions`,children:`Actions with no recorded volume before the cutover, because their routes were free and unmetered then.`}),_jsx(ResponseField,{name:`note`,type:`string`,id:`param-note`,children:`Plain-language explanation of the gap.`})]})}),`\n`,_jsx(ResponseField,{name:`request_id`,type:`string`,id:`param-request-id`,children:`Request ID for debugging.`}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:``,numberOfLines:`57`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`57`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"object\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"usage_estimate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"period\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"from\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-01T00:00:00.000Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"to\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-09-01T00:00:00.000Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"schedule_version\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"credits\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"charged\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`31500`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"nominal\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`33500`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"beta_free\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"per_month\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"charged\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`30484`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"nominal\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`32419`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"beta_free\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1935`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"requests\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"total\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`3155`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"unrouted\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"unmapped\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"by_action\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"action_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"search\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Search\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"requests\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`3000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"quantity\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`3000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"credits\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`30000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"nominal_credits\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`30000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"disposition\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"charged\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"action_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"read\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Retrieve\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"requests\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`153`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"quantity\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1500`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"credits\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1500`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"nominal_credits\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1500`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"disposition\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"charged\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"action_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"screen\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Screening\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"requests\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"quantity\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"credits\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"nominal_credits\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"disposition\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"beta_free\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"unmapped\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"plan_for\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"growth\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Growth\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"credits_included\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`100000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"per_month_annual\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`399`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"monthly\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`529`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"packs_needed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"above_self_serve\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"offer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"percent_off\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`25`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"months\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`12`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"price_per_month\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`299.25`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"coverage\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"pre_cutover_unmetered_actions\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"class_lookup\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"rules_lookup\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`],`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"note\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Class and rules lookups were free and not counted before the switch to credits, so this estimate cannot show how many you made before then. Everything since the switch is included. Monitoring (mark watch, filing watch, marks under management) is priced by the day, not per request, so it is not part of this estimate.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"request_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"req_abc123\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),`\n`,_jsx(Heading,{level:`2`,id:`code-examples`,children:`Code Examples`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.signa.so/v1/organization/usage/estimate?from=2026-08-01\u0026to=2026-08-31\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer sig_xxxxxxxxxxxx\"`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`TypeScript`,numberOfLines:`8`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Signa`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"@signa-so/sdk\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` signa`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` Signa`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({ `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`api_key:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"sig_xxxxxxxxxxxx\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` });`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` estimate`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` signa`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`organization`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`usageEstimate`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` from:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"2026-08-01\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` to:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"2026-08-31\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`8`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`resp `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.get(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.signa.so/v1/organization/usage/estimate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Authorization\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Bearer sig_xxxxxxxxxxxx\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` params`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"from\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-01\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"to\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-08-31\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`},`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`estimate `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` resp.json()`})]}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`related-endpoints`,children:`Related Endpoints`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-reference/administration/get-usage-summary`,children:`Get Usage Summary`}),` — real-time daily usage breakdown`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-reference/administration/get-usage`,children:`Get Usage`}),` — current billing period totals by endpoint type`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/api-reference/administration/get-credits`,children:`Get Credits`}),` — pooled credit balance`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Usage Estimate","description":"Your recorded traffic priced at the published credit schedule","api":"GET /v1/organization/usage/estimate","href":"/api-reference/administration/get-usage-estimate"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[]},{"title":"Query Parameters","slug":"query-parameters","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Code Examples","slug":"code-examples","depth":2,"children":[]},{"title":"Related Endpoints","slug":"related-endpoints","depth":2,"children":[]}],"codeExamples":{"response":{"type":"ResponseExample","children":[{"filename":"","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"57\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"object\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"usage_estimate\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"period\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: { \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"from\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-08-01T00:00:00.000Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"to\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"2026-09-01T00:00:00.000Z\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"schedule_version\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">2\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"credits\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"charged\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">31500\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"nominal\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">33500\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"beta_free\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">2000\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"per_month\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: { \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"charged\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">30484\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"nominal\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">32419\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"beta_free\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1935\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"requests\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: { \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"total\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">3155\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"unrouted\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">2\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"unmapped\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">0\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"by_action\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"action_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"search\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Search\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"requests\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">3000\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"quantity\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">3000\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"credits\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">30000\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"nominal_credits\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">30000\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"disposition\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"charged\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"action_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"read\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Retrieve\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"requests\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">153\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"quantity\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1500\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"credits\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1500\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"nominal_credits\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">1500\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"disposition\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"charged\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"action_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"screen\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Screening\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"requests\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">2\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"quantity\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">2\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"credits\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">0\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"nominal_credits\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">2000\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"disposition\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"beta_free\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"unmapped\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"plan_for\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"growth\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"name\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Growth\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"credits_included\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">100000\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"per_month_annual\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">399\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"monthly\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">529\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"packs_needed\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">null\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"above_self_serve\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\">false\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"offer\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: { \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"percent_off\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">25\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"months\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">12\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\">\"price_per_month\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">299.25\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"coverage\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"pre_cutover_unmetered_actions\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"class_lookup\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"rules_lookup\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"note\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Class and rules lookups were free and not counted before the switch to credits, so this estimate cannot show how many you made before then. Everything since the switch is included. Monitoring (mark watch, filing watch, marks under management) is priced by the day, not per request, so it is not part of this estimate.\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"request_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"req_abc123\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Get Usage Estimate","path":"/v1/organization/usage/estimate","servers":[{"url":"https://api.signa.so"}],"method":"get","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{"from":{"schema":[{"type":"string","description":"Start of the window ( `YYYY-MM-DD` ). Must be provided together with `to` . Omit both for the last 30 days."}]},"to":{"schema":[{"type":"string","description":"End of the window ( `YYYY-MM-DD` ), inclusive. Must be provided together with `from` , may not be in the future, and the window may not exceed 92 days. Today is accepted; the window then ends at the moment you ask, so the projection divides only by time that has elapsed."}]}},"header":{},"cookie":{},"path":{}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"object":[{"type":"string","description":"Always `\"usage_estimate\"` ."}],"period":[{"type":"object","properties":{"from":[{"type":"string","description":"ISO timestamp, inclusive."}],"to":[{"type":"string","description":"ISO timestamp, exclusive. Never later than the moment of the request: a window ending today ends now, not at tomorrow’s midnight."}]}}],"schedule_version":[{"type":"integer","description":"Version of the credit schedule used to price the window."}],"credits":[{"type":"object","properties":{"charged":[{"type":"integer","description":"What this traffic would cost you."}],"nominal":[{"type":"integer","description":"The same traffic at list price, including anything the beta waives."}],"beta_free":[{"type":"integer","description":"List-price credits waived by the launch beta ( `nominal - charged` )."}],"per_month":[{"type":"object","properties":{},"description":"The same three totals scaled to a 30-day month. Everything about the plan is decided on these, because a pooled monthly allowance can only be compared to a monthly figure."}]}}],"requests":[{"type":"object","properties":{"total":[{"type":"integer","description":"Requests recorded in the window, billable or not."}],"unrouted":[{"type":"integer","description":"Authenticated requests that matched no route (404s)."}],"unmapped":[{"type":"integer","description":"Requests on a route the schedule does not recognize. Reported, never silently priced at zero."}]}}],"by_action":[{"type":"array","items":[{"type":"object","properties":{"action_id":[{"type":"string","description":"Schedule action id (e.g. `search` ), or a synthetic bucket: `unmapped` , `unrouted` , `removed:\u003cpath>` , `unpriced:\u003cpath>` , `free:\u003ctype>` ."}],"name":[{"type":"string","description":"Human name for the action."}],"requests":[{"type":"integer","description":"Requests in this bucket."}],"quantity":[{"type":"number","description":"Charged quantity in the action’s own unit (pages, records, items, requests)."}],"credits":[{"type":"integer","description":"Credits you would be charged."}],"nominal_credits":[{"type":"integer","description":"The same rows at list price."}],"disposition":[{"type":"string","description":"`charged` , `beta_free` (metered, never debited), `free` (zero-price or non-billable), `mixed` (both, for a window spanning a change), or `unpriced` ."}]}}]}],"unmapped":[{"type":"array","items":[{"type":"object","properties":{"route":[{"type":"string","description":"Route pattern as recorded."}],"method":[{"type":"string","description":"HTTP method."}],"endpoint_type":[{"type":"string","description":"Endpoint type the request was billed under at the time."}],"requests":[{"type":"integer","description":"Requests on this route."}],"credits":[{"type":"integer","description":"Credits they actually cost."}]}}]}],"plan_for":[{"type":"object","properties":{"id":[{"type":"string","description":"Plan id ( `free` , `starter` , `growth` , `scale` )."}],"name":[{"type":"string","description":"Plan name."}],"credits_included":[{"type":"object","properties":{},"description":"Pooled credits per month."}],"per_month_annual":[{"type":"object","properties":{},"description":"Price per month when billed yearly, USD."}],"monthly":[{"type":"object","properties":{},"description":"Price per month when billed monthly, USD."}]}}],"packs_needed":[{"type":"object","properties":{"credits":[{"type":"integer","description":"Extra credits the purchase adds: `usd` times the plan’s credits per dollar."}],"count":[{"type":"integer","description":"Purchases needed to buy them. `1` unless the shortfall costs more than the $10,000 limit on a single purchase.\u003c/ResponseField> \u003cResponseField name=\"usd\" type=\"number\">The whole-dollar extra-credit purchase that covers the projected shortfall at the plan's rate, USD. At least $ 10, the smallest purchase."}]}}],"above_self_serve":[{"type":"boolean","description":"`true` when the projected month is beyond what the plan ladder plus extra credits sells; `plan_for` is then `null` and the right next step is a conversation."}],"offer":[{"type":"object","properties":{"percent_off":[{"type":"number","description":"Discount percentage."}],"months":[{"type":"integer","description":"How many months it runs."}],"price_per_month":[{"type":"number","description":"The annual per-month price with the discount applied, USD."}]}}],"coverage":[{"type":"object","properties":{"pre_cutover_unmetered_actions":[{"type":"array","items":[{"type":"string"}],"description":"Actions with no recorded volume before the cutover, because their routes were free and unmetered then."}],"note":[{"type":"string","description":"Plain-language explanation of the gap."}]}}],"request_id":[{"type":"string","description":"Request ID for debugging."}]}}],"examples":{"example":{"value":{"object":"\u003cstring>","period":{"from":"\u003cstring>","to":"\u003cstring>"},"schedule_version":123,"credits":{"charged":123,"nominal":123,"beta_free":123,"per_month":{}},"requests":{"total":123,"unrouted":123,"unmapped":123},"by_action":[{"action_id":"\u003cstring>","name":"\u003cstring>","requests":123,"quantity":123,"credits":123,"nominal_credits":123,"disposition":"\u003cstring>"}],"unmapped":[{"route":"\u003cstring>","method":"\u003cstring>","endpoint_type":"\u003cstring>","requests":123,"credits":123}],"plan_for":{"id":"\u003cstring>","name":"\u003cstring>","credits_included":{},"per_month_annual":{},"monthly":{}},"packs_needed":{"credits":123,"count":123},"above_self_serve":true,"offer":{"percent_off":123,"months":123,"price_per_month":123},"coverage":{"pre_cutover_unmetered_actions":["\u003cstring>"],"note":"\u003cstring>"},"request_id":"\u003cstring>"}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"signa-3e9d3658","siteName":"Signa Docs","title":"Get Usage Estimate - Signa Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-09T21:48:48.444Z","originalFileLocation":"api-reference/administration/get-usage-estimate.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=\"Your recorded traffic priced at the published credit schedule\">\u003cmeta data-mint-head name=\"application-name\" content=\"Signa Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/signa-3e9d3658/dQGWgfNCEyUjAsUh/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/signa-3e9d3658/dQGWgfNCEyUjAsUh/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/signa-3e9d3658/dQGWgfNCEyUjAsUh/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/signa-3e9d3658/dQGWgfNCEyUjAsUh/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/signa-3e9d3658/dQGWgfNCEyUjAsUh/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/signa-3e9d3658/dQGWgfNCEyUjAsUh/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/signa-3e9d3658/dQGWgfNCEyUjAsUh/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/signa-3e9d3658/dQGWgfNCEyUjAsUh/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/signa-3e9d3658/dQGWgfNCEyUjAsUh/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Usage Estimate - Signa Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Your recorded traffic priced at the published credit schedule\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Signa Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.signa.so/api-reference/administration/get-usage-estimate\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://signa-3e9d3658.mintlify.site/_mintlify/api/og/v2?division=Usage+%26+Credits\u0026amp;title=Get+Usage+Estimate\u0026amp;description=Your+recorded+traffic+priced+at+the+published+credit+schedule\u0026amp;theme=6da1633f5a817117a5d2a1f8\u0026amp;signature=0ba26baf4b366a57324ef1db8528881ac0656cadca8592cd6339da82ed879422\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Usage Estimate - Signa Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Your recorded traffic priced at the published credit schedule\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://signa-3e9d3658.mintlify.site/_mintlify/api/og/v2?division=Usage+%26+Credits\u0026amp;title=Get+Usage+Estimate\u0026amp;description=Your+recorded+traffic+priced+at+the+published+credit+schedule\u0026amp;theme=6da1633f5a817117a5d2a1f8\u0026amp;signature=0ba26baf4b366a57324ef1db8528881ac0656cadca8592cd6339da82ed879422\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/signa-3e9d3658/dQGWgfNCEyUjAsUh/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Signa Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#555555\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.signa.so/api-reference/administration/get-usage-estimate\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/administration/get-usage-estimate.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.signa.so/#organization\",\"name\":\"Signa Docs\",\"url\":\"https://docs.signa.so\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/signa-3e9d3658/B1ZmV_4e8OQAWS8j/logo/light.svg?fit=max\u0026auto=format\u0026n=B1ZmV_4e8OQAWS8j\u0026q=85\u0026s=94809fd9be711ab731742afa4d4e58e7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.signa.so#website\",\"name\":\"Signa Docs\",\"url\":\"https://docs.signa.so\",\"publisher\":{\"@id\":\"https://docs.signa.so/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.signa.so/api-reference/administration/get-usage-estimate#webpage\",\"url\":\"https://docs.signa.so/api-reference/administration/get-usage-estimate\",\"name\":\"Get Usage Estimate\",\"description\":\"Your recorded traffic priced at the published credit schedule\",\"dateModified\":\"2026-10-09T21:48:48.444Z\",\"isPartOf\":{\"@id\":\"https://docs.signa.so#website\"},\"breadcrumb\":{\"@id\":\"https://docs.signa.so/api-reference/administration/get-usage-estimate#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.signa.so/api-reference/administration/get-usage-estimate#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Administration\",\"item\":\"https://docs.signa.so/api-reference/administration/get-me\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Usage \u0026 Credits\",\"item\":\"https://docs.signa.so/api-reference/administration/get-usage\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Usage Estimate\",\"item\":\"https://docs.signa.so/api-reference/administration/get-usage-estimate\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.signa.so/api-reference/administration/get-usage-estimate#apireference\",\"headline\":\"Get Usage Estimate\",\"name\":\"Get Usage Estimate\",\"description\":\"Your recorded traffic priced at the published credit schedule\",\"url\":\"https://docs.signa.so/api-reference/administration/get-usage-estimate\",\"mainEntityOfPage\":{\"@id\":\"https://docs.signa.so/api-reference/administration/get-usage-estimate#webpage\"},\"dateModified\":\"2026-10-09T21:48:48.444Z\",\"publisher\":{\"@id\":\"https://docs.signa.so/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.signa.so#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Signa Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Signa Docs","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Rate Limits \u0026 Credits","href":"/api-reference/rate-limits"},{"title":"Errors","href":"/api-reference/errors"}]},{"group":"Trademarks","pages":[{"group":"Search","pages":[{"title":"Search Trademarks","api":"GET /v1/trademarks","href":"/api-reference/trademarks/search-trademarks"},{"title":"Search by Image","api":"POST /v1/trademarks/search/image","tag":"ALPHA","href":"/api-reference/trademarks/trademark-image-search"}]},{"group":"Retrieve","pages":[{"title":"Retrieve Trademark","api":"GET /v1/trademarks/{id}","href":"/api-reference/trademarks/retrieve-trademark"},{"title":"Batch Retrieve","api":"POST /v1/trademarks/batch","href":"/api-reference/trademarks/batch-trademarks"}]},{"group":"Records","pages":[{"title":"Trademark Events","api":"GET /v1/trademarks/{id}/events","href":"/api-reference/trademarks/trademark-events"},{"title":"Trademark Proceedings","api":"GET /v1/trademarks/{id}/proceedings","href":"/api-reference/trademarks/trademark-proceedings"},{"title":"Trademark Assignments","api":"GET /v1/trademarks/{id}/assignments","href":"/api-reference/trademarks/trademark-assignments"},{"title":"Trademark Citations","api":"GET /v1/trademarks/{id}/citations","href":"/api-reference/trademarks/trademark-citations"},{"title":"Trademark Cited By","api":"GET /v1/trademarks/{id}/cited-by","href":"/api-reference/trademarks/trademark-cited-by"},{"title":"Trademark Documents","api":"GET /v1/trademarks/{id}/documents","href":"/api-reference/trademarks/records/documents"}]}]},{"group":"Parties","pages":[{"group":"Entities","pages":[{"title":"Search Entities","api":"GET /v1/entities","href":"/api-reference/parties/search-entities"},{"title":"Retrieve Entity","api":"GET /v1/entities/{id}","href":"/api-reference/parties/retrieve-entity"},{"title":"Entity Trademarks","api":"GET /v1/entities/{id}/trademarks","href":"/api-reference/parties/entity-trademarks"},{"title":"Entity Family","api":"GET /v1/entities/{id}/family","href":"/api-reference/parties/entity-family"}]},{"group":"Owners","pages":[{"title":"Search Owners","api":"GET /v1/owners","href":"/api-reference/parties/search-owners"},{"title":"Retrieve Owner","api":"GET /v1/owners/{id}","href":"/api-reference/parties/retrieve-owner"},{"title":"Owner Trademarks","api":"GET /v1/owners/{id}/trademarks","href":"/api-reference/parties/owner-trademarks"},{"title":"Owner Related Entities","api":"GET /v1/owners/{id}/related","href":"/api-reference/parties/owner-related"}]},{"group":"Attorneys","pages":[{"title":"Search Attorneys","api":"GET /v1/attorneys","href":"/api-reference/parties/search-attorneys"},{"title":"Retrieve Attorney","api":"GET /v1/attorneys/{id}","href":"/api-reference/parties/retrieve-attorney"},{"title":"Attorney Trademarks","api":"GET /v1/attorneys/{id}/trademarks","href":"/api-reference/parties/attorney-trademarks"},{"title":"Attorney Clients","api":"GET /v1/attorneys/{id}/clients","href":"/api-reference/parties/attorney-clients"}]},{"group":"Firms","pages":[{"title":"Search Firms","api":"GET /v1/firms","href":"/api-reference/parties/search-firms"},{"title":"Retrieve Firm","api":"GET /v1/firms/{id}","href":"/api-reference/parties/retrieve-firm"},{"title":"Firm Trademarks","api":"GET /v1/firms/{id}/trademarks","href":"/api-reference/parties/firm-trademarks"},{"title":"Firm Attorneys","api":"GET /v1/firms/{id}/attorneys","href":"/api-reference/parties/firm-attorneys"}]}]},{"group":"Records","pages":[{"group":"Proceedings","pages":[{"title":"Search Proceedings","api":"GET /v1/proceedings","href":"/api-reference/proceedings/search-proceedings"},{"title":"Retrieve Proceeding","api":"GET /v1/proceedings/{id}","href":"/api-reference/proceedings/retrieve-proceeding"}]},{"group":"Assignments","pages":[{"title":"Search Assignments","api":"GET /v1/assignments","href":"/api-reference/records/transactions/search-assignments"},{"title":"Retrieve Assignment","api":"GET /v1/assignments/{id}","href":"/api-reference/records/transactions/retrieve-assignment"}]},{"group":"Citations","pages":[{"title":"Search Citations","api":"GET /v1/citations","href":"/api-reference/citations/search-citations"}]}]},{"group":"Intelligence","pages":[{"group":"Screening","pages":[{"title":"Screen a Name","api":"GET /v1/screening","tag":"ALPHA","href":"/api-reference/screening/screen"},{"title":"Check a Listing","api":"POST /v1/screening/listings","tag":"ALPHA","href":"/api-reference/screening/check-listing"}]},{"group":"Compare","pages":[{"title":"Compare Marks","api":"POST /v1/compare","tag":"ALPHA","href":"/api-reference/compare/compare"}]}]},{"group":"Filing \u0026 docketing","pages":[{"group":"Classification","pages":[{"title":"List Classifications","api":"GET /v1/classifications","href":"/api-reference/reference/list-classifications"},{"title":"Retrieve Classification","api":"GET /v1/classifications/{classNumber}","href":"/api-reference/reference/retrieve-classification"},{"title":"List Goods \u0026 Services","api":"GET /v1/goods-services","href":"/api-reference/reference/list-goods-services"},{"title":"Suggest Classifications","api":"POST /v1/classifications/suggest","href":"/api-reference/reference/suggest-classifications"},{"title":"Suggest Goods \u0026 Services","api":"POST /v1/goods-services/suggest","href":"/api-reference/reference/suggest-goods-services"},{"title":"Validate Goods \u0026 Services","api":"POST /v1/goods-services/validate","href":"/api-reference/reference/validate-goods-services"}]},{"group":"Deadlines","pages":[{"title":"List Deadlines","api":"GET /v1/deadlines","href":"/api-reference/reference/list-deadlines"},{"title":"Compute Deadlines","api":"POST /v1/deadlines/compute","href":"/api-reference/reference/compute-deadlines"},{"title":"Compute Oppositions","api":"POST /v1/oppositions/compute","href":"/api-reference/reference/compute-oppositions"},{"title":"List Deadline Rules","api":"GET /v1/deadline-rules","href":"/api-reference/reference/deadline-rules"},{"title":"List Opposition Rules","api":"GET /v1/opposition-rules","href":"/api-reference/reference/opposition-rules"},{"title":"List Prosecution Rules","api":"GET /v1/prosecution-rules","href":"/api-reference/reference/prosecution-rules"}]},{"group":"Fees","pages":[{"title":"List Fees","api":"GET /v1/fees","href":"/api-reference/fees/list"},{"title":"Estimate Fees","api":"POST /v1/fees/estimate","href":"/api-reference/fees/estimate"}]},{"group":"Reconcile","pages":[{"title":"Reconcile","api":"POST /v1/reconcile","href":"/api-reference/reference/reconcile"}]},{"group":"Portfolios","pages":[{"title":"Create Portfolio","api":"POST /v1/portfolios","href":"/api-reference/portfolios/create"},{"title":"List Portfolios","api":"GET /v1/portfolios","href":"/api-reference/portfolios/list"},{"title":"Retrieve Portfolio","api":"GET /v1/portfolios/{id}","href":"/api-reference/portfolios/retrieve"},{"title":"Update Portfolio","api":"PATCH /v1/portfolios/{id}","href":"/api-reference/portfolios/update"},{"title":"Delete Portfolio","api":"DELETE /v1/portfolios/{id}","href":"/api-reference/portfolios/delete"},{"title":"Add Trademarks","api":"POST /v1/portfolios/{id}/trademarks","href":"/api-reference/portfolios/add-trademarks"},{"title":"Remove Trademarks","api":"POST /v1/portfolios/{id}/trademarks/remove","href":"/api-reference/portfolios/remove-trademarks"},{"title":"List Portfolio Deadlines","api":"GET /v1/portfolios/{id}/deadlines","href":"/api-reference/portfolios/deadlines"},{"title":"Download Portfolio Calendar","api":"GET /v1/portfolios/{id}/deadlines.ics","href":"/api-reference/portfolios/deadlines-ics"}]}]},{"group":"Monitoring","pages":[{"group":"Watches","pages":[{"title":"Create Watch","api":"POST /v1/watches","href":"/api-reference/monitoring/watches/create"},{"title":"List Watches","api":"GET /v1/watches","href":"/api-reference/monitoring/watches/list"},{"title":"Retrieve Watch","api":"GET /v1/watches/{id}","href":"/api-reference/monitoring/watches/retrieve"},{"title":"Update Watch","api":"PATCH /v1/watches/{id}","href":"/api-reference/monitoring/watches/update"},{"title":"Delete Watch","api":"DELETE /v1/watches/{id}","href":"/api-reference/monitoring/watches/delete"},{"title":"Pause Watch","api":"POST /v1/watches/{id}/pause","href":"/api-reference/monitoring/watches/pause"},{"title":"Resume Watch","api":"POST /v1/watches/{id}/resume","href":"/api-reference/monitoring/watches/resume"},{"title":"Preview Watch","api":"POST /v1/watches/preview","href":"/api-reference/monitoring/watches/preview"},{"title":"Bulk Create Watches","api":"POST /v1/watches/bulk","href":"/api-reference/monitoring/watches/bulk"},{"title":"Watch Diagnostics","api":"GET /v1/watches/{id}/diagnostics","href":"/api-reference/monitoring/watches/diagnostics"},{"title":"Watch Attestation","api":"GET /v1/watches/{id}/attestation","href":"/api-reference/monitoring/watches/attestation"},{"title":"Monitoring Status","api":"GET /v1/monitoring/status","href":"/api-reference/monitoring/watches/monitoring-status"}]},{"group":"Alerts","pages":[{"title":"List Alerts","api":"GET /v1/alerts","href":"/api-reference/monitoring/alerts/list"},{"title":"Retrieve Alert","api":"GET /v1/alerts/{id}","href":"/api-reference/monitoring/alerts/retrieve"},{"title":"Lookup Alerts","api":"POST /v1/alerts/lookup","href":"/api-reference/monitoring/alerts/lookup"},{"title":"List Alerts for Watch","api":"GET /v1/watches/{id}/alerts","href":"/api-reference/monitoring/alerts/list-for-watch"}]},{"group":"Events","pages":[{"title":"List Events","api":"GET /v1/events","href":"/api-reference/monitoring/events/list"},{"title":"Retrieve Event","api":"GET /v1/events/{id}","href":"/api-reference/monitoring/events/retrieve"}]},{"group":"Webhooks","pages":[{"title":"Create Webhook","api":"POST /v1/webhooks","href":"/api-reference/monitoring/webhooks/create"},{"title":"List Webhooks","api":"GET /v1/webhooks","href":"/api-reference/monitoring/webhooks/list"},{"title":"Retrieve Webhook","api":"GET /v1/webhooks/{id}","href":"/api-reference/monitoring/webhooks/retrieve"},{"title":"Update Webhook","api":"PATCH /v1/webhooks/{id}","href":"/api-reference/monitoring/webhooks/update"},{"title":"Delete Webhook","api":"DELETE /v1/webhooks/{id}","href":"/api-reference/monitoring/webhooks/delete"},{"title":"Rotate Webhook Secret","api":"POST /v1/webhooks/{id}/rotate-secret","href":"/api-reference/monitoring/webhooks/rotate-secret"},{"title":"Test Webhook","api":"POST /v1/webhooks/{id}/test","href":"/api-reference/monitoring/webhooks/test"},{"title":"List Deliveries","api":"GET /v1/webhooks/{id}/deliveries","href":"/api-reference/monitoring/webhooks/list-deliveries"},{"title":"Retrieve Delivery","api":"GET /v1/webhooks/{id}/deliveries/{did}","href":"/api-reference/monitoring/webhooks/retrieve-delivery"},{"title":"Redeliver Delivery","api":"POST /v1/webhooks/{id}/deliveries/{did}/redeliver","href":"/api-reference/monitoring/webhooks/redeliver"}]}]},{"group":"Analytics","pages":[{"group":"Filing Analytics","pages":[{"title":"Market Analytics","api":"GET /v1/analytics/market","href":"/api-reference/analytics/market"},{"title":"Office Analytics","api":"GET /v1/analytics/offices/{code}","href":"/api-reference/analytics/office-analytics"},{"title":"Classification Analytics","api":"GET /v1/analytics/classifications/{class}","href":"/api-reference/analytics/classification-analytics"}]},{"group":"Party Analytics","pages":[{"title":"Entity Analytics","api":"GET /v1/entities/{id}/analytics","href":"/api-reference/parties/entity-analytics"},{"title":"Owner Analytics","api":"GET /v1/owners/{id}/analytics","href":"/api-reference/parties/owner-analytics"},{"title":"Attorney Analytics","api":"GET /v1/attorneys/{id}/analytics","href":"/api-reference/parties/attorney-analytics"},{"title":"Firm Analytics","api":"GET /v1/firms/{id}/analytics","href":"/api-reference/parties/firm-analytics"}]}]},{"group":"Reference","pages":[{"group":"Offices","pages":[{"title":"List Offices","api":"GET /v1/offices","href":"/api-reference/reference/list-offices"},{"title":"Retrieve Office","api":"GET /v1/offices/{code}","href":"/api-reference/reference/retrieve-office"},{"title":"List Office Votes","api":"GET /v1/offices/votes","href":"/api-reference/reference/list-office-votes"},{"title":"Cast Office Votes","api":"POST /v1/offices/votes","href":"/api-reference/reference/cast-office-votes"},{"title":"Retract Office Vote","api":"DELETE /v1/offices/votes/{code}","href":"/api-reference/reference/retract-office-vote"}]},{"group":"Jurisdictions","pages":[{"title":"List Jurisdictions","api":"GET /v1/jurisdictions","href":"/api-reference/reference/list-jurisdictions"},{"title":"Retrieve Jurisdiction","api":"GET /v1/jurisdictions/{code}","href":"/api-reference/reference/retrieve-jurisdiction"}]},{"group":"Codes \u0026 types","pages":[{"title":"List Design Codes","api":"GET /v1/design-codes","href":"/api-reference/reference/list-design-codes"},{"title":"Retrieve Design Code","api":"GET /v1/design-codes/{code}","href":"/api-reference/reference/retrieve-design-code"},{"title":"List Event Types","api":"GET /v1/event-types","href":"/api-reference/reference/list-event-types"},{"title":"List Status Codes","api":"GET /v1/status-codes","href":"/api-reference/reference/list-status-codes"}]}]},{"group":"Administration","pages":[{"group":"Organization","pages":[{"title":"Get Current Organization","api":"GET /v1/organization/me","href":"/api-reference/administration/get-me"}]},{"group":"API Keys","pages":[{"title":"List API Keys","api":"GET /v1/organization/api-keys","href":"/api-reference/administration/list-api-keys"},{"title":"Create API Key","api":"POST /v1/organization/api-keys","href":"/api-reference/administration/create-api-key"},{"title":"Retrieve API Key","api":"GET /v1/organization/api-keys/{id}","href":"/api-reference/administration/retrieve-api-key"},{"title":"Update API Key","api":"PATCH /v1/organization/api-keys/{id}","href":"/api-reference/administration/update-api-key"},{"title":"Revoke API Key","api":"DELETE /v1/organization/api-keys/{id}","href":"/api-reference/administration/delete-api-key"},{"title":"Rotate API Key","api":"POST /v1/organization/api-keys/{id}/rotate","href":"/api-reference/administration/rotate-api-key"}]},{"group":"Usage \u0026 Credits","pages":[{"title":"Get Usage","api":"GET /v1/organization/usage","href":"/api-reference/administration/get-usage"},{"title":"Get Usage Summary","description":"Daily usage breakdown for the organization","api":"GET /v1/organization/usage/summary","href":"/api-reference/administration/get-usage-summary"},{"title":"Get Usage Estimate","api":"GET /v1/organization/usage/estimate","href":"/api-reference/administration/get-usage-estimate"},{"title":"Get Credits","description":"Pooled credit balance, grant breakdown, and expiry schedule","api":"GET /v1/organization/credits","href":"/api-reference/administration/get-credits"},{"title":"Get Credit Pricing","openapi":"GET /v1/credits/pricing","href":"/api-reference/administration/get-credit-pricing"}]},{"group":"Logs","pages":[{"title":"List Request Logs","api":"GET /v1/organization/logs","href":"/api-reference/administration/get-logs"},{"title":"Retrieve Request Log","api":"GET /v1/organization/logs/{request_id}","href":"/api-reference/administration/retrieve-log"}]},{"group":"Feedback","pages":[{"title":"Submit Feedback","api":"POST /v1/feedback","href":"/api-reference/administration/create-feedback"},{"title":"List Feedback","api":"GET /v1/feedback","href":"/api-reference/administration/list-feedback"},{"title":"Retrieve Feedback","api":"GET /v1/feedback/{id}","href":"/api-reference/administration/get-feedback"}]},{"group":"Health","pages":[{"title":"Health Check","api":"GET /v1/health","href":"/api-reference/health"}]}]},{"group":"SDK","pages":[{"title":"TypeScript SDK","sidebarTitle":"TypeScript SDK","href":"/sdk/typescript"}]}]},{"tab":"Research","pages":[{"title":"Research","href":"/research"}]}]},"basePath":"","title":"Get Usage Estimate - Signa Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js"]}