v34

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

[In development] Get credit grants

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 grants (purchases, rollovers, and refunds) for the specified Organization.

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

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

Response

Credit grants for the queried period.

countnumber required

Total number of items in the response.

Example response

{
  "items": [
    {
      "date": "2025-10-29T00:00:00.000Z",
      "creditsAcquired": 6000000
    }
  ],
  "count": 3
}