CRcriblio
billing

Get contract credit utilization

Changed on

Get cumulative credit utilization data grouped by contract period for the specified Organization.

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

Request

  • Base URL
    https://gateway.cribl.cloud
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://login.cribl.cloud/oauth/token
    • or HTTP bearer

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. Must be before endingBefore. Minimum range is 1 day. Maximum range depends on window: 6 months for daily, 7 years for monthly.

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

Exclusive end of the query date range in ISO 8601 format. Must be after startingOn. Minimum range is 1 day. Maximum range depends on window: 6 months for daily, 7 years for monthly.

window'monthly' | 'daily' required

Aggregation granularity for credit utilization data. Determines the maximum allowed date range: up to 6 months for daily, up to 7 years for monthly.

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
        }
      ]
    }
  ]
}

Changes