Skip to main content

Get Usage Details​

Select

SaaS

Retrieves the usage details for the provided OfferingId as a downloadable CSV file.

  • Standard Offering: Provides a monthly usage report in CSV format.
  • Hourly Offering (e.g., Cloud Rewind): Provides a CSV report with hourly usage details aggregated for the selected month.

Additional optional query parameters are available to filter results by usage type and usage month.

Query Parameters
  • offeringId int32 required

    ID of the offering

  • usageType string

    Possible values: [peak, current]

    Default value: peak

    Usage type for the report. Note: This parameter is not applicable for Hourly Offering (eg., Cloud Rewind)

  • usageMonth date

    Default value: First day of current month

    Format: First day of the month in YYYY-MM-DD (e.g. 2025-06-01).

Responses

OK

Response Headers
  • Content-Disposition string

    Indicates the file is intended to be downloaded by clients with this filename. Filename pattern: - Standard: Subscription Usage Month-to-Date_{Offering Name}_{Usage Month}.csv - Hourly (Cloud Rewind): Subscription Usage_Cloud Rewind_{Usage Month Start}_to_{Usage Month End / Current Date}.csv

Schema
  • string binary
Loading...