Billing

Get organization usage costs

Returns a grand total and a list of daily, per-entity organization usage cost records for the organization in the queried time period (maximum 31 days). All days in both the request and the response are evaluated based on the UTC timezone.

get/v1/organizations/{organizationId}/usageCost

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/usageCost
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the requested organization.

Query parameters

from_datestring date required

Start date for the report, e.g. 2024-12-19.

to_datestring date required

End date (inclusive) for the report, e.g. 2024-12-20. This date cannot be more than 30 days after from_date (for a maximum queried period of 31 days).

filterstring[]

Filter criteria to apply when retrieving the usage cost report. Currently, only filtering by resource tags is supported.

Response

Successful response

statusnumber

HTTP status code.

requestIdstring uuid

Unique id assigned to every request. UUIDv4

Example response

{
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.