Get organization active credit balances

GET/v1/organizations/{organizationId}/creditBalances

Disclaimer: This beta endpoint is evolving; the API contract may change.

Returns the active credit balances for the organization, each with its own balance ID, type and remaining credits, along with the total remaining credits across all of them. A balance is active when it has started, has not expired, and has credits remaining. Balances are ordered by expiration date, soonest first. The list is always present and is empty when the organization has no active balances.

Permission

The API key must have the control-plane:organization:view-billing permission.

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

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
- totalRemainingCreditsoptionalnumber
  Total remaining credits across all active balances, in ClickHouse Credits (CHCs).
- balancesoptionalarray ofobject
  List of active balances for the organization. Empty when the organization has none.
  
  7 properties
  idoptionalstring
  Unique ID of the balance.
  
  format: uuid
  typeoptionalprepaidortrial
  Type of the balance.
  
  remainingCreditsoptionalnumber
  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 credit balances

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

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/creditBalances';
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/creditBalances"

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

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

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "totalRemainingCredits": 0,
    "balances": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "prepaid",
        "remainingCredits": 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"
}