list usageRecordGroups

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

List UsageRecordGroups by the given organization, partner, product, entitlement or buyer. Only provide one or none of the optional query parameters: partner, productId, entitlementId & buyerId .

Parameters

Name	In	Type	Required	Description
`orgId`	path	string	yes	Organization ID
`partner`	query	string	no	Cloud Partner
`buyerId`	query	string	no	filter by buyer ID, default no filter by buyerId if not provided
`entitlementId`	query	string	no	filter by entitlement ID, default no filter by entitlementId if not provided
`status`	query	string	no	The status of the usage record group, default no filter by status if not provided
`source`	query	string	no	The source of the usage record group, default no filter by source if not provided
`metaInfo`	query	string	no	metaInfo filter
`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: ListUsageRecordGroupsResponse

ListUsageRecordGroupsResponse fields:

Field	Type	Required	Description
`nextOffset`	integer	no
`usageRecordGroups`	array<MeteringUsageRecordGroup>	no

MeteringUsageRecordGroup fields:

Field	Type	Required	Description
`buyerID`	string	no
`creationTime`	string	no
`entitlementID`	string	no
`id`	string	no
`lastUpdateTime`	string	no
`metaInfo`	MeteringUsageRecordGroupMetaInfo	no
`organizationID`	string	no
`partner`	string	no
`records`	object	no
`reportedTime`	string	no	nullable
`serialID`	integer	no
`status`	string	no
`usageRecordReportID`	string	no

MeteringUsageRecordGroupMetaInfo fields:

Field	Type	Required	Description
`SkipValidation`	boolean	no	If it is true, the validation of the usage record group is skipped.
`billableRecords`	array<MeteringUsageRecord>	no	for usage metering API v2
`erpInvoiceID`	string	no	ERP invoice ID for tracking usage against external ERP service.
`lagoAmount`	number	no	The lago amount (in dollars) of the customer. This field keeps the largest of the monthly amount. So it can only be updated when the invoice month increases.
`lagoSubscriptionID`	string	no	The lago subscription ID of the customer.
`lagoUsageStartTime`	string	no	The lago usage start time of the customer usage.
`metronomeDailyCostAmount`	number	no	The metronome daily cost amount (in dollars) of the customer.
`metronomeInvoiceCreditBack`	boolean	no	Whether the metronome invoice has been credited back.
`metronomeInvoiceCreditBackAmount`	number	no	The metronome invoice amount (in dollars) of the customer.
`metronomeInvoiceID`	string	no	The metronome invoice ID of the customer.
`metronomeMonthlyInvoiceAmount`	number	no	The metronome monthly invoice amount (in dollars) of the customer. This field keeps the largest amount of the invoice month. So it can only be updated when the invoice month increases.
`metronomeMonthlyInvoiceAmountAdjusted`	number	no	The metronome monthly invoice amount (in dollars) of the customer, which is adjusted by the seller. This field is populated only when the invoice amount is decreased by the seller via credit granting.
`orbInvoiceCreditBack`	boolean	no	Whether the void orb invoice has been credited back.
`orbInvoiceCreditBackAmount`	number	no	The credited-back amount (in dollars) for a voided orb invoice.
`orbInvoiceID`	string	no	The orb invoice ID of the customer.
`originRecords`	object	no	The original records reported by the customer before convertion. If no dimension mapping is applied, this field is the same as the records field.
`source`	UsageRecordGroupSource	no
`stripeInvoiceID`	string	no
`stripePeriodEndTime`	string	no	The stripe period end time of the summary or invoice. UTC time in format "YYYY-MM-DDTHH:MM:SSZ".
`stripePeriodStartTime`	string	no	The stripe period start time of the summary or invoice. UTC time in format "YYYY-MM-DDTHH:MM:SSZ".
`stripeSubscriptionItemID`	string	no
`stripeUsageRecordSummaryID`	string	no
`stripeUsageRecordSummaryTotalUsage`	integer	no
`timestamp`	string	no	The timestamp (UTC)) of when the usage records were generated. Optional, if not provided, the current report timestamp will be used.
`usageAllocations`	object	no	usage allocation information, dimension key -> UsageAllocation array. Only supported for AWS marketplace usage metering at this moment.

MeteringUsageRecord fields:

Field	Type	Required	Description
`key`	string	no	Key is the unique identifier of a billable metric.
`properties`	object	no	Properties is the filters of a billable metric. It should be equal to the filters of the billable metric.
`quantity`	number	no	The quantity (or numeric value) of a billable metric.

400 — Bad request error

Content-Type: application/json

500 — Internal server error

Content-Type: application/json

View as Markdown · Interactive API reference

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