v34

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

[In development] Get contract credit utilization

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 cumulative credit utilization data grouped by contract period for the specified Organization.

get/v1/organizations/{organizationId}/billing/credits/contracts-utilization

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 utilization data.

Response

Contract credit utilization data.

Example response

{
  "contracts": [
    {
      "contractStartDate": "2025-04-29T00:00:00.000Z",
      "contractEndDate": "2025-05-30T00:00:00.000Z",
      "items": [
        {
          "date": "2025-05-01T00:00:00.000Z",
          "credits": 147722.91698535177
        }
      ]
    }
  ]
}