v34

OpenAPI 3.1.0raw.githubusercontent.com2026-07-130042.4 KB
billing

[In development] Get credit balance and consumption

This endpoint is in development with restricted availability. We do not recommend using this endpoint in production. Functionality might change without notice. Contact Cribl Support to request access.

Get credit balance totals, consumption totals, and contract date ranges for the specified Organization.

get/v1/organizations/{organizationId}/billing/credits/stats

Path parameters

organizationIdstring required

The <code>id</code> of the Organization.

Query parameters

startingOnstring date-time required
Example:2025-05-01T00:00:00.000Z

Inclusive start of the query date range in ISO 8601 format.

endingBeforestring date-time required
Example:2025-06-01T00:00:00.000Z

Exclusive end of the query date range in ISO 8601 format.

window'monthly' | 'daily' required

Aggregation granularity for credit balance and consumption.

Response

Credit balance and consumption totals.

totalCreditsRemainingnumber required

Total credits remaining across all contracts.

totalCreditsUsednumber required

Total credits consumed across all contracts.

totalCreditsAcquirednumber required

Total credits acquired across all contracts.

Example response

{
  "totalCreditsRemaining": 5127123.69,
  "totalCreditsUsed": 2555625.49,
  "totalCreditsAcquired": 11061354.6,
  "contracts": [
    {
      "startDate": "2025-09-17T00:00:00.000Z",
      "endDate": "2026-08-02T00:00:00.000Z"
    }
  ]
}