---
title: "Get information about package consumption"
method: POST
path: "/api/v2/billing-configuration/package-consumption"
tags: ["BillingConfiguration"]
---

# Get information about package consumption

`POST /api/v2/billing-configuration/package-consumption`

## Request

- Base URL: `https://billing-insights.api.relativity.one/billing-drilldown-api`
- URL: `https://billing-insights.api.relativity.one/billing-drilldown-api/api/v2/billing-configuration/package-consumption`
- Auth: none required
- TypeScript: <https://skmtc.dev/relativity/apis/billing-insights-api/docs/api/v2/billing-configuration/package-consumption/post.ts> (a function with typed inputs; its response is checked against the schema)

Get package consumption for specific instance. If the requested data does not exist then 404 is returned.

## Request body

- GetPackageConsumptionRequest
  - `instanceID` string, nullable: Specifies the instanceId for which the data should be returned
  - `metricKey` string, nullable: Specifies the metric key for which the data should be returned. If no metric key is provided, no metric will be returned.

## Response `200`

OK

- GetPackageConsumptionResponse
  - `metricKey` string, nullable: MetricKey
  - `aggregationDateUtc` string, date-time: Date when the recalculation of consumed packages was done
  - `results` PackageConsumptionItem[], nullable: List of package consumptions
    - `type` 'Free' | 'Purchased': Type of the package List of possible values: - Free - Purchased
    - `total` number, double: Total units of the package
    - `consumed` number, double: Consumed units of the package
    - `expirationDateUtc` string, date-time: Expiration date of the package

---

[API](https://skmtc.dev/relativity/apis/billing-insights-api.md) - [All operations](https://skmtc.dev/relativity/apis/billing-insights-api/llms.txt) - [OpenAPI document](https://skmtc.dev/relativity/apis/billing-insights-api/revisions/f6fa4175d8c9?raw)