List Usage Metering Daily Records

GET https://api.suger.cloud/org/{orgId}/partner/{partner}/usageMeteringDailyRecord

list the daily records of the usage metering from the cloud marketplace for the given organization, entitlement, or buyer.

Parameters

Name	In	Type	Required	Description
`orgId`	path	string	yes	Organization ID
`partner`	path	string	yes	Filter by the Cloud Partner
`buyerId`	query	string	no	Filter usage metering daily records by the given buyer ID
`entitlementId`	query	string	no	Filter usage metering daily records by the given entitlement ID
`startDate`	query	string	no	start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate
`endDate`	query	string	no	end date (UTC) in YYYY-MM-DD format, default is today
`limit`	query	integer	no	List pagination size, default 1000, max value is 1000
`offset`	query	integer	no	List pagination offset, default 0

Responses

200 — OK

Content-Type: application/json · Schema: ListUsageMeteringDailyRecordsResponse

ListUsageMeteringDailyRecordsResponse fields:

Field	Type	Required	Description
`nextOffset`	integer	no
`usageMeteringDailyRecords`	array<UsageMeteringDailyRecord>	no

UsageMeteringDailyRecord fields:

Field	Type	Required	Description
`amount`	number	no
`date`	string	no
`entitlementID`	string	no	The Entitlement ID of the usage metering daily record.
`groupBysExpression`	string	no	The group bys expression of the usage metering. When the same usage metering key may have multiple expressions of group bys to aggregate the usage.
`key`	string	no	The dimension key of the usage metering.
`partner`	Partner	no
`quantity`	number	no

400 — Bad request error

Content-Type: application/json

500 — Internal server error

Content-Type: application/json

Example

Generated from this operation's schema. Values are placeholders — substitute your own ids, and set SUGER_TOKEN to a bearer token from the OAuth client-credentials exchange.

Request

curl -X GET 'https://api.suger.cloud/org/{orgId}/partner/{partner}/usageMeteringDailyRecord' \
  -H "Authorization: Bearer $SUGER_TOKEN"

Response — 200

{
  "nextOffset": 1,
  "usageMeteringDailyRecords": [
    {
      "amount": 100,
      "date": "2026-01-31T12:00:00Z",
      "entitlementID": "01H0000000000000000000",
      "groupBysExpression": "string",
      "key": "string",
      "partner": "",
      "quantity": 100
    }
  ]
}

Error — 400

"string"

View as Markdown · Interactive API reference

Spotted something wrong or out of date on this page? Tell us and we'll correct it.