Get organization active prepaid balances

GET/v1/organizations/{organizationId}/activeBalances

DEPRECATED. Use the /v1/organizations/{organizationId}/creditBalances endpoint instead.

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.

Authorizations

Authorizationstringheaderrequired
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path parameters

organizationIdstringrequired
ID of the requested organization.

format: uuid

Query parameters

limitoptionalinteger
Maximum number of results to return.

maximum: 100, minimum: 1
Default: 100
offsetoptionalinteger
Number of results to skip before returning.

minimum: 0
Default: 0

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalobject
2 properties
- totalRemainingPrepaidCreditsoptionalnumber
  Total remaining credits across all active prepaid balances, in ClickHouse Credits (CHCs).
- prepaidBalancesoptionalarray ofobject
  List of active prepaid balances for the organization.
  
  6 properties
  idoptionalstring
  Unique ID of the prepaid balance.
  
  format: uuid
  remainingPrepaidCreditsoptionalnumber
  Remaining credits available on this balance, in ClickHouse Credits (CHCs).
  
  totalAmountoptionalnumber
  Total credits granted on this balance, in ClickHouse Credits (CHCs).
  
  amountSpentoptionalnumber
  Credits spent from this balance, in ClickHouse Credits (CHCs).
  
  startDateoptionalstring
  Date the balance became active. ISO-8601, based on the UTC timezone.
  
  format: date-time
  expirationDateoptionalstring
  Date the balance expires. ISO-8601, based on the UTC timezone.
  
  format: date-time

Get organization active prepaid balances

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/activeBalances \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/activeBalances';
const options = {method: 'GET', headers: {Authorization: 'Basic <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/activeBalances"

headers = {"Authorization": "Basic <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "totalRemainingPrepaidCredits": 0,
    "prepaidBalances": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "remainingPrepaidCredits": 0,
        "totalAmount": 0,
        "amountSpent": 0,
        "startDate": "2019-08-24T14:15:22Z",
        "expirationDate": "2019-08-24T14:15:22Z"
      }
    ]
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}