Skip to content
Aether Docs

Get month-to-date usage and subscriptions

GET
/api/v1/organizations/{orgID}/billing/usage
curl --request GET \
  --url https://api.aetherplatform.cloud/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/billing/usage \
  --header 'Authorization: Bearer <token>'

Returns the current UTC month’s billing summary: flat monthly subscriptions (fixed pools, control plane, packages and package overage, public API endpoints and load balancers) and autoscaling hourly usage records, with a combined total in euros.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
orgID
required
string format: uuid

Organization UUID.

Responses

Section titled “Responses”

200

Section titled “200”

The usage summary.

Media typeapplication/json
object
org_id
required
string format: uuid
period_start
required
string format: date-time
period_end
required
string format: date-time
items
required

Autoscaling hourly usage records for the period.

Array<object>
object
id
required
string format: uuid
org_id
required
string format: uuid
cluster_id
string | null format: uuid
node_pool_id
string | null format: uuid
resource_type
required
string
quantity
required
number format: double
unit
required
string
recorded_at
required
string format: date-time
total_eur
required

Combined month-to-date total (subscriptions + autoscaling usage).

number format: double
subscriptions
required

Flat monthly committed fees: fixed pools, control plane, packages and package overage, public API endpoints and load balancers (see SubscriptionLine.kind).

Array<object>
object
kind
required

Which flat monthly charge this line is. plan is a package fee and plan_overage the resources beyond its allowance (both cluster-scoped, with a null node_pool_id); public_ip is the mandatory public API endpoint every cluster is required to have — one line per cluster per month at the published public_ip rate (€4 at the time of writing), a flat month locked the first time the billing sampler observes the endpoint address, so replacing that address within the month does not add a line; loadbalancer, by contrast, is one line per public load-balancer address, so a cluster with several produces several.

string
Allowed values: node_pool control_plane plan plan_overage public_ip loadbalancer
cluster_id
string | null format: uuid
node_pool_id
string | null format: uuid
name
required
string
amount_eur
required
number format: double
gross_amount_eur
required
number format: double
discount_eur
required
number format: double
Example
{
  "subscriptions": [
    {
      "kind": "node_pool"
    }
  ]
}

401

Section titled “401”

Missing or invalid credentials.

Media typeapplication/json
object
error
required
object
code
required

A stable, machine-readable error code.

string
message
required
string
details
Array<object>
object
field
required
string
code
required
string
message
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}