> ## 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. # Read billing, trial allowance and linked Cloud credits > Reads the current organisation only. Requires billing.read. Unknown capacity or Cloud credit observations remain null and saving a card does not authorise paid usage. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json get /api/v1/org/billing/activation 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 and the approval of the authority they declare. - 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: Billing description: Subscription and spend caps. - name: Organisation description: Members, invitations, audit logs and organisation settings. - 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/activation: get: tags: - Billing summary: Read billing, trial allowance and linked Cloud credits description: >- Reads the current organisation only. Requires billing.read. Unknown capacity or Cloud credit observations remain null and saving a card does not authorise paid usage. operationId: api_v1_billing_activation_get parameters: - in: query name: organisation_id required: false schema: type: string format: uuid description: >- Expected current organisation; mismatch is rejected, never used to switch scope. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BillingActivationStatus' '401': description: Authentication required '403': description: Billing permission or organisation ownership required '409': description: Organisation changed, consent missing, or reviewed prices changed '422': description: Invalid request '500': description: Billing status or approval could not be confirmed security: - BearerAuth: [] components: schemas: BillingActivationStatus: type: object properties: organisation_id: type: string format: uuid plan_name: type: string paid_usage_enabled: type: boolean trial_limit_vcpu: anyOf: - type: integer minimum: 0 - type: 'null' current_vcpu: anyOf: - type: integer minimum: 0 - type: 'null' observed_at: anyOf: - type: string format: date-time - type: 'null' can_unlock: type: boolean payment_method_ready: type: boolean terms: $ref: '#/components/schemas/BillingActivationTerms' cloud: $ref: '#/components/schemas/BillingCloudInsight' required: - organisation_id - plan_name - paid_usage_enabled - trial_limit_vcpu - current_vcpu - observed_at - can_unlock - payment_method_ready - terms - cloud BillingActivationTerms: description: >- The reviewed owner agreement. paid-usage-2026-10-03 approves Startup and Cloud usage. cloud-usage-2026-10-04 approves Cloud usage only; its zero Platform amounts do not replace an existing paid Platform agreement. type: object properties: version: type: string currency: type: string enum: - eur vcpu_rate_hourly: type: number minimum: 0 free_vcpu_allowance: type: integer minimum: 0 flat_monthly_cents: type: integer minimum: 0 required: - version - currency - vcpu_rate_hourly - free_vcpu_allowance - flat_monthly_cents BillingCloudInsight: type: object properties: state: type: string enum: - linked - not_linked - unavailable account_id: anyOf: - type: string format: uuid - type: 'null' billing_url: anyOf: - type: string - type: 'null' credits_state: type: string enum: - ready - unavailable credits_remaining_cents: anyOf: - type: integer minimum: 0 - type: 'null' credits_expire_at: anyOf: - type: string format: date-time - type: 'null' approval_sync_state: type: string enum: - not_requested - pending - synced - unavailable required: - state - account_id - billing_url - credits_state - credits_remaining_cents - credits_expire_at - approval_sync_state securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.