list revenue record details

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

list the raw revenue record details for the given organization, partner, product, entitlement, or buyer.

Parameters

Name	In	Type	Required	Description
`orgId`	path	string	yes	Organization ID
`partner`	path	string	yes	Cloud Partner
`productId`	query	string	no	Filter revenue record details by the given product ID
`buyerId`	query	string	no	Filter revenue record details by the given buyer ID
`entitlementId`	query	string	no	Filter revenue record details 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

Content-Type: application/json · Schema: ListRevenueRecordDetailsResponse

ListRevenueRecordDetailsResponse fields:

Field	Type	Required
`nextOffset`	integer	no
`revenueRecordDetails`	array<RevenueRecordDetail>	no
`total`	integer	no

RevenueRecordDetail fields:

Field	Type	Required
`awsRevenueRecordDetail`	AwsBillingEvent	no
`azureRevenueRecordDetail`	AzureCmaRevenue	no
`gcpRevenueRecordDetail`	GcpChargeUsage	no
`snowflakeRevenueRecordDetail`	SnowflakeInvoiceDetail	no

AwsBillingEvent fields:

Field	Type	Required
`action`	string	no
`actionDate`	NullableTime	no
`agreementID`	string	no
`amount`	number	no
`balanceImpacting`	integer	no
`bankTraceID`	string	no
`billingAddressID`	string	no
`brokerID`	string	no
`buyerID`	string	no
`buyerTransactionReferenceID`	string	no
`currency`	string	no
`dataFeedProductID`	string	no
`disbursementBillingEventID`	string	no
`disbursementReferenceNumber`	string	no
`endUserAccountID`	string	no
`entitlementID`	string	no
`fromAccountID`	string	no
`id`	string	no
`insertDate`	NullableTime	no
`invoiceDate`	NullableTime	no
`invoiceID`	string	no
`offerID`	string	no
`organizationID`	string	no
`parentBillingEventID`	string	no
`paymentDueDate`	NullableTime	no
`productID`	string	no
`refundedBuyerTransactionReferenceID`	string	no
`toAccountID`	string	no
`transactionReferenceID`	string	no
`transactionType`	string	no
`usagePeriodEndDate`	NullableTime	no
`usagePeriodStartDate`	NullableTime	no

AzureCmaRevenue fields:

Field	Type	Required
`azureAssetID`	string	no
`azureBillingAccountID`	string	no
`azureCustomerID`	string	no
`azureOfferID`	string	no
`azurePlanID`	string	no
`billingModel`	string	no
`buyerID`	string	no
`earningID`	string	no
`earningUsd`	number	no
`entitlementID`	string	no
`estimatedPayoutMonth`	NullableTime	no
`invoiceDate`	NullableTime	no
`invoiceDueDate`	NullableTime	no
`invoiceID`	string	no
`offerID`	string	no
`organizationID`	string	no
`paymentID`	string	no
`paymentSentDate`	NullableTime	no
`paymentStatus`	string	no
`payoutStatus`	string	no
`productID`	string	no
`programName`	string	no
`purchaseRecordID`	string	no
`resellerCity`	string	no
`resellerCompany`	string	no
`resellerCountry`	string	no
`resellerEmail`	string	no
`resellerID`	string	no
`resellerState`	string	no
`revenueUsd`	number	no
`termEndDate`	string	no
`termStartDate`	string	no
`transactionDate`	NullableTime	no

GcpChargeUsage fields:

Field	Type	Required
`abandoned`	number	no
`accountID`	string	no
`buyerID`	string	no
`charges`	number	no
`currency`	string	no
`dueVendor`	number	no
`entitlementID`	string	no
`googleEntity`	string	no
`insightAccountID`	string	no
`offerID`	string	no
`ordinal`	integer	no
`organizationID`	string	no
`paymentSchedule`	string	no
`paymentType`	string	no
`prepayCredits`	number	no
`productID`	string	no
`refundBalanceDeductedThisMonth`	number	no
`refundBalanceOutstanding`	number	no
`refundReason`	string	no
`released`	number	no
`reportDate`	string	no
`resource`	string	no
`sku`	string	no
`trialUse`	number	no
`unit`	string	no
`usage`	number	no
`usedBy`	string	no
`withheld`	number	no

SnowflakeInvoiceDetail fields:

Field	Type	Required
`buyerID`	string	no
`consumerAccountLocator`	string	no
`consumerAccountName`	string	no
`consumerBillingEmailAddress`	string	no
`consumerCompanyName`	string	no
`consumerOrganizationName`	string	no
`currency`	string	no
`disbursements`	array<SnowflakeDisbursementDetail>	no
`entitlementID`	string	no
`expectedPayoutAmount`	number	no
`fees`	number	no
`invoiceDate`	string	no
`invoiceStatus`	string	no
`listingDisplayName`	string	no
`listingGlobalName`	string	no
`organizationID`	string	no
`poNumber`	string	no
`productID`	string	no
`salesTaxAmount`	number	no
`stripeDisplayNumber`	string	no
`totalBilledAmount`	number	no
`usageMonth`	string	no

NullableTime fields:

Field	Type	Required	Description
`Time`	string	no
`Valid`	boolean	no	Valid is true if Time is not NULL.

SnowflakeDisbursementDetail fields:

Field	Type	Required
`chargeType`	string	no
`consumerAccountLocator`	string	no
`consumerAccountName`	string	no
`consumerOrganizationName`	string	no
`currency`	string	no
`eventDate`	string	no
`eventType`	string	no
`fees`	number	no
`gross`	number	no
`invoiceDate`	string	no
`listingDisplayName`	string	no
`listingGlobalName`	string	no
`listingName`	string	no
`netAmount`	number	no
`stripeDisplayNumber`	string	no
`taxes`	number	no

Content-Type: application/json

Content-Type: application/json

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