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

Responses

200 — OK

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
`oracleRevenueRecordDetail`	OracleRevenueRecordDetail	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
`refundEnd`	string	no
`refundReason`	string	no
`refundStart`	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

OracleRevenueRecordDetail fields:

Field	Type	Required
`amountAfterTaxLc`	number	no
`buyerID`	string	no
`channelRecordID`	string	no
`createdAt`	string	no
`currencyCode`	string	no
`customerDomain`	string	no
`customerID`	string	no
`customerName`	string	no
`disbursementAmountUsd`	number	no
`enterprisePeriod`	string	no
`enterpriseQuarter`	string	no
`entitlementID`	string	no
`fxRateLcToUsd`	number	no
`listingID`	string	no
`listingName`	string	no
`organizationID`	string	no
`partnerID`	string	no
`partnerPaymentLc`	number	no
`privateOfferID`	string	no
`privateOfferName`	string	no
`productID`	string	no
`sku`	string	no
`taxAmountLc`	number	no
`updatedAt`	string	no
`usedAmountLc`	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

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}/revenueRecordDetail' \
  -H "Authorization: Bearer $SUGER_TOKEN"

Response — 200

{
  "nextOffset": 1,
  "revenueRecordDetails": [
    {
      "awsRevenueRecordDetail": {
        "action": "string",
        "actionDate": {
          "Time": "2026-01-31T12:00:00Z",
          "Valid": true
        },
        "agreementID": "01H0000000000000000000",
        "amount": 100,
        "balanceImpacting": 1,
        "bankTraceID": "01H0000000000000000000",
        "billingAddressID": "01H0000000000000000000",
        "brokerID": "01H0000000000000000000",
        "buyerID": "01H0000000000000000000",
        "buyerTransactionReferenceID": "01H0000000000000000000",
        "currency": "USD",
        "dataFeedProductID": "01H0000000000000000000"
      },
      "azureRevenueRecordDetail": {
        "azureAssetID": "01H0000000000000000000",
        "azureBillingAccountID": "01H0000000000000000000",
        "azureCustomerID": "01H0000000000000000000",
        "azureOfferID": "01H0000000000000000000",
        "azurePlanID": "01H0000000000000000000",
        "billingModel": "string",
        "buyerID": "01H0000000000000000000",
        "earningID": "01H0000000000000000000",
        "earningUsd": 100,
        "entitlementID": "01H0000000000000000000",
        "estimatedPayoutMonth": {
          "Time": "2026-01-31T12:00:00Z",
          "Valid": true
        },
        "invoiceDate": {
          "Time": "2026-01-31T12:00:00Z",
          "Valid": true
        }
      },
      "gcpRevenueRecordDetail": {
        "abandoned": 100,
        "accountID": "01H0000000000000000000",
        "buyerID": "01H0000000000000000000",
        "charges": 100,
        "currency": "USD",
        "dueVendor": 100,
        "entitlementID": "01H0000000000000000000",
        "googleEntity": "string",
        "insightAccountID": "01H0000000000000000000",
        "offerID": "01H0000000000000000000",
        "ordinal": 1,
        "organizationID": "01H0000000000000000000"
      },
      "oracleRevenueRecordDetail": {
        "amountAfterTaxLc": 100,
        "buyerID": "01H0000000000000000000",
        "channelRecordID": "01H0000000000000000000",
        "createdAt": "2026-01-31T12:00:00Z",
        "currencyCode": "USD",
        "customerDomain": "string",
        "customerID": "01H0000000000000000000",
        "customerName": "Acme Corp",
        "disbursementAmountUsd": 100,
        "enterprisePeriod": "string",
        "enterpriseQuarter": "string",
        "entitlementID": "01H0000000000000000000"
      },
      "snowflakeRevenueRecordDetail": {
        "buyerID": "01H0000000000000000000",
        "consumerAccountLocator": "string",
        "consumerAccountName": "Acme Corp",
        "consumerBillingEmailAddress": "buyer@example.com",
        "consumerCompanyName": "Acme Corp",
        "consumerOrganizationName": "Acme Corp",
        "currency": "USD",
        "disbursements": [
          {}
        ],
        "entitlementID": "01H0000000000000000000",
        "expectedPayoutAmount": 100,
        "fees": 100,
        "invoiceDate": "2026-01-31T12:00:00Z"
      }
    }
  ],
  "total": 1
}

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.