Get Usage Summary

Select

SaaS

Retrieves a list of active subscriptions and it's latest peak usage for the tenant

Response Body

Field	Description	Type	Notes
data	List of Usage Summary entires	Usage Summary Array	See - Usage Summary Object

Usage Summary Object

Field	Description	Type	Notes
offeringId	Offering ID	Integer
offeringName	Offering Name	String
subscriptionType	Subscription type (e.g., trial, paid)	String
contractType	Contract type (e.g., commit, non-commit)	String
entitledQuantity	Entitled/Purchased Quantity for the Offering	Double
consumedQuantity	Consumed quantity for the offering	Double
unit	Unit of measurement (e.g., user, tb)	String
startDate	Start date	Timestamp
endDate	End date	Timestamp

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Get Usage Summary - Success

---

Schema

• data object[]

  offeringId integer

  offeringName string

  subscriptionType string

  contractType string

  entitledQuantity object

  oneOf

  • MOD1
  • MOD2

  ---

  number

  integer int32

  consumedQuantity object

  oneOf

  • MOD1
  • MOD2

  ---

  number

  integer int32

  unit string

  startDate string

  endDate string

{
  "data": [
    {
      "offeringId": 0,
      "offeringName": "string",
      "subscriptionType": "string",
      "contractType": "string",
      "entitledQuantity": 0,
      "consumedQuantity": 0,
      "unit": "string",
      "startDate": "string",
      "endDate": "string"
    }
  ]
}

{
  "data": [
    {
      "offeringId": 25,
      "offeringName": "Microsoft 365 - Enterprise",
      "subscriptionType": "trial",
      "contractType": "non-commit",
      "entitledQuantity": 25,
      "consumedQuantity": 13,
      "unit": "user",
      "startDate": "2025-06-01",
      "endDate": "2025-07-01"
    },
    {
      "offeringId": 26,
      "offeringName": "Storage for SaaS Applications",
      "subscriptionType": "trial",
      "contractType": "non-commit",
      "entitledQuantity": 1.220703125,
      "consumedQuantity": 0.8123,
      "unit": "tb",
      "startDate": "2025-06-01",
      "endDate": "2025-07-01"
    }
  ]
}

Loading...