> ## Documentation Index > Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get organisation usage > Everything the organisation used of Ankra over a window, per meter and period: worker vCPU-hours, ordered playground time, managed service instance time and storage, hosted logs and metrics, and AI requests and tokens. Each line carries its unit, quantity, coverage and price state; usage nobody measured reads unknown with no quantity, never zero, and only a line with a published rate carries an amount, in euro cents. Requires billing.read. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json get /api/v1/org/billing/usage openapi: 3.1.0 info: title: FastAPI version: 0.1.0 servers: - url: https://platform.ankra.app security: [] tags: - name: Organisation IAM description: >- Custom organisation roles and scoped role assignments for member and service-account identities. - name: Clusters description: Create, inspect and manage clusters, and the stacks deployed on them. - name: Managed Clusters description: Provider-managed control planes, driven through one common surface. - name: Imported Clusters description: Clusters that already existed and were connected to Ankra. - name: Cluster Access description: Kubeconfigs, service-account tokens and per-cluster access grants. - name: Kubernetes description: Read and act on the Kubernetes objects inside a cluster. - name: AWS Clusters description: >- Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in your own VPC. - name: Ankra Cloud Clusters description: >- Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud servers: a private network, a NAT router and a bastion per cluster. - name: DigitalOcean Clusters description: Provision and manage DigitalOcean Kubernetes clusters. - name: Hetzner Clusters description: Provision and manage Hetzner Kubernetes clusters. - name: OVH Clusters description: Provision and manage OVH Kubernetes clusters. - name: Scaleway Clusters description: Provision and manage Scaleway Kapsule clusters. - name: UpCloud Clusters description: Provision and manage UpCloud Kubernetes clusters. - name: Applications description: Deploy, configure and observe applications across the fleet. - name: Pipelines description: >- Pipeline definitions, the approval of the authority they declare, and the caches pipelines keep between runs. - name: Deploy Targets description: >- Environments, the hosts registered to receive deployments, and the releases deployed to them. - name: Backups description: >- Backup vaults, restore points, protection posture and captures for stacks and application deployments; a completed capture is not a verified restore. - name: Stack Profiles description: Reusable stack definitions, their versions and sharing. - name: Services description: >- Versioned service packages and explicit sharing. Runtime admission is separate from publication. - name: Charts description: Browse the chart catalogue behind stacks and addons. - name: Helm description: Helm registries, credentials and the charts they expose. - name: Executions description: Long-running platform executions and their jobs. - name: Operations description: Cancel in-flight cluster operations and their jobs. - name: Chat description: Conversational sessions, plans and confirmable actions. - name: AI Management description: >- Customer agent lifecycle, authenticated identity and organisation automation controls. - name: AI Agent Runs description: Autonomous agent runs and their outcomes. - name: AI Tickets description: The AI ticket board, its sync connections and settings. - name: AI Playbooks description: Reusable playbooks the AI lanes execute. - name: AI Conditions description: Conditions that gate AI autonomy. - name: AI Remediation description: >- The organisation's auto-remediation policy: what the AI lanes may fix by themselves, and who approves the rest. - name: AI Engineering Handoffs description: Work the AI lanes escalate to a human engineer. - name: AI Environment description: The environment and base stacks AI demos deploy into. - name: Security description: Findings, advisories, SBOMs, compliance and posture. - name: Cost description: Cluster and fleet cost, rate cards and cost settings. - name: Decisions description: >- The decision ledger behind the Security and Cost queues: proposals a surface computed, the approve and set-aside decisions people took on them, and the receipts of running them. - name: Usage description: >- What your organisation used of Ankra - vCPU-hours, playgrounds, managed services, hosted logs and metrics, and AI - per meter and period, with how completely it was measured and whether a published rate applies. - name: Billing description: Subscription and spend caps. - name: Organisation description: Members, invitations, audit logs and organisation settings. - name: Account description: >- Your own account: the contact email Ankra mails when it differs from your sign-in address. - name: Account Tokens description: Personal access tokens for the API and CLI. - name: Credentials description: The shared credential store. - name: AWS Credentials description: >- AWS credentials: access keys or CloudFormation-onboarded STS roles for cost, EKS and self-managed provisioning. - name: Ankra Cloud Credentials description: >- Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud lanes. - name: Azure Credentials description: Azure credentials and SSH keys. - name: DigitalOcean Credentials description: DigitalOcean credentials and SSH keys. - name: Hetzner Credentials description: Hetzner credentials and SSH keys. - name: OVH Credentials description: OVH credentials and SSH keys. - name: Scaleway Credentials description: Scaleway credentials. - name: UpCloud Credentials description: UpCloud credentials and SSH keys. - name: Data Source Credentials description: Credentials for metrics and log sources. - name: DNS Credentials description: Credentials for DNS providers. - name: Object Storage Buckets description: >- Buckets Ankra creates and manages on an organisation's own provider credentials. - name: DNS description: DNS zones and records, including custom organisation zones. - name: Cloudflare description: Cloudflare domains and the credentials behind them. - name: Avura description: >- The linked Avura organization, the domains it shares with Ankra Platform, and their DNS records. - name: Variables description: Organisation- and cluster-scoped variables. - name: SOPS description: Encrypt and decrypt values with the organisation SOPS config. - name: Alerts description: Alert integrations and ingest credentials. - name: Notifications description: Notification routes and their delivery targets. - name: Support description: Support tickets. - name: AI Settings description: Organisation AI provider, model catalog and per-function model settings paths: /api/v1/org/billing/usage: get: tags: - Usage summary: Get organisation usage description: >- Everything the organisation used of Ankra over a window, per meter and period: worker vCPU-hours, ordered playground time, managed service instance time and storage, hosted logs and metrics, and AI requests and tokens. Each line carries its unit, quantity, coverage and price state; usage nobody measured reads unknown with no quantity, never zero, and only a line with a published rate carries an amount, in euro cents. Requires billing.read. operationId: getOrganisationUsageToken parameters: - name: from in: query required: false schema: format: date type: string description: >- First UTC day to read, YYYY-MM-DD. Defaults to the first day of the current month. Not after today, and not more than 400 days back (how long usage is kept). - name: to in: query required: false schema: format: date type: string description: >- The day after the last UTC day to read, YYYY-MM-DD. Defaults to tomorrow. At most 93 days after from; a longer stretch is read in parts. - name: granularity in: query required: false schema: type: string enum: - month - day default: month description: Period length of each line. - name: group_by in: query required: false schema: type: string enum: - meter - cluster - application - instance default: meter description: >- Split the lines by meter only, or also by cluster, by the application a managed service serves, or by managed service instance. Meters not attributed to the grouping keep one organisation line. responses: '200': description: The usage report. content: application/json: schema: $ref: '#/components/schemas/UsageReport' '400': description: Bearer token not provided or invalid authorization header '401': description: Authentication required '403': description: billing.read is not held, or the token's scopes leave it out '422': description: >- A refused query parameter: one pydantic entry per parameter, naming it in loc. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - BearerAuth: [] components: schemas: UsageReport: type: object description: >- What the organisation used of Ankra over a window, one line per meter, period and group. Usage nobody measured is never shown as zero: a line whose every hour was unmeasured is unknown and has no quantity, and one measured in part is partial and its quantity a lower bound. Only a line Ankra has a published rate for carries an amount; during the managed services pilot nothing else is billed (Terms clause 8.8). required: - from - to - granularity - group_by - lines properties: from: type: string format: date-time description: 'Start of the window: midnight UTC of the first day read.' to: type: string format: date-time description: >- End of the window: midnight UTC after the last day read, or the time of the request when that is earlier - usage that has not happened is not reported. granularity: type: string enum: - month - day description: >- The length of each line's period: a calendar month or a UTC day, cut to the window at either end. group_by: type: string enum: - meter - cluster - application - instance description: >- What the lines are split by. The per-instance and per-application reads are always split by instance. lines: type: array items: $ref: '#/components/schemas/UsageLine' description: >- Ordered by meter, then group, then period. Grouped by meter, every meter answers every period, even with nothing used. Grouped by cluster, application or instance, a group that used none of a meter in a period it was fully measured has no line. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' title: Detail type: array title: HTTPValidationError type: object UsageLine: type: object description: One meter's usage over one period, for one group. required: - meter - unit - period_start - period_end - cluster_id - cluster_name - application_id - instance_id - instance_name - is_shared - quantity - coverage - price_state - price_basis - amount_minor - currency properties: meter: type: string enum: - worker_vcpu_hours - playground_seconds - service_instance_seconds - service_storage_byte_hours - hosted_logs_ingested_bytes - hosted_logs_ingested_lines - hosted_metrics_samples - hosted_metrics_active_series - ai_requests - ai_input_tokens - ai_output_tokens description: >- worker_vcpu_hours: each hour, a cluster's worker vCPUs as last measured that hour. playground_seconds: time an ordered playground was usable at a recorded price. service_instance_seconds: time a managed service instance was deployed, from its deployment to its release, while its cluster could be seen. service_storage_byte_hours: storage requested by the bound volume claims in a managed service instance's namespace, held over time. hosted_logs_ingested_bytes and hosted_logs_ingested_lines: logical log bytes and lines Ankra hosted logs accepted. hosted_metrics_samples: samples Ankra hosted metrics accepted. hosted_metrics_active_series: each hour, the distinct series a cluster had. ai_requests, ai_input_tokens, ai_output_tokens: AI model requests and their tokens, on Ankra's key or the organisation's own. unit: type: string enum: - vcpu_hours - seconds - byte_hours - bytes - lines - samples - series_hours - requests - tokens description: >- The unit of quantity. A level measured each hour (vCPUs, active series, bytes of storage) sums to unit-hours over a period. period_start: type: string format: date-time period_end: type: string format: date-time cluster_id: anyOf: - type: string format: uuid - type: 'null' description: >- The cluster of the group; null unless grouped by cluster, or for a meter not attributed to a cluster (AI usage). cluster_name: anyOf: - type: string - type: 'null' description: The cluster's name; null when it is no longer the organisation's. application_id: anyOf: - type: string format: uuid - type: 'null' description: >- The application of the group: grouped by application, the application whose reviewed service plan the instances serve (null for instances that serve none, and for meters not attributed to applications); in the per-application read, that application. instance_id: anyOf: - type: string format: uuid - type: 'null' description: >- The managed service instance of the group; null unless grouped by instance, and for meters other than the service ones. instance_name: anyOf: - type: string - type: 'null' description: The instance's name. is_shared: type: boolean description: >- Grouped by application: some of this usage is of an instance that serves other applications too and is counted under each of them, so application lines do not add up to the organisation's total. quantity: anyOf: - type: integer format: int64 - type: 'null' description: >- The period's usage in unit: exact when coverage is complete, a lower bound when partial, and null when unknown. coverage: type: string enum: - complete - partial - unknown description: >- complete: every hour (every day, for AI usage) of the period was measured. partial: some were not, or are still being counted. unknown: none was - for instance a service instance whose cluster was offline throughout. price_state: type: string enum: - included - priced - unpriced description: >- included: Ankra publishes no rate and charges nothing for it - the managed services and hosted logs and metrics pilot. priced: a published rate applies and amount_minor is what it makes the quantity cost. unpriced: no rate applies to the line as it is (see price_basis). price_basis: type: string enum: - pilot - plan_rate - price_of_record - flat_fee - not_invoiced - no_rate - organisation_total - other_currency description: >- Why the line is in its price state. pilot: included during the pilot. plan_rate: the plan's per-vCPU-hour rate after its free allowance and annual discount, as the invoice applies it to the hours it bills. price_of_record: a playground's monthly price recorded when it was ordered, pro-rated over the calendar month. flat_fee: the plan bills a flat monthly fee covering vCPU usage. not_invoiced: the plan is not invoiced. no_rate: no per-unit rate is published (AI usage). organisation_total: the plan rates the organisation's vCPU total each hour, so a cluster's share has none of its own. other_currency: the price of record is not in euros. amount_minor: anyOf: - type: integer format: int64 - type: 'null' description: >- What the published rate makes the quantity cost, in minor units of currency (euro cents); null unless price_state is priced. currency: anyOf: - type: string enum: - EUR - type: 'null' description: EUR when amount_minor is set, null otherwise. ValidationError: properties: loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Error Type type: string required: - loc - msg - type title: ValidationError type: object securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.