Generated by API Evangelist
Written by API Evangelist tooling for ClickHouse's API. It is a proposal applied on top of the contract, not a document ClickHouse publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for OpenAPI spec for ClickHouse Cloud Billing API
version: 1.0.0
extends: openapi/clickhouse-billing-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/v1/organizations/{organizationId}/usageCost'].get
update:
x-apievangelist-phrasing:
intent: Get daily usage costs for the organization
effect: read
questions:
- How much did my ClickHouse Cloud organization spend last month, broken down by day?
- Which services cost the most over a date range?
- What's the longest period I can pull usage costs for in one request?
instructions:
- text: Get usage costs for org {org} from {from_date} to {to_date}.
slots:
org: path.organizationId
from_date: query.from_date
to_date: query.to_date
- text: Show daily spend per entity in organization {org} between {from_date} and {to_date}, filtered by {filter}.
slots:
org: path.organizationId
from_date: query.from_date
to_date: query.to_date
filter: query.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/activeBalances'].get
update:
x-apievangelist-phrasing:
intent: List prepaid balances (deprecated endpoint)
effect: read
questions:
- What prepaid balances does my org have, using the older deprecated balances endpoint?
- Can I page through active prepaid balances with limit and offset?
instructions:
- text: List active prepaid balances for org {org} via the deprecated activeBalances endpoint.
slots:
org: path.organizationId
- text: Get prepaid balances for organization {org}, {limit} at a time starting at offset {offset}.
slots:
org: path.organizationId
limit: query.limit
offset: query.offset
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/creditBalances'].get
update:
x-apievangelist-phrasing:
intent: Get the organization's remaining credits
effect: read
questions:
- How many credits do we have left, and which balance expires first?
- What is the total remaining credit across all our active credit balances?
instructions:
- text: Show the active credit balances and total remaining credits for org {org}.
slots:
org: path.organizationId
- text: Tell me which credit balance in organization {org} expires soonest.
slots:
org: path.organizationId
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.