Settled usage for the current billing period, per device, derived from the same per-lease rows billing reads. Built for a headless integrator: the hosted product shows this in a browser, and this endpoint is how you read it without one.
activeMs is measured active time, corrections already applied, which is the quantity this control plane measures and therefore the one it reports. reportedMinutes is minutes AS ALREADY REPORTED to billing, echoed rather than recalculated here, because the per-lease rounding rule has a single owner and a second implementation of it would be a second source of truth for an invoice. It is ABSENT until reporting has happened, which is a different fact from zero: read it as not reported yet, never as free.
Only settled leases appear. A lease you are holding right now is still open and is not in these numbers, so this is an account of what has finished rather than a live meter.
A key narrowed to a subset of devices sees only that subset.
Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.
GET
/
v1
/
usage
Error
A valid request URL is required to generate request examples
The control surface credential. Send Authorization: Bearer <token>.
Two kinds of token are accepted and they are told apart by shape, not by a separate header. A token beginning pbk_ or puk_ is an org scoped API key, whose public half and secret half are generated together and of which only a hash of the secret is ever stored; anything else is treated as an OAuth 2.1 access token and verified against the authorization server's keys.
Both resolve to the same context: an org, a principal and a set of scopes. Nothing downstream branches on which channel you used, with one deliberate exception, key management, which requires a signed-in person so that a key can never mint another key.
Scopes are enforced when MCP tools are REGISTERED rather than when they are called, so a tool your credential cannot use is absent from tools/list rather than refused mid gesture.
Response
This period's usage.
Settled usage for one billing period, plus the live concurrency reading. Open leases are absent from the settled half: it is an account of what has finished, not a live meter.
billingPeriod
string
required
The UTC month these rows settle into, as YYYY-MM-DD.
asOf
string<date-time>
required
Database clock at read time, so you can judge freshness.
totals
object
required
Show child attributes
devices
object[]
required
Show child attributes
concurrency
object
The concurrency ceiling and what is against it. THE ONE LIVE READING in this body: everything else here is settled work, and this is the state of the fleet as the read happened.
limit is the ceiling the run gate actually enforces, read from the gate rather than reproduced beside it. It is org wide, and a credential narrowed to a subset of devices still sees the whole organisation's numbers, because the whole ceiling is what its next run meets.
inUse below limit IS NOT A PROMISE that a run will start. A device may already be driving one, and a lease may be held elsewhere; those are separate refusals, and starting the run is the only thing that answers them.
ABSENT on a deployment with no agent tier composed, which is a different fact from a ceiling of zero.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PhoneUse","description":"The mobile execution layer for AI agents.","colors":{"primary":"#0c6b4f","light":"#12a06a","dark":"#0a5a43"},"logo":{"light":"https://mintcdn.com/phonebase/asSC9ooLxq3ce7AH/images/logo-light.svg?fit=max\u0026auto=format\u0026n=asSC9ooLxq3ce7AH\u0026q=85\u0026s=797a832db8f0e271d5dbd6beba29a27b","dark":"https://mintcdn.com/phonebase/asSC9ooLxq3ce7AH/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=asSC9ooLxq3ce7AH\u0026q=85\u0026s=82325f8969ce89102cc6e3af558a4436","href":"https://phoneuse.com"},"favicon":"https://mintcdn.com/phonebase/asSC9ooLxq3ce7AH/images/favicon.svg?fit=max\u0026auto=format\u0026n=asSC9ooLxq3ce7AH\u0026q=85\u0026s=5aebe1e05fdad8394b3f4d54e6e75f22","appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"Main site","href":"https://phoneuse.com"}},"footer":{"socials":{"website":"https://phoneuse.com"}},"contextual":{"options":["copy","view","claude","chatgpt","cursor","vscode","mcp"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"phonebase","hasAudioNarration":false,"actualSubdomain":"phonebase","customDomains":["docs.phoneuse.com"],"gitSource":{"type":"github","owner":"phoneuse-official","repo":"phoneuse-api","deployBranch":"docs-release","contentDirectory":"docs/site","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afd0a6c8745fb0d64fce35c","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"API","count":158},{"language":"default","tag":"Endpoints","count":155},{"language":"default","tag":"Docs","count":34},{"language":"default","tag":"Managed Proxy","count":22},{"language":"default","tag":"Minute billing","count":22},{"language":"default","tag":"Devices","count":19},{"language":"default","tag":"Apps","count":18},{"language":"default","tag":"Provisioning","count":14},{"language":"default","tag":"API keys","count":12},{"language":"default","tag":"Copilot","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":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":"custom-rbac-roles","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":"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api/endpoints/usage/read-your-orgs-usage-this-period","slug":"/api/endpoints/usage/read-your-orgs-usage-this-period","pageMetadata":{"title":"Read your org's usage this period","description":"Settled usage for the current billing period, per device, derived from the same per-lease rows billing reads. Built for a headless integrator: the hosted product shows this in a browser, and this endpoint is how you read it without one.\n\n`activeMs` is measured active time, corrections already applied, which is the quantity this control plane measures and therefore the one it reports. `reportedMinutes` is minutes AS ALREADY REPORTED to billing, echoed rather than recalculated here, because the per-lease rounding rule has a single owner and a second implementation of it would be a second source of truth for an invoice. It is ABSENT until reporting has happened, which is a different fact from zero: read it as not reported yet, never as free.\n\nOnly settled leases appear. A lease you are holding right now is still open and is not in these numbers, so this is an account of what has finished rather than a live meter.\n\nA key narrowed to a subset of devices sees only that subset.\n\nHosted deployments only. A local checkout does not mount this route, so calling it there is a 404.","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/usage","href":"/api/endpoints/usage/read-your-orgs-usage-this-period","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Settled usage for the current billing period, per device, derived from the same per-lease rows billing reads. Built for a headless integrator: the hosted product shows this in a browser, and this endpoint is how you read it without one.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"activeMs\"\n }), \" is measured active time, corrections already applied, which is the quantity this control plane measures and therefore the one it reports. \", _jsx(_components.code, {\n children: \"reportedMinutes\"\n }), \" is minutes AS ALREADY REPORTED to billing, echoed rather than recalculated here, because the per-lease rounding rule has a single owner and a second implementation of it would be a second source of truth for an invoice. It is ABSENT until reporting has happened, which is a different fact from zero: read it as not reported yet, never as free.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Only settled leases appear. A lease you are holding right now is still open and is not in these numbers, so this is an account of what has finished rather than a live meter.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"A key narrowed to a subset of devices sees only that subset.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Read your org's usage this period","description":"Settled usage for the current billing period, per device, derived from the same per-lease rows billing reads. Built for a headless integrator: the hosted product shows this in a browser, and this endpoint is how you read it without one.\n\n`activeMs` is measured active time, corrections already applied, which is the quantity this control plane measures and therefore the one it reports. `reportedMinutes` is minutes AS ALREADY REPORTED to billing, echoed rather than recalculated here, because the per-lease rounding rule has a single owner and a second implementation of it would be a second source of truth for an invoice. It is ABSENT until reporting has happened, which is a different fact from zero: read it as not reported yet, never as free.\n\nOnly settled leases appear. A lease you are holding right now is still open and is not in these numbers, so this is an account of what has finished rather than a live meter.\n\nA key narrowed to a subset of devices sees only that subset.\n\nHosted deployments only. A local checkout does not mount this route, so calling it there is a 404.","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/usage","href":"/api/endpoints/usage/read-your-orgs-usage-this-period","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getV1Usage","tags":["Usage"],"summary":"Read your org's usage this period","description":"Settled usage for the current billing period, per device, derived from the same per-lease rows billing reads. Built for a headless integrator: the hosted product shows this in a browser, and this endpoint is how you read it without one.\n\n`activeMs` is measured active time, corrections already applied, which is the quantity this control plane measures and therefore the one it reports. `reportedMinutes` is minutes AS ALREADY REPORTED to billing, echoed rather than recalculated here, because the per-lease rounding rule has a single owner and a second implementation of it would be a second source of truth for an invoice. It is ABSENT until reporting has happened, which is a different fact from zero: read it as not reported yet, never as free.\n\nOnly settled leases appear. A lease you are holding right now is still open and is not in these numbers, so this is an account of what has finished rather than a live meter.\n\nA key narrowed to a subset of devices sees only that subset.\n\nHosted deployments only. A local checkout does not mount this route, so calling it there is a 404.","x-phoneuse-modes":["hosted"],"x-phoneuse-credential":"bearer","security":["7f417a80-438e-43d1-83da-78ec39de5c44"],"responses":{"200":"1a152fa0-b71f-4059-ad68-e96b75aa3edd","401":"c21c6994-a79c-4a48-bfa0-7224f6189318","403":"48381b22-d480-42df-992d-25873dfd48a9","429":"2130cad7-1095-42cf-8d40-be4f3bfe7d63","503":"bb7b2fa7-2bcb-4ae7-9d5c-d30b376546f8"},"method":"get","type":"path","servers":["0b8b9ab5-c46d-4bb8-88b0-6eeb0d5654ea"],"path":"/v1/usage","baseUrlOptions":["{origin}"],"title":"Read your org's usage this period","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"1a152fa0-b71f-4059-ad68-e96b75aa3edd":{"description":"This period's usage.","content":{"application/json":{"schema":{"type":"object","properties":{"billingPeriod":{"type":"string","description":"The UTC month these rows settle into, as YYYY-MM-DD.","isRequired":true,"uniqueKey":"billingPeriod","typeLabel":"string"},"asOf":{"type":"string","format":"date-time","description":"Database clock at read time, so you can judge freshness.","isRequired":true,"uniqueKey":"asOf","typeLabel":"string\u003cdate-time>"},"totals":{"type":"object","properties":{"activeMs":{"type":"integer","isRequired":true,"uniqueKey":"totals.activeMs","typeLabel":"integer"},"leaseCount":{"type":"integer","isRequired":true,"uniqueKey":"totals.leaseCount","typeLabel":"integer"},"deviceCount":{"type":"integer","isRequired":true,"uniqueKey":"totals.deviceCount","typeLabel":"integer"},"reportedMinutes":{"type":"integer","description":"Absent while nothing has been reported yet.","uniqueKey":"totals.reportedMinutes","typeLabel":"integer"}},"required":["activeMs","leaseCount","deviceCount"],"additionalProperties":false,"isRequired":true,"uniqueKey":"totals","typeLabel":"object"},"devices":{"type":"array","items":{"type":"object","properties":{"deviceId":{"type":"string","isRequired":true,"uniqueKey":"devices.items.[INDEX].deviceId","typeLabel":"string"},"backendKind":{"type":"string","isRequired":true,"uniqueKey":"devices.items.[INDEX].backendKind","typeLabel":"string"},"activeMs":{"type":"integer","description":"Settled active milliseconds this period, signed corrections already applied.","isRequired":true,"uniqueKey":"devices.items.[INDEX].activeMs","typeLabel":"integer"},"leaseCount":{"type":"integer","description":"How many settled leases those milliseconds came from.","isRequired":true,"uniqueKey":"devices.items.[INDEX].leaseCount","typeLabel":"integer"},"reportedMinutes":{"type":"integer","description":"Minutes as already reported to billing. Echoed, never recomputed here. ABSENT means not reported yet, which is not the same as zero.","uniqueKey":"devices.items.[INDEX].reportedMinutes","typeLabel":"integer"}},"required":["deviceId","backendKind","activeMs","leaseCount"],"additionalProperties":false,"uniqueKey":"devices.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"devices","typeLabel":"object[]"},"concurrency":{"type":"object","properties":{"limit":{"type":"integer","description":"How many runs your organisation may have in flight at once.","isRequired":true,"uniqueKey":"concurrency.limit","typeLabel":"integer"},"inUse":{"type":"integer","description":"How many it has in flight right now.","isRequired":true,"uniqueKey":"concurrency.inUse","typeLabel":"integer"}},"required":["limit","inUse"],"additionalProperties":false,"description":"The concurrency ceiling and what is against it. THE ONE LIVE READING in this body: everything else here is settled work, and this is the state of the fleet as the read happened.\n\n`limit` is the ceiling the run gate actually enforces, read from the gate rather than reproduced beside it. It is org wide, and a credential narrowed to a subset of devices still sees the whole organisation's numbers, because the whole ceiling is what its next run meets.\n\n`inUse` below `limit` IS NOT A PROMISE that a run will start. A device may already be driving one, and a lease may be held elsewhere; those are separate refusals, and starting the run is the only thing that answers them.\n\nABSENT on a deployment with no agent tier composed, which is a different fact from a ceiling of zero.","uniqueKey":"concurrency","typeLabel":"object"}},"required":["billingPeriod","asOf","totals","devices"],"additionalProperties":false,"description":"Settled usage for one billing period, plus the live concurrency reading. Open leases are absent from the settled half: it is an account of what has finished, not a live meter.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"billingPeriod":"\u003cstring>","asOf":"2023-11-07T05:31:56Z","totals":{"activeMs":123,"leaseCount":123,"deviceCount":123,"reportedMinutes":123},"devices":[{"deviceId":"\u003cstring>","backendKind":"\u003cstring>","activeMs":123,"leaseCount":123,"reportedMinutes":123}],"concurrency":{"limit":123,"inUse":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"c21c6994-a79c-4a48-bfa0-7224f6189318":{"description":"No credential, or one that was refused.","headers":{"WWW-Authenticate":{"description":"A bearer challenge. On a hosted deployment it names the metadata document to discover the authorization server from, and it adds `error=\"invalid_token\"` when a credential was presented and rejected.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","const":"unauthorized","description":"Always `unauthorized` on this response.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"reason":{"type":"string","enum":["missing_credentials","malformed_credentials","invalid_token","token_expired","wrong_audience","missing_org","missing_org_role","unknown_key","revoked_key","expired_key"],"description":"The closed set of ways authentication can fail.","isRequired":true,"uniqueKey":"error.reason","typeLabel":"enum\u003cstring>"},"hint":{"type":"string","description":"A next step in prose, on the reasons where there is one to give: `revoked_key`, `expired_key`, `missing_org_role`, and `invalid_token` when the account is not a member of the named organization. Absent otherwise, so branch on `reason` and show this if it is there.","uniqueKey":"error.hint","typeLabel":"string"}},"required":["code","reason"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"A refused credential. `unknown_key` covers both a keyId nobody has and a secret that does not match, because telling those apart would enumerate keys for you. Revocation and expiry are distinguishable, since you owned that key.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","reason":"missing_credentials","hint":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"48381b22-d480-42df-992d-25873dfd48a9":{"description":"Reading usage needs `devices:read`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["backend_resolution_failed","backend_not_implemented","device_unavailable","device_disconnected","lease_mismatch","lease_required","capability_unsupported","invalid_argument","backend_command_failed","idempotency_conflict","action_outcome_unknown","stale_frame","internal_error","unauthorized","permission_denied","run_not_found","frame_not_found","device_busy","admission_unavailable","checkout_unavailable","checkout_customer_balance","checkout_in_progress","quote_changed","payment_in_progress","out_of_stock","wrong_state","instance_not_served","reverification_required","not_found","receipt_not_found","rate_limited","payload_too_large","origin_not_allowed","api_key_from_browser_origin","key_predates_instance_attribution","org_not_served_by_instance","tenant_binding_unavailable","tenant_binding_unsettled","fleet_at_capacity","forbidden","service_unavailable","invalid_signature","invalid_event","not_settled"],"description":"The closed set of codes this service answers with on purpose, on MCP tools and REST alike (D152). What each one means and when you get it is on the errors page.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable summary. Do not branch on it, branch on `code`.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether re-issuing the same call unchanged is meaningful. It is a property of the occurrence, not of the code, so read the field rather than inferring it.","uniqueKey":"error.retryable","typeLabel":"boolean"}},"required":["code","message"],"additionalProperties":true,"description":"Specific errors add their own fields, such as `deviceId`, `reason` or `capability`. Read the ones you branch on and ignore the rest.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"The control surface error envelope. Every non 2xx JSON body on this surface has this shape.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"backend_resolution_failed","message":"\u003cstring>","retryable":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"2130cad7-1095-42cf-8d40-be4f3bfe7d63":{"description":"Over the request budget for this caller. Hosted deployments only. Which budget applied depends on whether this request carried an `Authorization` header, not on which endpoint it was aimed at. Wait `Retry-After` seconds and retry the same request: the refusal happens before any work, so nothing was partially applied. See /api/rate-limits.","headers":{"Retry-After":{"description":"Whole seconds until one request is available again. Computed from the caller's own remaining allowance, not a fixed constant.","schema":{"type":"string"}},"RateLimit-Limit":{"description":"The budget in effect for this caller class, in requests per minute.","schema":{"type":"string"}},"RateLimit-Remaining":{"description":"Whole requests that were still available when this request was admitted. Zero on a 429.","schema":{"type":"string"}},"RateLimit-Reset":{"description":"Seconds until the allowance is back to full. Longer than `Retry-After`, which is the wait for a single request.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"The budget and its window, as `\u003climit>;w=60`.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","const":"rate_limited","description":"Always `rate_limited` on this response.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human readable summary. The numbers are in the headers, not in here.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"Over the request budget. Raised by the rate limiter before any handler runs, which is why its code is not one of the action codes: nothing was attempted, so no action failed.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limited","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"bb7b2fa7-2bcb-4ae7-9d5c-d30b376546f8":{"description":"The authentication backend could not be reached. The service fails closed: an infrastructure fault is refused, never waved through.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["backend_resolution_failed","backend_not_implemented","device_unavailable","device_disconnected","lease_mismatch","lease_required","capability_unsupported","invalid_argument","backend_command_failed","idempotency_conflict","action_outcome_unknown","stale_frame","internal_error","unauthorized","permission_denied","run_not_found","frame_not_found","device_busy","admission_unavailable","checkout_unavailable","checkout_customer_balance","checkout_in_progress","quote_changed","payment_in_progress","out_of_stock","wrong_state","instance_not_served","reverification_required","not_found","receipt_not_found","rate_limited","payload_too_large","origin_not_allowed","api_key_from_browser_origin","key_predates_instance_attribution","org_not_served_by_instance","tenant_binding_unavailable","tenant_binding_unsettled","fleet_at_capacity","forbidden","service_unavailable","invalid_signature","invalid_event","not_settled"],"description":"The closed set of codes this service answers with on purpose, on MCP tools and REST alike (D152). What each one means and when you get it is on the errors page.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable summary. Do not branch on it, branch on `code`.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"Whether re-issuing the same call unchanged is meaningful. It is a property of the occurrence, not of the code, so read the field rather than inferring it.","uniqueKey":"error.retryable","typeLabel":"boolean"}},"required":["code","message"],"additionalProperties":true,"description":"Specific errors add their own fields, such as `deviceId`, `reason` or `capability`. Read the ones you branch on and ignore the rest.","isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"description":"The control surface error envelope. Every non 2xx JSON body on this surface has this shape.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"backend_resolution_failed","message":"\u003cstring>","retryable":true}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7f417a80-438e-43d1-83da-78ec39de5c44":{"bearerAuth":{"type":"http","scheme":"bearer","description":"The control surface credential. Send `Authorization: Bearer \u003ctoken>`.\n\nTwo kinds of token are accepted and they are told apart by shape, not by a separate header. A token beginning `pbk_` or `puk_` is an org scoped API key, whose public half and secret half are generated together and of which only a hash of the secret is ever stored; anything else is treated as an OAuth 2.1 access token and verified against the authorization server's keys.\n\nBoth resolve to the same context: an org, a principal and a set of scopes. Nothing downstream branches on which channel you used, with one deliberate exception, key management, which requires a signed-in person so that a key can never mint another key.\n\nScopes are enforced when MCP tools are REGISTERED rather than when they are called, so a tool your credential cannot use is absent from `tools/list` rather than refused mid gesture.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"0b8b9ab5-c46d-4bb8-88b0-6eeb0d5654ea":{"url":"{origin}","description":"Your control plane origin.","variables":{"origin":{"default":"https://mcp.phoneuse.com","enum":["https://mcp.phoneuse.com","http://127.0.0.1:8788"],"description":"The hosted deployment serves the public origin its metadata document advertises, and that is the default here. Select the loopback entry instead when you are running a local checkout, which serves the port `PORT` names."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"The control surface credential. Send `Authorization: Bearer \u003ctoken>`.\n\nTwo kinds of token are accepted and they are told apart by shape, not by a separate header. A token beginning `pbk_` or `puk_` is an org scoped API key, whose public half and secret half are generated together and of which only a hash of the secret is ever stored; anything else is treated as an OAuth 2.1 access token and verified against the authorization server's keys.\n\nBoth resolve to the same context: an org, a principal and a set of scopes. Nothing downstream branches on which channel you used, with one deliberate exception, key management, which requires a signed-in person so that a key can never mint another key.\n\nScopes are enforced when MCP tools are REGISTERED rather than when they are called, so a tool your credential cannot use is absent from `tools/list` rather than refused mid gesture.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The control surface credential. Send `Authorization: Bearer \u003ctoken>`.\n\nTwo kinds of token are accepted and they are told apart by shape, not by a separate header. A token beginning `pbk_` or `puk_` is an org scoped API key, whose public half and secret half are generated together and of which only a hash of the secret is ever stored; anything else is treated as an OAuth 2.1 access token and verified against the authorization server's keys.\n\nBoth resolve to the same context: an org, a principal and a set of scopes. Nothing downstream branches on which channel you used, with one deliberate exception, key management, which requires a signed-in person so that a key can never mint another key.\n\nScopes are enforced when MCP tools are REGISTERED rather than when they are called, so a tool your credential cannot use is absent from `tools/list` rather than refused mid gesture.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api/openapi.json"},"subdomain":"phonebase","siteName":"PhoneUse","title":"Read your org's usage this period - PhoneUse","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T04:26:06.456Z","originalFileLocation":"api/endpoints/usage/read-your-orgs-usage-this-period.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=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Settled usage for the current billing period, per device, derived from the same per-lease rows billing reads. Built for a headless integrator: the hosted product shows this in a browser, and this endpoint is how you read it without one. activeMs is measured active time, corrections already applied, which is the quantity this control plane measures and therefore the one it reports. reportedMinutes is minutes AS ALREADY REPORTED to billing, echoed rather than recalculated here, because the per-lease rounding rule has a single owner and a second implementation of it would be a second source of truth for an invoice. It is ABSENT until reporting has happened, which is a different fact from zero: read it as not reported yet, never as free. Only settled leases appear. A lease you are holding right now is still open and is not in these numbers, so this is an account of what has finished rather than a live meter. A key narrowed to a subset of devices sees only that subset. Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PhoneUse\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_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/phonebase/kWipq_KjnF--s93A/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/phonebase/kWipq_KjnF--s93A/_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/phonebase/kWipq_KjnF--s93A/_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/phonebase/kWipq_KjnF--s93A/_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/phonebase/kWipq_KjnF--s93A/_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/phonebase/kWipq_KjnF--s93A/_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/phonebase/kWipq_KjnF--s93A/_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/phonebase/kWipq_KjnF--s93A/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read your org\u0026#x27;s usage this period - PhoneUse\">\u003cmeta data-mint-head property=\"og:description\" content=\"Settled usage for the current billing period, per device, derived from the same per-lease rows billing reads. Built for a headless integrator: the hosted product shows this in a browser, and this endpoint is how you read it without one. activeMs is measured active time, corrections already applied, which is the quantity this control plane measures and therefore the one it reports. reportedMinutes is minutes AS ALREADY REPORTED to billing, echoed rather than recalculated here, because the per-lease rounding rule has a single owner and a second implementation of it would be a second source of truth for an invoice. It is ABSENT until reporting has happened, which is a different fact from zero: read it as not reported yet, never as free. Only settled leases appear. A lease you are holding right now is still open and is not in these numbers, so this is an account of what has finished rather than a live meter. A key narrowed to a subset of devices sees only that subset. Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PhoneUse\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.phoneuse.com/api/endpoints/usage/read-your-orgs-usage-this-period\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://phonebase.mintlify.site/_mintlify/api/og/v2?division=Usage\u0026amp;title=Read+your+org%27s+usage+this+period\u0026amp;description=Settled+usage+for+the+current+billing+period%2C+per+device%2C+derived+from+the+same+per-lease+rows+billing+reads.+Built+for+a+headless+integrator%3A+the+hosted+produc\u0026amp;theme=370fb2999dfbb8f85a217f41\u0026amp;signature=63f22c9d30a9fc031c5108d8378bd89b419bd37e62244321c368af8c6e4edef4\">\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=\"Read your org\u0026#x27;s usage this period - PhoneUse\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Settled usage for the current billing period, per device, derived from the same per-lease rows billing reads. Built for a headless integrator: the hosted product shows this in a browser, and this endpoint is how you read it without one. activeMs is measured active time, corrections already applied, which is the quantity this control plane measures and therefore the one it reports. reportedMinutes is minutes AS ALREADY REPORTED to billing, echoed rather than recalculated here, because the per-lease rounding rule has a single owner and a second implementation of it would be a second source of truth for an invoice. It is ABSENT until reporting has happened, which is a different fact from zero: read it as not reported yet, never as free. Only settled leases appear. A lease you are holding right now is still open and is not in these numbers, so this is an account of what has finished rather than a live meter. A key narrowed to a subset of devices sees only that subset. Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://phonebase.mintlify.site/_mintlify/api/og/v2?division=Usage\u0026amp;title=Read+your+org%27s+usage+this+period\u0026amp;description=Settled+usage+for+the+current+billing+period%2C+per+device%2C+derived+from+the+same+per-lease+rows+billing+reads.+Built+for+a+headless+integrator%3A+the+hosted+produc\u0026amp;theme=370fb2999dfbb8f85a217f41\u0026amp;signature=63f22c9d30a9fc031c5108d8378bd89b419bd37e62244321c368af8c6e4edef4\">\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/phonebase/kWipq_KjnF--s93A/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PhoneUse\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0c6b4f\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.phoneuse.com/api/endpoints/usage/read-your-orgs-usage-this-period\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/endpoints/usage/read-your-orgs-usage-this-period.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.phoneuse.com/#organization\",\"name\":\"PhoneUse\",\"url\":\"https://docs.phoneuse.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/phonebase/asSC9ooLxq3ce7AH/images/logo-light.svg?fit=max\u0026auto=format\u0026n=asSC9ooLxq3ce7AH\u0026q=85\u0026s=797a832db8f0e271d5dbd6beba29a27b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.phoneuse.com#website\",\"name\":\"PhoneUse\",\"url\":\"https://docs.phoneuse.com\",\"publisher\":{\"@id\":\"https://docs.phoneuse.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.phoneuse.com/api/endpoints/usage/read-your-orgs-usage-this-period#webpage\",\"url\":\"https://docs.phoneuse.com/api/endpoints/usage/read-your-orgs-usage-this-period\",\"name\":\"Read your org's usage this period\",\"description\":\"Settled usage for the current billing period, per device, derived from the same per-lease rows billing reads. Built for a headless integrator: the hosted product shows this in a browser, and this endpoint is how you read it without one. activeMs is measured active time, corrections already applied, which is the quantity this control plane measures and therefore the one it reports. reportedMinutes is minutes AS ALREADY REPORTED to billing, echoed rather than recalculated here, because the per-lease rounding rule has a single owner and a second implementation of it would be a second source of truth for an invoice. It is ABSENT until reporting has happened, which is a different fact from zero: read it as not reported yet, never as free. Only settled leases appear. A lease you are holding right now is still open and is not in these numbers, so this is an account of what has finished rather than a live meter. A key narrowed to a subset of devices sees only that subset. Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.\",\"dateModified\":\"2026-10-30T04:26:06.456Z\",\"isPartOf\":{\"@id\":\"https://docs.phoneuse.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.phoneuse.com/api/endpoints/usage/read-your-orgs-usage-this-period#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.phoneuse.com/api/endpoints/usage/read-your-orgs-usage-this-period#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.phoneuse.com/api/endpoints/health/check-that-the-service-is-up\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Usage\",\"item\":\"https://docs.phoneuse.com/api/endpoints/usage/list-your-orgs-receipts\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Read your org's usage this period\",\"item\":\"https://docs.phoneuse.com/api/endpoints/usage/read-your-orgs-usage-this-period\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.phoneuse.com/api/endpoints/usage/read-your-orgs-usage-this-period#apireference\",\"headline\":\"Read your org's usage this period\",\"name\":\"Read your org's usage this period\",\"description\":\"Settled usage for the current billing period, per device, derived from the same per-lease rows billing reads. Built for a headless integrator: the hosted product shows this in a browser, and this endpoint is how you read it without one. activeMs is measured active time, corrections already applied, which is the quantity this control plane measures and therefore the one it reports. reportedMinutes is minutes AS ALREADY REPORTED to billing, echoed rather than recalculated here, because the per-lease rounding rule has a single owner and a second implementation of it would be a second source of truth for an invoice. It is ABSENT until reporting has happened, which is a different fact from zero: read it as not reported yet, never as free. Only settled leases appear. A lease you are holding right now is still open and is not in these numbers, so this is an account of what has finished rather than a live meter. A key narrowed to a subset of devices sees only that subset. Hosted deployments only. A local checkout does not mount this route, so calling it there is a 404.\",\"url\":\"https://docs.phoneuse.com/api/endpoints/usage/read-your-orgs-usage-this-period\",\"mainEntityOfPage\":{\"@id\":\"https://docs.phoneuse.com/api/endpoints/usage/read-your-orgs-usage-this-period#webpage\"},\"dateModified\":\"2026-10-30T04:26:06.456Z\",\"publisher\":{\"@id\":\"https://docs.phoneuse.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.phoneuse.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PhoneUse\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PhoneUse\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/endpoints/usage/read-your-orgs-usage-this-period.md","siteName":"PhoneUse","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":""}]},{"tab":"API","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/api"},{"title":"Versioning and compatibility","href":"/api/versioning"},{"title":"Rate limits","href":"/api/rate-limits"}]},{"group":"Endpoints","pages":[{"group":"Health","pages":[{"title":"Check that the service is up","deprecated":null,"version":null,"openapi":"/api/openapi.json get /healthz","href":"/api/endpoints/health/check-that-the-service-is-up"}]},{"group":"Device surface","pages":[{"title":"Check the run's device channel","deprecated":null,"version":null,"openapi":"/api/openapi.json get /vrx/{runToken}/v1/health","href":"/api/endpoints/device-surface/check-the-runs-device-channel"},{"title":"List the run's device","deprecated":null,"version":null,"openapi":"/api/openapi.json get /vrx/{runToken}/v1/devices","href":"/api/endpoints/device-surface/list-the-runs-device"},{"title":"Fetch a frame","deprecated":null,"version":null,"openapi":"/api/openapi.json get /vrx/{runToken}/v1/devices/{deviceId}/screenshot","href":"/api/endpoints/device-surface/fetch-a-frame"},{"title":"Report the run's outcome","deprecated":null,"version":null,"openapi":"/api/openapi.json post /vrx/{runToken}/v1/report","href":"/api/endpoints/device-surface/report-the-runs-outcome"},{"title":"Act on the device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /vrx/{runToken}/v1/devices/{deviceId}/actions","href":"/api/endpoints/device-surface/act-on-the-device"}]},{"group":"MCP","pages":[{"title":"Why there is no event stream","deprecated":null,"version":null,"openapi":"/api/openapi.json get /mcp","href":"/api/endpoints/mcp/why-there-is-no-event-stream"},{"title":"Send a JSON-RPC request","deprecated":null,"version":null,"openapi":"/api/openapi.json post /mcp","href":"/api/endpoints/mcp/send-a-json-rpc-request"},{"title":"Why there is no session to end","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /mcp","href":"/api/endpoints/mcp/why-there-is-no-session-to-end"}]},{"group":"Apps","pages":[{"title":"Discover visible devices and authoritative application scopes","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/device-capabilities","href":"/api/endpoints/apps/discover-visible-devices-and-authoritative-application-scopes"},{"title":"Read last confirmed phone apps","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/inventory","href":"/api/endpoints/apps/read-last-confirmed-phone-apps"},{"title":"Request bounded read-only application checks","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-library/inventory/refreshes","href":"/api/endpoints/apps/request-bounded-read-only-application-checks"},{"title":"Read application-check progress","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/inventory/refreshes/{refreshId}","href":"/api/endpoints/apps/read-application-check-progress"},{"title":"Read per-device check outcomes","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/inventory/refreshes/{refreshId}/results","href":"/api/endpoints/apps/read-per-device-check-outcomes"},{"title":"Recover a lost mutation response by original key","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-library/requests/{requestKey}","href":"/api/endpoints/apps/recover-a-lost-mutation-response-by-original-key"},{"title":"List installable apps","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/catalog","href":"/api/endpoints/apps/list-installable-apps"},{"title":"Read installation history","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/installations","href":"/api/endpoints/apps/read-installation-history"},{"title":"Install an app","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/installations","href":"/api/endpoints/apps/install-an-app"},{"title":"Recover an app installation","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/installations/by-request/{requestKey}","href":"/api/endpoints/apps/recover-an-app-installation"},{"title":"Check an app installation","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/installations/{installationId}","href":"/api/endpoints/apps/check-an-app-installation"},{"title":"Check an app installation again","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/installations/{installationId}/recheck","href":"/api/endpoints/apps/check-an-app-installation-again"},{"title":"Skip checking an unconfirmed installation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/installations/{installationId}/skip","href":"/api/endpoints/apps/skip-checking-an-unconfirmed-installation"},{"title":"Read a phone's install queue","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/queue","href":"/api/endpoints/apps/read-a-phones-install-queue"},{"title":"Add an app to a phone's install queue","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/queue","href":"/api/endpoints/apps/add-an-app-to-a-phones-install-queue"},{"title":"Recover a queued app by its request key","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/app-store/queue/by-request/{requestKey}","href":"/api/endpoints/apps/recover-a-queued-app-by-its-request-key"},{"title":"Remove a waiting app from a phone's queue","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/queue/{entryId}/remove","href":"/api/endpoints/apps/remove-a-waiting-app-from-a-phones-queue"},{"title":"Pause or resume a phone's install queue","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/app-store/queue/pause","href":"/api/endpoints/apps/pause-or-resume-a-phones-install-queue"}]},{"group":"Runs","pages":[{"title":"Get a short-lived URL for one archived frame","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/frames/{frameId}","href":"/api/endpoints/runs/get-a-short-lived-url-for-one-archived-frame"},{"title":"List your runs","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/runs","href":"/api/endpoints/runs/list-your-runs"},{"title":"Start a run on a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/runs","href":"/api/endpoints/runs/start-a-run-on-a-device"},{"title":"Read a run, optionally waiting for it to move","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/runs/{runId}","href":"/api/endpoints/runs/read-a-run-optionally-waiting-for-it-to-move"},{"title":"Put a run on hold","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/runs/{runId}/pause","href":"/api/endpoints/runs/put-a-run-on-hold"},{"title":"Lift a stop and let the run carry on","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/runs/{runId}/resume","href":"/api/endpoints/runs/lift-a-stop-and-let-the-run-carry-on"},{"title":"Cancel a run","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/runs/{runId}/cancel","href":"/api/endpoints/runs/cancel-a-run"}]},{"group":"Discovery","pages":[{"title":"Discover where to authenticate","deprecated":null,"version":null,"openapi":"/api/openapi.json get /.well-known/oauth-protected-resource","href":"/api/endpoints/discovery/discover-where-to-authenticate"},{"title":"Discover where to authenticate, at the endpoint suffixed path","deprecated":null,"version":null,"openapi":"/api/openapi.json get /.well-known/oauth-protected-resource/mcp","href":"/api/endpoints/discovery/discover-where-to-authenticate-at-the-endpoint-suffixed-path"}]},{"group":"API keys","pages":[{"title":"List the org's keys","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/api-keys","href":"/api/endpoints/api-keys/list-the-orgs-keys"},{"title":"Mint an API key","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/api-keys","href":"/api/endpoints/api-keys/mint-an-api-key"},{"title":"Describe the calling key","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/api-keys/current","href":"/api/endpoints/api-keys/describe-the-calling-key"},{"title":"Revoke the calling key","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/api-keys/current","href":"/api/endpoints/api-keys/revoke-the-calling-key"},{"title":"Revoke a key","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/api-keys/{id}","href":"/api/endpoints/api-keys/revoke-a-key"},{"title":"Rename, renew or narrow a key","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/api-keys/{id}","href":"/api/endpoints/api-keys/rename-renew-or-narrow-a-key"},{"title":"Rotate a key","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/api-keys/{id}/rotate","href":"/api/endpoints/api-keys/rotate-a-key"},{"title":"Start a CLI sign-in","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/cli-sessions","href":"/api/endpoints/api-keys/start-a-cli-sign-in"},{"title":"Poll a CLI sign-in, and collect its key","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/cli-sessions/token","href":"/api/endpoints/api-keys/poll-a-cli-sign-in-and-collect-its-key"},{"title":"Look at a CLI sign-in before approving it","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/cli-sessions/{userCode}","href":"/api/endpoints/api-keys/look-at-a-cli-sign-in-before-approving-it"},{"title":"Approve a CLI sign-in","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/cli-sessions/{userCode}/approve","href":"/api/endpoints/api-keys/approve-a-cli-sign-in"},{"title":"Deny a CLI sign-in","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/cli-sessions/{userCode}/deny","href":"/api/endpoints/api-keys/deny-a-cli-sign-in"}]},{"group":"Usage","pages":[{"title":"List your org's receipts","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/receipts","href":"/api/endpoints/usage/list-your-orgs-receipts"},{"title":"Read one receipt","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/receipts/{idempotencyKey}","href":"/api/endpoints/usage/read-one-receipt"},{"title":"Mark a receipt reviewed","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/receipts/{idempotencyKey}/reviewed","href":"/api/endpoints/usage/mark-a-receipt-reviewed"},{"title":"List a phone's unclear actions","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/unclear-actions","href":"/api/endpoints/usage/list-a-phones-unclear-actions"},{"title":"Confirm a phone looks right","description":"A person looked at the phone and says it looks right after exactly the unclear actions they were shown, named by `ref`. Those actions stop keeping agent tasks waiting; the receipts themselves do not change. An agent task whose own action is confirmed takes a new screenshot before its next action.\n\nUNLIKE marking a receipt reviewed, THIS IS A SIGN-OFF, so it needs a signed in person and `devices:act`. References that are not unclear actions you may confirm on this phone now (already confirmed, another phone, a robot hand, an install, an action still inside its 30 second wait) are ignored rather than refused, so answering a list another tab already confirmed is harmless. The answer says how many were newly confirmed, what is still unclear (with `retryAfterMs` on any still waiting) and whether agent tasks may use the phone now.\n\nHosted deployments only. A local checkout does not mount this route, so calling it there is a 404.","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/unclear-actions/confirm","href":"/api/endpoints/usage/confirm-a-phone-looks-right"},{"title":"Read your org's usage this period","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/usage","href":"/api/endpoints/usage/read-your-orgs-usage-this-period"}]},{"group":"Devices","pages":[{"title":"Small pictures of several devices' screens","description":"The latest small picture of each device you name, for a gallery of tiles. One request answers for a whole page of devices, straight from memory: pictures are refreshed about every 30 seconds while someone is asking, and not at all when nobody is.\n\nLike the screenshot route, you do not need the lease, and looking changes nothing on the device: no receipt, no frame, no charge. Unlike it, the pictures are small (about 180 pixels wide), may be up to a few minutes old (`capturedAt` says when), and are never suitable for deciding where to tap.\n\nEach device answers in one of three states. `ready` carries the picture as a `data:` URL in `image`, with a `version`; send that version back in `have` and an unchanged picture comes back without `image`. `pending` means the first picture is still being taken. `unavailable` carries a `reason`: `offline`, `setting_up` (not delivered yet), `not_entitled` (the rental or paid period has ended), `staff_hold`, `unsupported` (this kind of device has no picture here), `provider_error` (pictures cannot be taken right now), `disabled` (not switched on for your organisation) or `not_found`.\n\nA device your organisation does not own, or one outside an API key's devices, answers `not_found` exactly as an id that never existed does. A failure to take pictures is never an error response: the last good picture stays `ready` with its old `capturedAt`, or the device is `pending` or `unavailable`.\n\nOne answer carries at most 2 MB of pictures. A picture that does not fit answers `pending` with a short `refreshAfterMs`; ask again with `have` for the ones you got and it arrives next. Each caller may ask 20 times a minute here, on top of the shared rate limit.\n\nAsk again after `refreshAfterMs`. Responses are `no-store`.\n\nHosted deployments only. A local checkout does not mount this route, so calling it there is a 404.","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/device-thumbnails","href":"/api/endpoints/devices/small-pictures-of-several-devices-screens"},{"title":"List the devices you can see","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices","href":"/api/endpoints/devices/list-the-devices-you-can-see"},{"title":"Read one device","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}","href":"/api/endpoints/devices/read-one-device"},{"title":"Rename a device","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/devices/{deviceId}","href":"/api/endpoints/devices/rename-a-device"},{"title":"Look at a device's screen","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/screenshot","href":"/api/endpoints/devices/look-at-a-devices-screen"},{"title":"Live video fault observation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/image-maintenance/fault","href":"/api/endpoints/devices/live-video-fault-observation"},{"title":"Saved recovery plan cancellation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/image-maintenance/cancel","href":"/api/endpoints/devices/saved-recovery-plan-cancellation"},{"title":"Original recovery result recheck","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/image-maintenance/recheck","href":"/api/endpoints/devices/original-recovery-result-recheck"},{"title":"Image recovery progress and availability","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/image-maintenance","href":"/api/endpoints/devices/image-recovery-progress-and-availability"},{"title":"Take a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/lease","href":"/api/endpoints/devices/take-a-device"},{"title":"Give a device back","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/devices/{deviceId}/lease","href":"/api/endpoints/devices/give-a-device-back"},{"title":"Keep a device longer","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/devices/{deviceId}/lease","href":"/api/endpoints/devices/keep-a-device-longer"},{"title":"Act on a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/actions","href":"/api/endpoints/devices/act-on-a-device"},{"title":"Who is driving a device","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/driving","href":"/api/endpoints/devices/who-is-driving-a-device"},{"title":"Open a live video session on a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/live-session","href":"/api/endpoints/devices/open-a-live-video-session-on-a-device"},{"title":"Wake a device's screen","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/wake","href":"/api/endpoints/devices/wake-a-devices-screen"},{"title":"Open a live view of a device","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/devices/{deviceId}/stream","href":"/api/endpoints/devices/open-a-live-view-of-a-device"},{"title":"Read the server's clock","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/time","href":"/api/endpoints/devices/read-the-servers-clock"},{"title":"List the devices your organisation currently holds","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/leases","href":"/api/endpoints/devices/list-the-devices-your-organisation-currently-holds"}]},{"group":"Copilot","pages":[{"title":"Ask the copilot","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/copilot","href":"/api/endpoints/copilot/ask-the-copilot"},{"title":"Answer a copilot approval","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/copilot/approvals","href":"/api/endpoints/copilot/answer-a-copilot-approval"},{"title":"Run one tool the person named","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/copilot/commands","href":"/api/endpoints/copilot/run-one-tool-the-person-named"},{"title":"Stop the turn this thread is running","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/copilot/threads/{id}/stop","href":"/api/endpoints/copilot/stop-the-turn-this-thread-is-running"},{"title":"Pick a cut copilot stream back up","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/copilot/threads/{id}/stream","href":"/api/endpoints/copilot/pick-a-cut-copilot-stream-back-up"},{"title":"Your copilot threads","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/copilot/threads","href":"/api/endpoints/copilot/your-copilot-threads"},{"title":"One thread, with a page of its messages","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/copilot/threads/{id}","href":"/api/endpoints/copilot/one-thread-with-a-page-of-its-messages"},{"title":"Delete a thread","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/copilot/threads/{id}","href":"/api/endpoints/copilot/delete-a-thread"},{"title":"Rename a thread","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/copilot/threads/{id}","href":"/api/endpoints/copilot/rename-a-thread"}]},{"group":"Webhooks","pages":[{"title":"Your webhook subscriptions","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/webhooks","href":"/api/endpoints/webhooks/your-webhook-subscriptions"},{"title":"Subscribe your system to what happens here","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/webhooks","href":"/api/endpoints/webhooks/subscribe-your-system-to-what-happens-here"},{"title":"Remove a subscription","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/webhooks/{webhookId}","href":"/api/endpoints/webhooks/remove-a-subscription"},{"title":"Enable or disable a subscription","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/webhooks/{webhookId}","href":"/api/endpoints/webhooks/enable-or-disable-a-subscription"},{"title":"Replace a signing secret","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/webhooks/{webhookId}/rotate","href":"/api/endpoints/webhooks/replace-a-signing-secret"},{"title":"Send a test delivery","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/webhooks/{webhookId}/test","href":"/api/endpoints/webhooks/send-a-test-delivery"},{"title":"What was delivered, and what happened","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/webhooks/{webhookId}/deliveries","href":"/api/endpoints/webhooks/what-was-delivered-and-what-happened"}]},{"group":"Robot purchases","pages":[{"title":"List your robot purchases","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/robot-purchases","href":"/api/endpoints/robot-purchases/list-your-robot-purchases"},{"title":"Read the monthly robot checkout offer","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/robot-purchases/offer","href":"/api/endpoints/robot-purchases/read-the-monthly-robot-checkout-offer"},{"title":"Open the original monthly robot checkout","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/robot-purchases/checkout","href":"/api/endpoints/robot-purchases/open-the-original-monthly-robot-checkout"},{"title":"Read your initial robot purchase receipt","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/robot-purchases/{orderId}","href":"/api/endpoints/robot-purchases/read-your-initial-robot-purchase-receipt"}]},{"group":"Managed Proxy","pages":[{"title":"Quote a multi-unit Proxy purchase","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-purchase-quotes","href":"/api/endpoints/managed-proxy/quote-a-multi-unit-proxy-purchase"},{"title":"Read the original purchase agreement","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-purchase-quotes/{quoteId}","href":"/api/endpoints/managed-proxy/read-the-original-purchase-agreement"},{"title":"Accept the original multi-unit purchase agreement","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-purchases","href":"/api/endpoints/managed-proxy/accept-the-original-multi-unit-purchase-agreement"},{"title":"Read unit delivery and original payment facts","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-purchases/{purchaseId}","href":"/api/endpoints/managed-proxy/read-unit-delivery-and-original-payment-facts"},{"title":"Cancel original undelivered units","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-purchases/{purchaseId}/cancel","href":"/api/endpoints/managed-proxy/cancel-original-undelivered-units"},{"title":"List managed Proxy products","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-products","href":"/api/endpoints/managed-proxy/list-managed-proxy-products"},{"title":"Read a managed Proxy product","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-products/{productId}","href":"/api/endpoints/managed-proxy/read-a-managed-proxy-product"},{"title":"Quote a managed Proxy purchase","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-quotes","href":"/api/endpoints/managed-proxy/quote-a-managed-proxy-purchase"},{"title":"Read the original quote","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-quotes/{quoteId}","href":"/api/endpoints/managed-proxy/read-the-original-quote"},{"title":"List your Proxy orders","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-orders","href":"/api/endpoints/managed-proxy/list-your-proxy-orders"},{"title":"Reserve a quoted Proxy order","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-orders","href":"/api/endpoints/managed-proxy/reserve-a-quoted-proxy-order"},{"title":"Read a Proxy order and its settlement","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-orders/{orderId}","href":"/api/endpoints/managed-proxy/read-a-proxy-order-and-its-settlement"},{"title":"Request hosted Checkout for an order","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-orders/{orderId}/checkout","href":"/api/endpoints/managed-proxy/request-hosted-checkout-for-an-order"},{"title":"Cancel a Proxy order","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-orders/{orderId}/cancel","href":"/api/endpoints/managed-proxy/cancel-a-proxy-order"},{"title":"List your managed Proxies","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxies","href":"/api/endpoints/managed-proxy/list-your-managed-proxies"},{"title":"Read a managed Proxy","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxies/{proxyId}","href":"/api/endpoints/managed-proxy/read-a-managed-proxy"},{"title":"Rename a managed Proxy","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/proxies/{proxyId}","href":"/api/endpoints/managed-proxy/rename-a-managed-proxy"},{"title":"Archive an expired detached Proxy","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxies/{proxyId}/archive","href":"/api/endpoints/managed-proxy/archive-an-expired-detached-proxy"},{"title":"List your Proxy network operations","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-operations","href":"/api/endpoints/managed-proxy/list-your-proxy-network-operations"},{"title":"Connect or disconnect a Proxy","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/proxy-operations","href":"/api/endpoints/managed-proxy/connect-or-disconnect-a-proxy"},{"title":"Read a Proxy operation","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/proxy-operations/{operationId}","href":"/api/endpoints/managed-proxy/read-a-proxy-operation"},{"title":"Read a device's confirmed Proxy relationship","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/devices/{deviceId}/proxy","href":"/api/endpoints/managed-proxy/read-a-devices-confirmed-proxy-relationship"}]},{"group":"Minute billing","pages":[{"title":"/v1/minute/requests/:requestId","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/requests/{requestId}","href":"/api/endpoints/minute-billing/v1minuterequests:requestid"},{"title":"/v1/minute/catalog","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/catalog","href":"/api/endpoints/minute-billing/v1minutecatalog"},{"title":"/v1/minute/wallet","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/wallet","href":"/api/endpoints/minute-billing/v1minutewallet"},{"title":"/v1/minute/topup-quotes","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/topup-quotes","href":"/api/endpoints/minute-billing/v1minutetopup-quotes"},{"title":"/v1/minute/topups","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/topups","href":"/api/endpoints/minute-billing/v1minutetopups"},{"title":"/v1/minute/topups/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/topups/{id}","href":"/api/endpoints/minute-billing/v1minutetopups:id"},{"title":"/v1/minute/topups/:id/abandon","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/topups/{id}/abandon","href":"/api/endpoints/minute-billing/v1minutetopups:idabandon"},{"title":"/v1/minute/starts","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/starts","href":"/api/endpoints/minute-billing/v1minutestarts"},{"title":"/v1/minute/starts/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/starts/{id}","href":"/api/endpoints/minute-billing/v1minutestarts:id"},{"title":"/v1/minute/orders","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/orders","href":"/api/endpoints/minute-billing/v1minuteorders"},{"title":"/v1/minute/orders","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/orders","href":"/api/endpoints/minute-billing/v1minuteorders-1"},{"title":"/v1/minute/orders/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/orders/{id}","href":"/api/endpoints/minute-billing/v1minuteorders:id"},{"title":"/v1/minute/orders/:id/cancel","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/orders/{id}/cancel","href":"/api/endpoints/minute-billing/v1minuteorders:idcancel"},{"title":"/v1/minute/rentals/:deviceId","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/rentals/{deviceId}","href":"/api/endpoints/minute-billing/v1minuterentals:deviceid"},{"title":"/v1/minute/rentals/:deviceId/return","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/rentals/{deviceId}/return","href":"/api/endpoints/minute-billing/v1minuterentals:deviceidreturn"},{"title":"/v1/minute/rentals/:deviceId/resume","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/rentals/{deviceId}/resume","href":"/api/endpoints/minute-billing/v1minuterentals:deviceidresume"},{"title":"/v1/minute/refunds","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/refunds","href":"/api/endpoints/minute-billing/v1minuterefunds"},{"title":"/v1/minute/refunds","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/refunds","href":"/api/endpoints/minute-billing/v1minuterefunds-1"},{"title":"/v1/minute/cases","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/cases","href":"/api/endpoints/minute-billing/v1minutecases"},{"title":"/v1/minute/cases","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/minute/cases","href":"/api/endpoints/minute-billing/v1minutecases-1"},{"title":"/v1/minute/cases/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/cases/{id}","href":"/api/endpoints/minute-billing/v1minutecases:id"},{"title":"/v1/minute/refunds/:id","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/minute/refunds/{id}","href":"/api/endpoints/minute-billing/v1minuterefunds:id"}]},{"group":"Provisioning","pages":[{"title":"Check whether your organisation is provisioned","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/admission","href":"/api/endpoints/provisioning/check-whether-your-organisation-is-provisioned"},{"title":"What your organisation has bought, and where each purchase got to","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/fulfilments","href":"/api/endpoints/provisioning/what-your-organisation-has-bought-and-where-each-purchase-got-to"},{"title":"Whether one checkout was paid","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/orders/{orderId}/payment-status","href":"/api/endpoints/provisioning/whether-one-checkout-was-paid"},{"title":"Cancelling online is retired: contact support","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/fulfilments/{id}/cancel","href":"/api/endpoints/provisioning/cancelling-online-is-retired:-contact-support"},{"title":"Returning online is retired: contact support","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/fulfilments/{id}/return","href":"/api/endpoints/provisioning/returning-online-is-retired:-contact-support"},{"title":"Stop future Cloud phone renewal at Stripe's current period end","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/fulfilments/{id}/cancel-renewal","href":"/api/endpoints/provisioning/stop-future-cloud-phone-renewal-at-stripes-current-period-end"},{"title":"Read a Cloud phone's current monthly renewal state","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/fulfilments/{id}/renewal-status","href":"/api/endpoints/provisioning/read-a-cloud-phones-current-monthly-renewal-state"},{"title":"What you owe next","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/billing/upcoming","href":"/api/endpoints/provisioning/what-you-owe-next"},{"title":"Open the billing portal","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/billing/portal-sessions","href":"/api/endpoints/provisioning/open-the-billing-portal"},{"title":"List what can be bought and what it costs","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/skus","href":"/api/endpoints/provisioning/list-what-can-be-bought-and-what-it-costs"},{"title":"Start provisioning this organisation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/checkout-sessions","href":"/api/endpoints/provisioning/start-provisioning-this-organisation"},{"title":"Check one returned Checkout now","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/checkout-sessions/{orderId}/confirm","href":"/api/endpoints/provisioning/check-one-returned-checkout-now"},{"title":"Where the payment provider delivers","deprecated":null,"version":null,"openapi":"/api/openapi.json post /webhooks/stripe","href":"/api/endpoints/provisioning/where-the-payment-provider-delivers"},{"title":"Where the identity provider delivers","deprecated":null,"version":null,"openapi":"/api/openapi.json post /webhooks/clerk","href":"/api/endpoints/provisioning/where-the-identity-provider-delivers"}]},{"group":"Notifications","pages":[{"title":"The bell, and the list behind it","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/notifications","href":"/api/endpoints/notifications/the-bell-and-the-list-behind-it"},{"title":"Mark notifications read","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/notifications/read","href":"/api/endpoints/notifications/mark-notifications-read"},{"title":"Which emails you receive","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/me/notification-preferences","href":"/api/endpoints/notifications/which-emails-you-receive"},{"title":"Change which emails you receive","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/me/notification-preferences","href":"/api/endpoints/notifications/change-which-emails-you-receive"}]}]}]},{"tab":"Help","pages":[{"title":"Help","href":"/help/overview"}]}]},"basePath":"","title":"Read your org's usage this period - PhoneUse","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BtG4DSkw.js","snippetPresets-C1k1xDhp.js","utils-PMJoEt4Y.js","style-to-object-BY3JEAdk.js","utils-DW3Pr7Jq.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DIISLO2w.js","conditional-requirements-CFM0id0Q.js","cloneDeep-BErNCZCm.js","_Uint8Array-f0PCu9f_.js","isObject-FP1Yky1u.js","ApiExamples-OjY-8mqu.js","usePlaygroundInputsStore-B2HS2hUb.js","shallow-DVFuuIDQ.js","isEqual-DG0UKiQC.js","CodeSnippets-Cy6FBgwN.js","CodeSnippet-D1PtG8ed.js","getApiPlaygroundDisplay-Dkx2eNtL.js","Page-C8Cg25if.js","DynamicMarkdown-BvJIe00T.js","SectionHeading-B0rKYV8d.js","icon-yclzBff4.js","MethodPill-DxA11cCF.js","getPastedJson-CpkIDpMk.js","DuplicateIcon-CFCQNJ-D.js","axios-CsQoIw0U.js","Markdown-CK5C-fmV.js","AssistantPageLink-Cw134Dd-.js","dist-3xM3Qrc7.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}