Billing

Get organization active prepaid balances

DEPRECATED. Use the /v1/organizations/{organizationId}/creditBalances endpoint instead. <br /><br /> Returns the active prepaid credit balances for the organization, each with its own balance ID and remaining credits, along with the total remaining credits across all active balances. A balance is active when it has started, has not expired, and has credits remaining. Balances are ordered by expiration date, soonest first, and the returned page is capped at limit (default and maximum 100). When totalCount exceeds the number of returned balances, page with limit/offset to retrieve them all. totalRemainingPrepaidCredits always covers every active balance, not just the returned page.

get/v1/organizations/{organizationId}/activeBalances

Request

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

Path parameters

organizationIdstring uuid required

ID of the requested organization.

Query parameters

limitinteger

Maximum number of results to return.

offsetinteger

Number of results to skip before returning.

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.