Skip to main content

query products

GET 

/org/:orgId/product/query

Query products with advanced filtering, sorting, and pagination using CRUD query language. Supports complex filters, sorting by multiple fields, and pagination.

Request

Path Parameters

    orgId stringrequired

    Organization ID

Query Parameters

    page_size integer

    Number of items per page (default 100, max 200)

    page_number integer

    Page number (default 1)

    fields string

    Comma-separated fields to return (e.g., 'id,name,status'). Dot notation supported.

    q string

    LISP-style filter expression (e.g., '(= partner \

    s string

    Sort fields: 'field:asc,field2:desc' or '-field,field2' format

Body

    object

Responses

OK

Schema

    data

    object[]

  • Array [

  • createdBy string

    CreatedBy holds the value of the "created_by" field.

    creationTime date-time

    CreationTime holds the value of the "creation_time" field.

    externalID string

    ExternalID holds the value of the "external_id" field.

    fulfillmentUrl string

    FulfillmentURL holds the value of the "fulfillment_url" field.

    id string

    ID of the ent.

    info

    object

    Info holds the value of the "info" field.

    alibabaProduct

    object

    AuditFailMsg string
    AuditStatus string
    AuditTime integer
    Code string
    Description string
    FrontCategoryId integer
    GmtCreated integer
    GmtModified integer
    Name string
    PicUrl string

    ProductExtras

    object

    ProductExtra

    object[]

  • Array [

  • Key string
    Label string
    Order integer
    Type string
    Values
  • ]

  • ProductSkus

    object

    ProductSku

    object[]

  • Array [

  • ChargeType string

    POSTPAY or PREPAY

    Code string
    Constraints string
    Hidden boolean

    Modules

    object

    Module

    object[]

  • Array [

  • Code string
    Id string
    Name string

    Properties

    object

    Property

    object[]

  • Array [

  • DisplayUnit string
    Key string
    Name string

    PropertyValues

    object

    PropertyValue

    object[]

  • Array [

  • DisplayName string
    Max string
    Min string
    Remark string
    Step string
    Type string
    Value string
  • ]

  • showType string
  • ]

  • ]

  • Name string

    OrderPeriods

    object

    OrderPeriod

    object[]

  • Array [

  • Name string
    PeriodType string
  • ]

  • ]

  • RequestId string
    Score number

    ShopInfo

    object

    Emails string
    Id integer
    Name string

    Telephones

    object

    Telephone string[]

    WangWangs

    object

    WangWang

    object[]

  • Array [

  • Remark string
    UserName string
  • ]

  • ShortDescription string
    Status string
    SupplierPk integer
    Type string
    UseCount integer

    attributes

    object

    property name* string

    awsAmiProduct

    object

    Description

    object

    AssociatedProducts
    Categories string[]
    EuW8Submitted boolean
    Highlights string[]
    LongDescription string
    Manufacturer string
    ProductCode string
    ProductTitle string
    Registered boolean
    SearchKeywords string[]
    ShortDescription string
    Sku string
    UsW9Submitted boolean
    Visibility AwsMarketplaceProductVisibility (string)

    Possible values: [Limited, Public, Restricted, Unavailable, Draft]

    Dimensions

    object[]

  • Array [

  • Description string
    Key string
    Length integer

    The term length for the commit amount, such as 6 months, or 1 year. The length is used together with timeUnit. Length and TimeUnit are only used for commit dimension.

    Name string
    Rate number

    Below three fields are only used for pass data when create or update product's public offer pricing. Rate is only used for update public offer, becasue rate will be set as 0.01 when create new product.

    TimeUnit TimeUnit (string)

    Possible values: [DAY, WEEK, MONTH, YEAR]

    The term unit for the commit amount. Applicable to Direct only.

    Types string[]
    Unit string
  • ]

  • PromotionalResources

    object

    AdditionalResources

    object[]

  • Array [

  • Text string
    Type string
    Url string
  • ]

  • LogoUrl string

    Videos

    object[]

  • Array [

  • Title string
    Type string
    Url string
  • ]

  • Repositories

    object[]

  • Array [

  • Type string
    Url string
  • ]

  • SignatureVerificationKeys

    object[]

  • Array [

  • PublicKey string
    PublicKeyVersion integer
    Status string
  • ]

  • SupportInformation

    object

    Description string

    Versions

    object[]

  • Array [

  • CreationDate date-time

    DeliveryOptions

    object[]

  • Array [

  • AmiAlias string

    Exclusive Fields For AWS AMI Product

    ApiType string
    CompatibleServices string[]

    Endpoints

    object[]

  • Array [

  • AuthorizationTypes string[]
    EndpointUrl string

    IntegrationProtocols

    object[]

  • Array [

  • Type string
    UsageInstructions string
  • ]

  • Schemas

    object[]

  • Array [

  • SchemaUrl string
    Type string
  • ]

  • ]

  • FulfillmentUrl string

    Exclusive Fields For AWS SaaS Product

    Id string
    QuickLaunchEnabled boolean
    Recommendations
    ShortDescription string
    SourceId string
    Title string

    Exclusive Fields For AWS Container Product

    Type string
    UsageInstructions string

    Exclusive Fields For SaaS AI Product

    Visibility string
  • ]

  • Id string
    ReleaseNotes string
    VersionTitle string
  • ]

  • dataFeedProductId string

    The product Id in AWS Marketplace Data Feed Service.

    listingId string

    The listing ID in AWS Marketplace.

    productId string

    AWS Product ID

    awsContainerProduct

    object

    Description

    object

    AssociatedProducts
    Categories string[]
    EuW8Submitted boolean
    Highlights string[]
    LongDescription string
    Manufacturer string
    ProductCode string
    ProductTitle string
    Registered boolean
    SearchKeywords string[]
    ShortDescription string
    Sku string
    UsW9Submitted boolean
    Visibility AwsMarketplaceProductVisibility (string)

    Possible values: [Limited, Public, Restricted, Unavailable, Draft]

    Dimensions

    object[]

  • Array [

  • Description string
    Key string
    Length integer

    The term length for the commit amount, such as 6 months, or 1 year. The length is used together with timeUnit. Length and TimeUnit are only used for commit dimension.

    Name string
    Rate number

    Below three fields are only used for pass data when create or update product's public offer pricing. Rate is only used for update public offer, becasue rate will be set as 0.01 when create new product.

    TimeUnit TimeUnit (string)

    Possible values: [DAY, WEEK, MONTH, YEAR]

    The term unit for the commit amount. Applicable to Direct only.

    Types string[]
    Unit string
  • ]

  • PromotionalResources

    object

    AdditionalResources

    object[]

  • Array [

  • Text string
    Type string
    Url string
  • ]

  • LogoUrl string

    Videos

    object[]

  • Array [

  • Title string
    Type string
    Url string
  • ]

  • Repositories

    object[]

  • Array [

  • Type string
    Url string
  • ]

  • SignatureVerificationKeys

    object[]

  • Array [

  • PublicKey string
    PublicKeyVersion integer
    Status string
  • ]

  • SupportInformation

    object

    Description string

    Versions

    object[]

  • Array [

  • CreationDate date-time

    DeliveryOptions

    object[]

  • Array [

  • AmiAlias string

    Exclusive Fields For AWS AMI Product

    ApiType string
    CompatibleServices string[]

    Endpoints

    object[]

  • Array [

  • AuthorizationTypes string[]
    EndpointUrl string

    IntegrationProtocols

    object[]

  • Array [

  • Type string
    UsageInstructions string
  • ]

  • Schemas

    object[]

  • Array [

  • SchemaUrl string
    Type string
  • ]

  • ]

  • FulfillmentUrl string

    Exclusive Fields For AWS SaaS Product

    Id string
    QuickLaunchEnabled boolean
    Recommendations
    ShortDescription string
    SourceId string
    Title string

    Exclusive Fields For AWS Container Product

    Type string
    UsageInstructions string

    Exclusive Fields For SaaS AI Product

    Visibility string
  • ]

  • Id string
    ReleaseNotes string
    VersionTitle string
  • ]

  • dataFeedProductId string

    The product Id in AWS Marketplace Data Feed Service.

    listingId string

    The listing ID in AWS Marketplace.

    productId string

    AWS Product ID

    awsMachineLearningProduct

    object

    Description

    object

    AssociatedProducts
    Categories string[]
    EuW8Submitted boolean
    Highlights string[]
    LongDescription string
    Manufacturer string
    ProductCode string
    ProductTitle string
    Registered boolean
    SearchKeywords string[]
    ShortDescription string
    Sku string
    UsW9Submitted boolean
    Visibility AwsMarketplaceProductVisibility (string)

    Possible values: [Limited, Public, Restricted, Unavailable, Draft]

    Dimensions

    object[]

  • Array [

  • Description string
    Key string
    Length integer

    The term length for the commit amount, such as 6 months, or 1 year. The length is used together with timeUnit. Length and TimeUnit are only used for commit dimension.

    Name string
    Rate number

    Below three fields are only used for pass data when create or update product's public offer pricing. Rate is only used for update public offer, becasue rate will be set as 0.01 when create new product.

    TimeUnit TimeUnit (string)

    Possible values: [DAY, WEEK, MONTH, YEAR]

    The term unit for the commit amount. Applicable to Direct only.

    Types string[]
    Unit string
  • ]

  • PromotionalResources

    object

    AdditionalResources

    object[]

  • Array [

  • Text string
    Type string
    Url string
  • ]

  • LogoUrl string

    Videos

    object[]

  • Array [

  • Title string
    Type string
    Url string
  • ]

  • Repositories

    object[]

  • Array [

  • Type string
    Url string
  • ]

  • SignatureVerificationKeys

    object[]

  • Array [

  • PublicKey string
    PublicKeyVersion integer
    Status string
  • ]

  • SupportInformation

    object

    Description string

    Versions

    object[]

  • Array [

  • CreationDate date-time

    DeliveryOptions

    object[]

  • Array [

  • AmiAlias string

    Exclusive Fields For AWS AMI Product

    ApiType string
    CompatibleServices string[]

    Endpoints

    object[]

  • Array [

  • AuthorizationTypes string[]
    EndpointUrl string

    IntegrationProtocols

    object[]

  • Array [

  • Type string
    UsageInstructions string
  • ]

  • Schemas

    object[]

  • Array [

  • SchemaUrl string
    Type string
  • ]

  • ]

  • FulfillmentUrl string

    Exclusive Fields For AWS SaaS Product

    Id string
    QuickLaunchEnabled boolean
    Recommendations
    ShortDescription string
    SourceId string
    Title string

    Exclusive Fields For AWS Container Product

    Type string
    UsageInstructions string

    Exclusive Fields For SaaS AI Product

    Visibility string
  • ]

  • Id string
    ReleaseNotes string
    VersionTitle string
  • ]

  • dataFeedProductId string

    The product Id in AWS Marketplace Data Feed Service.

    listingId string

    The listing ID in AWS Marketplace.

    productId string

    AWS Product ID

    awsProfessionalServicesProduct

    object

    Description

    object

    AssociatedProducts
    Categories string[]
    EuW8Submitted boolean
    Highlights string[]
    LongDescription string
    Manufacturer string
    ProductCode string
    ProductTitle string
    Registered boolean
    SearchKeywords string[]
    ShortDescription string
    Sku string
    UsW9Submitted boolean
    Visibility AwsMarketplaceProductVisibility (string)

    Possible values: [Limited, Public, Restricted, Unavailable, Draft]

    Dimensions

    object[]

  • Array [

  • Description string
    Key string
    Length integer

    The term length for the commit amount, such as 6 months, or 1 year. The length is used together with timeUnit. Length and TimeUnit are only used for commit dimension.

    Name string
    Rate number

    Below three fields are only used for pass data when create or update product's public offer pricing. Rate is only used for update public offer, becasue rate will be set as 0.01 when create new product.

    TimeUnit TimeUnit (string)

    Possible values: [DAY, WEEK, MONTH, YEAR]

    The term unit for the commit amount. Applicable to Direct only.

    Types string[]
    Unit string
  • ]

  • PromotionalResources

    object

    AdditionalResources

    object[]

  • Array [

  • Text string
    Type string
    Url string
  • ]

  • LogoUrl string

    Videos

    object[]

  • Array [

  • Title string
    Type string
    Url string
  • ]

  • Repositories

    object[]

  • Array [

  • Type string
    Url string
  • ]

  • SignatureVerificationKeys

    object[]

  • Array [

  • PublicKey string
    PublicKeyVersion integer
    Status string
  • ]

  • SupportInformation

    object

    Description string

    Versions

    object[]

  • Array [

  • CreationDate date-time

    DeliveryOptions

    object[]

  • Array [

  • AmiAlias string

    Exclusive Fields For AWS AMI Product

    ApiType string
    CompatibleServices string[]

    Endpoints

    object[]

  • Array [

  • AuthorizationTypes string[]
    EndpointUrl string

    IntegrationProtocols

    object[]

  • Array [

  • Type string
    UsageInstructions string
  • ]

  • Schemas

    object[]

  • Array [

  • SchemaUrl string
    Type string
  • ]

  • ]

  • FulfillmentUrl string

    Exclusive Fields For AWS SaaS Product

    Id string
    QuickLaunchEnabled boolean
    Recommendations
    ShortDescription string
    SourceId string
    Title string

    Exclusive Fields For AWS Container Product

    Type string
    UsageInstructions string

    Exclusive Fields For SaaS AI Product

    Visibility string
  • ]

  • Id string
    ReleaseNotes string
    VersionTitle string
  • ]

  • dataFeedProductId string

    The product Id in AWS Marketplace Data Feed Service.

    listingId string

    The listing ID in AWS Marketplace.

    productId string

    AWS Product ID

    awsPurchaseConstraints

    object

    Defines constraints on how the term can be configured by acceptors. Applicable only to ConfigurableUpfrontPricingTerm.

    MultipleDimensionSelection AwsMarketplaceCatalogConstraintsEnum (string)

    Possible values: [Allowed, Disallowed]

    Determines if acceptors are allowed to configure quantity for each dimension in rate card. Possible values are "Allowed" and "Disallowed". Default value is "Allowed".

    QuantityConfiguration AwsMarketplaceCatalogConstraintsEnum (string)

    Possible values: [Allowed, Disallowed]

    Determines if acceptors are allowed to configure quantity for each dimension in rate card. Possible values are "Allowed" and "Disallowed". Default value is "Allowed".

    awsSaasProduct

    object

    Description

    object

    AssociatedProducts
    Categories string[]
    EuW8Submitted boolean
    Highlights string[]
    LongDescription string
    Manufacturer string
    ProductCode string
    ProductTitle string
    Registered boolean
    SearchKeywords string[]
    ShortDescription string
    Sku string
    UsW9Submitted boolean
    Visibility AwsMarketplaceProductVisibility (string)

    Possible values: [Limited, Public, Restricted, Unavailable, Draft]

    Dimensions

    object[]

  • Array [

  • Description string
    Key string
    Length integer

    The term length for the commit amount, such as 6 months, or 1 year. The length is used together with timeUnit. Length and TimeUnit are only used for commit dimension.

    Name string
    Rate number

    Below three fields are only used for pass data when create or update product's public offer pricing. Rate is only used for update public offer, becasue rate will be set as 0.01 when create new product.

    TimeUnit TimeUnit (string)

    Possible values: [DAY, WEEK, MONTH, YEAR]

    The term unit for the commit amount. Applicable to Direct only.

    Types string[]
    Unit string
  • ]

  • PromotionalResources

    object

    AdditionalResources

    object[]

  • Array [

  • Text string
    Type string
    Url string
  • ]

  • LogoUrl string

    Videos

    object[]

  • Array [

  • Title string
    Type string
    Url string
  • ]

  • Repositories

    object[]

  • Array [

  • Type string
    Url string
  • ]

  • SignatureVerificationKeys

    object[]

  • Array [

  • PublicKey string
    PublicKeyVersion integer
    Status string
  • ]

  • SupportInformation

    object

    Description string

    Versions

    object[]

  • Array [

  • CreationDate date-time

    DeliveryOptions

    object[]

  • Array [

  • AmiAlias string

    Exclusive Fields For AWS AMI Product

    ApiType string
    CompatibleServices string[]

    Endpoints

    object[]

  • Array [

  • AuthorizationTypes string[]
    EndpointUrl string

    IntegrationProtocols

    object[]

  • Array [

  • Type string
    UsageInstructions string
  • ]

  • Schemas

    object[]

  • Array [

  • SchemaUrl string
    Type string
  • ]

  • ]

  • FulfillmentUrl string

    Exclusive Fields For AWS SaaS Product

    Id string
    QuickLaunchEnabled boolean
    Recommendations
    ShortDescription string
    SourceId string
    Title string

    Exclusive Fields For AWS Container Product

    Type string
    UsageInstructions string

    Exclusive Fields For SaaS AI Product

    Visibility string
  • ]

  • Id string
    ReleaseNotes string
    VersionTitle string
  • ]

  • dataFeedProductId string

    The product Id in AWS Marketplace Data Feed Service.

    listingId string

    The listing ID in AWS Marketplace.

    productId string

    AWS Product ID

    awsSnsSubscriptions

    object[]

  • Array [

  • Endpoint string
    Protocol string
    Status AwsSnsSubscriptionStatus (string)

    Possible values: [UNKNOWN, CONFIRMED, PENDING_CONFIRMATION]

    SubscriptionArn string
    TopicArn string
  • ]

  • azureProduct

    object

    availabilities

    object[]

  • Array [

  • emailAudiences

    object[]

  • Array [

  • description string
    id string
  • ]

  • enterpriseLicensing string
    id string
    resourceType string

    subscriptionAudiences

    object[]

  • Array [

  • description string
    id string
  • ]

  • visibility string
  • ]

  • branches

    object[]

  • Array [

  • currentDraftInstanceID string
    friendlyName string
    id string
    module string
    resourceType string
    type string
    variantID string
  • ]

  • externalIDs

    object[]

  • Array [

  • type string
    value string
  • ]

  • id string
    isModularPublishing boolean

    listings

    object[]

  • Array [

  • accessInformation string

    assets

    object[]

    Not original fields. They are populated by other API calls

  • Array [

  • description string
    fileName string
    fileSasUri string
    friendlyName string
    id string
    order integer
    publisherDefinedSasUri string
    resourceType string

    Possible values: [ListingAsset, ListingImage, ListingVideo]

    state string

    Possible values: [PendingUpload, Uploaded, InProcessing, Processed, ProcessFailed]

    type string
  • ]

  • compatibleProducts string[]
    description string
    gettingStartedInstructions string
    id string
    keywords string[]
    languageCode string

    listingContacts

    object[]

  • Array [

  • email string
    name string
    phone string
    type string

    Possible values: [CustomerSupport, Engineering, ChannelManager]

    uri string
  • ]

  • listingUris

    object[]

  • Array [

  • displayText string
    subtype string
    type string
    uri string
  • ]

  • productDisplayName string
    publisherName string
    resourceType string

    Possible values: [AzureListing]

    shortDescription string
    summary string
    title string
  • ]

  • name string

    packageConfigurations

    object[]

  • Array [

  • azureActiveDirectoryApplicationID string
    azureActiveDirectoryTenantID string
    connectionWebhook string
    id string
    landingPageUri string
    resourceType string

    Possible values: [AzureSoftwareAsAServicePackageConfiguration]

  • ]

  • plans

    object[]

    All plans under this product

  • Array [

  • $schema string
    id string
    lifecycleState AzureMarketplaceResourceLifecycleState (string)

    Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]

    Default value is "generallyAvailable".

    offerPricingType AzureMarketplaceOfferPricingType (string)

    Possible values: [``, editExistingOfferPricingOnly, saasNewCustomizedPlans, vmSoftwareReservations, newCustomizedPlans]

    default "editExistingOfferPricingOnly"

    plan string
    planName string

    The azure plan friendly name, from the Azure Marketplace.

    pricing

    object

    customMeters

    object

    meters

    One of PriceAndAvailabilityCustomMeter_USD or PriceAndAvailabilityCustomMeter_PerMarket

    priceInputOption string

    Possible values: [perMarket, usd]

    default "usd"

    recurrentPrice

    object

    priceInputOption string

    Possible values: [perMarket, usd]

    default "usd"

    prices

    object[]

  • Array [

  • billingFrequency

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    billingTerm

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    contractDuration

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    flexibleSchedule

    object

    flexibleSchedule defines the payment installments for flexible billing.

    billingSchedule

    object[]

  • Array [

  • chargeDate string

    In format of YYYY-MM-DD.

    note string
    pricePerPaymentInUsd number

    For non-VM offers (SaaS, etc.)

    prices

    object[]

  • Array [

  • currency string

    ISO 4217 currency code

    markets string[]

    PriceAndAvailability audience definition

    price number

    default 0, for other pricing models

    prices

    object

    For perMarketAndCoreSize pricing model

    property name* any

    For perMarketAndCoreSize pricing model

  • ]

  • unitPricePerPaymentPeriodInUsd number

    For VM offers with flexible billing could be 0 for the amount

  • ]

  • initialCharge

    object

    note string
    pricePerPaymentInUsd number

    For non-VM offers (SaaS, etc.) could be 0 for the amount

    prices

    object[]

  • Array [

  • currency string

    ISO 4217 currency code

    markets string[]

    PriceAndAvailability audience definition

    price number

    default 0, for other pricing models

    prices

    object

    For perMarketAndCoreSize pricing model

    property name* any

    For perMarketAndCoreSize pricing model

  • ]

  • unitPricePerPaymentPeriodInUsd number

    For VM offers with flexible billing could be 0 for the amount

    price number

    paymentOption

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    pricePerPaymentInUsd number

    Using omitempty

    prices

    object[]

  • Array [

  • currency string

    ISO 4217 currency code

    markets string[]

    PriceAndAvailability audience definition

    price number

    default 0, for other pricing models

    prices

    object

    For perMarketAndCoreSize pricing model

    property name* any

    For perMarketAndCoreSize pricing model

  • ]

  • ]

  • recurrentPriceMode string

    Possible values: [flatRate, perUser]

    default "flatRate"

    userLimits

    object

    max number
    min number
    product string
    resourceName string

    softwareReservation

    object

    paymentSchedule

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    reservationDuration

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    vmPrices

    object

    property name*

    AzureMarketplaceVmPricePropertyItem

    flexibleSchedule

    object

    flexibleSchedule defines the payment installments for flexible billing.

    billingSchedule

    object[]

  • Array [

  • chargeDate string

    In format of YYYY-MM-DD.

    note string
    pricePerPaymentInUsd number

    For non-VM offers (SaaS, etc.)

    prices

    object[]

  • Array [

  • currency string

    ISO 4217 currency code

    markets string[]

    PriceAndAvailability audience definition

    price number

    default 0, for other pricing models

    prices

    object

    For perMarketAndCoreSize pricing model

    property name* any

    For perMarketAndCoreSize pricing model

  • ]

  • unitPricePerPaymentPeriodInUsd number

    For VM offers with flexible billing could be 0 for the amount

  • ]

  • initialCharge

    object

    note string
    pricePerPaymentInUsd number

    For non-VM offers (SaaS, etc.) could be 0 for the amount

    prices

    object[]

  • Array [

  • currency string

    ISO 4217 currency code

    markets string[]

    PriceAndAvailability audience definition

    price number

    default 0, for other pricing models

    prices

    object

    For perMarketAndCoreSize pricing model

    property name* any

    For perMarketAndCoreSize pricing model

  • ]

  • unitPricePerPaymentPeriodInUsd number

    For VM offers with flexible billing could be 0 for the amount

    price number
    quantity number
    unitPricePerPaymentPeriodInUsd number

    For VM offer, could be 0

    subType string

    The plan subType for AzureApplication-type products (e.g., "solution-template", "managed-application"). Preserved from the AzureProductVariant.SubType during product sync.

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • visibility string

    Possible values: [visible, hidden]

    default "visible"

  • ]

  • properties

    object[]

  • Array [

  • additionalCategories string[]
    appVersion string
    applicableProducts string[]
    categories string[]
    customAmendments string[]
    extendedProperties string[]
    globalAmendmentTerms string
    hideKeys string[]
    id string
    industries string[]

    leveledCategories

    object

    property name* any

    leveledIndustries

    object

    property name* any
    marketingOnlyChange boolean
    productTags string[]
    resourceType string
    submissionVersion string
    termsOfUse string
    useEnterpriseContract boolean
  • ]

  • resourceType string

    setup

    object

    Not original fields. They are populated by other API calls

    callToAction string

    Possible values: [free, free-trial, contact-me]

    channelStates

    object[]

  • Array [

  • type string
    value string
  • ]

  • enableTestDrive boolean
    resourceType string

    Possible values: [AzureProductSetup]

    sellingOption string

    Possible values: [ListingOnly, ListAndSell]

    testDriveType string
    trialUri string

    submissions

    object[]

  • Array [

  • areResourcesReady boolean
    friendlyName string
    id string

    pendingUpdateInfo

    object

    status string
    updateType string
    publishedTimeInUtc date-time
    releaseNumber integer
    resourceType string

    Possible values: [Submission]

    resources

    object[]

  • Array [

  • type string
    value string
  • ]

  • state string

    Possible values: [Inprogress, Published]

    subState string

    Possible values: [InDraft, Submitted, Failed, FailedInCertification, ReadyToPublish, Publishing, Published, InStore]

    targets

    object[]

  • Array [

  • type string
    value string
  • ]

  • variantResources

    object[]

  • Array [

  • resources

    object[]

  • Array [

  • type string
    value string
  • ]

  • variantID string
  • ]

  • ]

  • variants

    object[]

  • Array [

  • azureGovernmentCertifications

    object[]

  • Array [

  • title string
    uri string

    validationResults

    object[]

  • Array [

  • errorMessage string
    memberNames string[]
  • ]

  • ]

  • cloudAvailabilities string[]
    conversionPaths string

    extendedProperties

    object[]

  • Array [

  • type string
    value string
  • ]

  • externalID string

    featureAvailabilities

    object[]

    Not original fields. They are populated by other API calls

  • Array [

  • customMeters

    object[]

  • Array [

  • displayName string
    id string

    includedBaseQuantities

    object[]

  • Array [

  • isInfinite boolean
    quantity number
    recurringUnit string

    Possible values: [Monthly, Annual]

  • ]

  • isEnabled boolean
    priceInUsd number
    uniqueID string
    unitOfMeasure string
  • ]

  • id string
    isHidden boolean

    marketStates

    object[]

  • Array [

  • marketCode string

    ISO Country Code

    state string

    Possible values: [Disabled, Enabled, StopSelling, Terminated]

  • ]

  • markets

    object[]

  • Array [

  • friendlyName string
    marketCode string

    ISO Country Code

  • ]

  • priceSchedules

    object[]

  • Array [

  • dateTimeRange

    object

    endAt

    object

    dateTimeInUtc string
    localizePerMarket boolean

    startAt

    object

    dateTimeInUtc string
    localizePerMarket boolean
    friendlyName string
    isBaseSchedule boolean

    There is only one base schedule.

    marketCodes string[]

    ISO country code

    schedules

    object[]

  • Array [

  • priceCadence

    object

    type string

    Possible values: [Month, Year]

    value integer
    pricingModel string

    Possible values: [Flat, Recurring, Usage]

    pricingUnits

    object[]

  • Array [

  • isUnlimitedUnit boolean
    lowerUnit integer
    name string

    Possible values: [sharedcore, transactions]

    unitType string
    upperUnit integer
  • ]

  • retailPrice

    object

    currencyCode string

    ISO currency code, Three characters

    openPrice number
    priceTierID string
  • ]

  • ]

  • properties

    object[]

  • Array [

  • type string
    value string
  • ]

  • resourceType string

    ResourceType = FeatureAvailability

    subscriptionAudiences

    object[]

  • Array [

  • description string
    id string
  • ]

  • tenantAudiences

    object[]

  • Array [

  • description string
    id string
  • ]

  • trial

    object

    dateTimeRange

    object

    endAt

    object

    dateTimeInUtc string
    localizePerMarket boolean

    startAt

    object

    dateTimeInUtc string
    localizePerMarket boolean
    duration integer
    durationType string

    Possible values: [Minute, Days, Months]

    type string

    Possible values: [NoTrial, TimedAccess, TimedUsage, Unlimited]

    visibility string

    Possible values: [Public, Private]

  • ]

  • friendlyName string
    id string
    leadGenID string
    referenceVariantID string
    resourceType string

    Possible values: [AzureSkuVariant, AzureTestDriveVariant]

    state string

    Possible values: [InActive, Active]

    subType AzureProductVariantSubType (string)

    Possible values: [solution-template, managed-application]

  • ]

  • azureProductResource

    object

    customerLeads

    object

    $schema string
    blobLeadConfiguration
    dynamicsLeadConfiguration
    emailLeadConfiguration
    httpsEndpointLeadConfiguration
    id string
    leadDestination string

    Possible values: [none, blob, dynamics, email, httpsEndpoint, marketo, salesforce, table]

    marketoLeadConfiguration
    product string
    resourceName string
    salesforceLeadConfiguration
    tableLeadConfiguration

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • listing

    object

    $schema string

    cloudSolutionProviderContact

    object

    email string
    name string
    phone string
    url string

    in patern of "^(http|https)://"

    cloudSolutionProviderMarketingMaterials string
    description string

    engineeringContact

    object

    email string
    name string
    phone string
    url string

    in patern of "^(http|https)://"

    generalLinks

    object[]

  • Array [

  • displayText string
    link string

    in patern of "^(http|https)://"

  • ]

  • gettingStartedInstructions string
    gloabalSupportWebsite string
    governmentSupportWebsite string
    id string
    kind string

    Possible values: [azureSaaS, azureVM, xbox360NonBackCompat]

    languageId string
    lifecycleState AzureMarketplaceResourceLifecycleState (string)

    Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]

    Default value is "generallyAvailable".

    privacyPolicyLink string
    product string

    Product resource name, in format of "product/product-durable-id"

    resourceName string
    searchKeywords string[]
    searchResultSummary string
    shortDescription string

    supportContact

    object

    email string
    name string
    phone string
    url string

    in patern of "^(http|https)://"

    title string

    Max string length is 200.

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • listingAssets

    object[]

  • Array [

  • $schema string
    description string
    displayOrder integer

    minimum: 0

    fileName string
    friendlyName string
    id string
    kind string

    Possible values: [azure]

    languageId string

    Max string length is 10.

    lifecycleState AzureMarketplaceResourceLifecycleState (string)

    Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]

    Default value is "generallyAvailable".

    listing string
    product string

    Product resource name, in format of "product/product-durable-id"

    resourceName string
    type AzureMarketplaceListingAssetType (string)

    Possible values: [azureLogoSmall, azureLogoMedium, azureLogoLarge, azureLogoWide, azureLogoScreenshot, azureLogoHero, pdfDocument]

    url string

    pattern: "^https?://"

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • ]

  • plans

    object[]

  • Array [

  • plan

    object

    $schema string
    alias string

    azureGovernmentCertifications

    object[]

  • Array [

  • link string

    in patern of "^(http|https)://"

    name string
  • ]

  • azureRegions string[]

    enums:[azureGlobal,azureGovernment,azureGermany,azureChina]

    deprecationSchedule

    object

    $schema string

    alternative

    object

    plan
    product
    date string

    format: date-time

    dateOffset string

    format: duration

    reason string

    Possible values: [criticalSecurityIssue, endOfSupport, other]

    displayRank integer

    default 2147483647

    id string

    in format of "plan/product-durable-id/plan-durable-id"

    identity

    object

    externalId string
    lifecycleState AzureMarketplaceResourceLifecycleState (string)

    Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]

    Default value is "generallyAvailable".

    product string

    in format of "product/product-durable-id"

    resourceName string
    subtype string

    Possible values: [managedApplication, solutionTemplate]

    Specifies the plan type (AzureApplication-type products only) see: https://go.microsoft.com/fwlink/?linkid=2106322

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • planListing

    object

    $schema string
    description string
    id string
    kind string

    Possible values: [azureVM-plan, azureSaaS-plan, azureCoreVM-plan, azureContainer-plan]

    languageId string
    lifecycleState AzureMarketplaceResourceLifecycleState (string)

    Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]

    Default value is "generallyAvailable".

    name string
    plan string
    product string
    resourceName string
    summary string

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • priceAndAvailabilityPlan

    object

    $schema string
    audience string

    Possible values: [public, private]

    billingTag string
    id string
    markets string[]
    meterDefine string
    plan string

    pricing

    object

    corePricing

    object

    price number
    priceInputOption string

    Possible values: [free, flat, perCore, perCoreSize, perMarketAndCoreSize]

    pricePerCore number
    pricePerCoreSize

    prices

    object[]

  • Array [

  • currency string

    ISO 4217 currency code

    markets string[]

    PriceAndAvailability audience definition

    price number

    default 0, for other pricing models

    prices

    object

    For perMarketAndCoreSize pricing model

    property name* any

    For perMarketAndCoreSize pricing model

  • ]

  • customMeters

    object

    meters

    object

    property name*

    AzureMarketplacePriceAndAvailabilityCustomMeterPriceMeterItem

    billingTerm

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    includedQuantities

    object[]

  • Array [

  • billingTerm

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    contractDuration

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    isInfinite boolean
    quantity number
  • ]

  • paymentOption

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    pricePerPaymentInUsd number

    prices

    object[]

  • Array [

  • currency string

    ISO 4217 currency code

    markets string[]

    PriceAndAvailability audience definition

    price number

    default 0, for other pricing models

    prices

    object

    For perMarketAndCoreSize pricing model

    property name* any

    For perMarketAndCoreSize pricing model

  • ]

  • priceInputOption string

    Possible values: [perMarket, usd]

    default "usd"

    licenseModel string

    Possible values: [byol, payAsYouGo]

    recurrentPrice

    object

    priceInputOption string

    Possible values: [perMarket, usd]

    default "usd"

    prices

    object[]

  • Array [

  • billingFrequency

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    billingTerm

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    contractDuration

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    flexibleSchedule

    object

    flexibleSchedule defines the payment installments for flexible billing.

    billingSchedule

    object[]

  • Array [

  • chargeDate string

    In format of YYYY-MM-DD.

    note string
    pricePerPaymentInUsd number

    For non-VM offers (SaaS, etc.)

    prices

    object[]

  • Array [

  • currency string

    ISO 4217 currency code

    markets string[]

    PriceAndAvailability audience definition

    price number

    default 0, for other pricing models

    prices

    object

    For perMarketAndCoreSize pricing model

    property name* any

    For perMarketAndCoreSize pricing model

  • ]

  • unitPricePerPaymentPeriodInUsd number

    For VM offers with flexible billing could be 0 for the amount

  • ]

  • initialCharge

    object

    note string
    pricePerPaymentInUsd number

    For non-VM offers (SaaS, etc.) could be 0 for the amount

    prices

    object[]

  • Array [

  • currency string

    ISO 4217 currency code

    markets string[]

    PriceAndAvailability audience definition

    price number

    default 0, for other pricing models

    prices

    object

    For perMarketAndCoreSize pricing model

    property name* any

    For perMarketAndCoreSize pricing model

  • ]

  • unitPricePerPaymentPeriodInUsd number

    For VM offers with flexible billing could be 0 for the amount

    price number

    paymentOption

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    pricePerPaymentInUsd number

    Using omitempty

    prices

    object[]

  • Array [

  • currency string

    ISO 4217 currency code

    markets string[]

    PriceAndAvailability audience definition

    price number

    default 0, for other pricing models

    prices

    object

    For perMarketAndCoreSize pricing model

    property name* any

    For perMarketAndCoreSize pricing model

  • ]

  • ]

  • recurrentPriceMode string

    Possible values: [flatRate, perUser]

    default "flatRate"

    userLimits

    object

    max number
    min number

    systemMeterPricing

    object

    price number

    default 0

    priceInputOption string

    Possible values: [perCore, perEveryCoreInCluster, perNode, perEveryNodeInCluster, perPod, perCluster]

    prices

    object[]

  • Array [

  • currency string

    ISO 4217 currency code

    markets string[]

    PriceAndAvailability audience definition

    price number

    default 0, for other pricing models

    prices

    object

    For perMarketAndCoreSize pricing model

    property name* any

    For perMarketAndCoreSize pricing model

  • ]

  • privateAudiences

    object[]

  • Array [

  • id string
    label string
    type string

    Possible values: [none, subscription, ea, msdn, tenant, email]

  • ]

  • product string
    resourceName string

    softwareReservation

    object[]

  • Array [

  • percentageSave number

    default 0

    term number

    default 0

    type string

    Possible values: [month, year]

  • ]

  • trial

    object

    billingFrequency defines the frequency of the billing for recurring price.

    type string

    Possible values: [day, week, month, year]

    value number

    default 0

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • visibility string

    Possible values: [visible, hidden]

  • ]

  • priceAndAvailabilityCustomMeter

    object

    $schema string

    customMeters

    object

    property name*

    AzureMarketplacePriceAndAvailabilityCustomMeterItem

    displayName string
    price number

    Suger's custom field, for Suger internal use only. Not from Microsoft official schema.

    unitOfMeasure string
    id string
    product string
    resourceName string

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • priceAndAvailabilityOffer

    object

    $schema string
    id string

    previewAudiences

    object[]

  • Array [

  • id string
    label string
    type string

    Possible values: [none, subscription, ea, msdn, tenant, email]

  • ]

  • product string
    resourceName string

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • product

    object

    $schema string
    alias string

    The Product Display Name

    id string

    in format of "product/product-durable-id"

    identity

    object

    externalId string
    lifecycleState AzureMarketplaceResourceLifecycleState (string)

    Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]

    Default value is "generallyAvailable".

    productGroup string
    resourceName string
    type AzureMarketplaceProductType (string)

    Possible values: [azureApplication, azureContainer, azureVirtualMachine, consultingService, containerApp, coreVirtualMachine, cosellOnly, dynamics365BusinessCentral, dynamics365ForCustomerEngagement, dynamics365ForOperations, iotEdgeModule, managedService, powerBiApp, powerBiVisual, softwareAsAService, xbox360NonBackcompat]

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • property

    object

    $schema string
    appVersion string

    categories

    object

    property name*

    string[]

  • Array [

  • string

  • ]

  • cloudIndustries

    object

    property name*

    string[]

  • Array [

  • string

  • ]

  • customAmendments

    object[]

  • Array [

  • tenants

    object

    manualEntries

    object[]

  • Array [

  • description string
    id string
  • ]

  • terms string
  • ]

  • id string

    industries

    object

    property name*

    string[]

  • Array [

  • string

  • ]

  • kind string

    Possible values: [azureSaaS, azureVM]

    lifecycleState AzureMarketplaceResourceLifecycleState (string)

    Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]

    Default value is "generallyAvailable".

    product string
    resourceName string
    standardContractAmendment string
    termsConditions string

    Possible values: [custom, standardMicrosoft]

    termsOfUse string
    termsOfUseUrl string

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • reseller

    object

    $schema string

    audiences

    object[]

  • Array [

  • description string
    resourceId string
    type string

    Possible values: [subscription]

  • ]

  • id string
    product string
    resellerChannelState string
    resourceName string

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • setup

    object

    $schema string
    accessUrl string

    in patern of "^(http|https)://"

    callToAction string

    Possible values: [free, freeTrial, contactMe]

    id string

    In format of "commercial-marketplace-setup/setup-durable-id"

    product string

    Product resource name, in format of "product/product-durable-id"

    requireLicenseForInstall boolean
    resourceName string
    sellThroughMicrosoft boolean
    useMicrosoftLicenseManagementService boolean

    If true, only per_user pricing model is allowed.

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • submission

    object

    $schema string
    created string

    Date-time string

    deprecationSchedule

    object

    $schema string

    alternative

    object

    plan
    product
    date string

    format: date-time

    dateOffset string

    format: duration

    reason string

    Possible values: [criticalSecurityIssue, endOfSupport, other]

    id string
    lifecycleState AzureMarketplaceResourceLifecycleState (string)

    Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]

    Default value is "generallyAvailable".

    product string
    resourceName string
    result string

    Possible values: [succeeded, failed, pending]

    status string

    Possible values: [notStarted, running, completed]

    target

    object

    targetId string
    targetType string

    Possible values: [flight, sandbox, draft, preview, live, certification, retail]

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • technicalConfiguration

    object

    $schema string
    azureAdAppId string

    Azure AD Application Id

    azureAdTenantId string

    Azure AD Tenant Id

    connectionWebhook string
    id string
    landingPageUrl string
    product string

    in format of "product/product-durable-id"

    resourceName string

    validations

    object[]

  • Array [

  • $schema string
    code string

    Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]

    level string

    Possible values: [informational, warning]

    message string
    resourceId string
  • ]

  • commits

    object[]

  • Array [

  • category string
    description string
    isUserCreated boolean

    Whether this commit dimension is newly created by user, when creating AWS Marketplace Contract private offer.

    key string

    API name of the dimension

    length integer

    The term length for the commit amount, such as 6 months, or 1 year. The length is used together with timeUnit. If the length is zero, use the TermEndTime.

    maximumUsers integer

    Possible values: >= 1 and <= 1000000

    Default value: 1000000

    The maximum number of users for PER_USER commit

    minimumUsers integer

    Possible values: >= 1 and <= 1000000

    Default value: 1

    The minimum number of users for PER_USER commit

    name string

    Display name of the dimension

    quantity integer

    The quantity of this commit.

    rate number

    The commit amount. For GCP, it is monthly commitment.

    term string

    The term of the commit amount. It is used for front-end display only.

    termEndTime date-time

    The end time of the commit term.

    timeUnit TimeUnit (string)

    Possible values: [DAY, WEEK, MONTH, YEAR]

    The term unit for the commit amount. Applicable to Direct only.

    type CommitDimensionType (string)

    Possible values: [FLAT_RATE, PER_USER]

    The type of the commit dimension. Applicable only to Azure Marketplace.

    types string[]

    These indicate whether the dimension covers metering, entitlement, or support for external metering

  • ]

  • companyID string
    currency string

    dimensions

    object[]

  • Array [

  • category string
    description string

    includedBaseQuantities

    object[]

    how many quantities of this dimension are included in the commit.

  • Array [

  • isInfinite boolean
    quantity number
    recurringUnit string

    Possible values: [Monthly, Annual]

  • ]

  • key string
    name string

    Display name of the dimension. For GCP Marketplace, it is the metering metric ID without plan prefix.

    planId string

    The plan ID of the metering dimension. Applicable to GCP Marketplace only. No ISO duration suffix.

    planName string

    The name of the plan for the metering dimension. Applicable to GCP Marketplace only. It may contains the ISO duration suffix, such as P1Y.

    priceTiers

    object[]

    The price tiers of the metering dimension. Applicable to GCP Marketplace only.

  • Array [

  • fromAmount number

    such as 0

    price

    object

    The one time credit in amount of money

    currencyCode string

    such as "USD"

    nanos integer

    for the decimal part, such as 30000000 = $0.03

    units string

    for the integer part, such as "500000" = $50K

    startingUsageAmount string

    such as "0"

  • ]

  • rate number

    The unit price of this usage metering dimension.

    skuId string

    The SKU ID of the metering dimension. Applicable to GCP Marketplace only.

    types string[]

    usageCount

    object

    The current Dimension Usage Count. Available when call GetEntitlement API.

    creditCount number

    The count of this dimension usage records that are handled as credit.

    includedCount number

    The count of this dimension usage records that are handled as included in IncludedBaseQuantity

    reportedCount number

    The count of this dimension usage records that are reported to cloud vendors.

    valueType ValueType (string)

    Possible values: [``, VALUE_TYPE_UNSPECIFIED, BOOL, INT64, DOUBLE, STRING, DISTRIBUTION, MONEY]

    The value type of the metering dimension quantity. Applicable to GCP Marketplace only.

  • ]

  • eulaType EulaType (string)

    Possible values: [``, SCMP, ECMP, RCMP, CUSTOM, ISV, CURRENT]

    Attach the standard EULA file to the CUSTOM EULA file. Only applicable when EulaType = CUSTOM

    eulaUrl string

    The public offer's EULA URL.

    gcpProduct

    object

    createTime date-time

    derivedDiscoveryState

    object

    accessState GcpMarketplaceProductAccessState (string)

    Possible values: [ALLUSERS_ACCESSIBLE, NOT_ALLUSERS_ACCESSIBLE, NOT_PUBLISHED]

    searchState string

    Possible values: [ADMIN_OVERRIDE_UNSEARCHABLE, SEARCHABLE]

    id string

    Nullable, GCP Marketplace Product UUID

    lastPublishTime date-time

    listingSpec

    object

    externalAccountSpec

    object

    loginUri string
    signupUri string
    singleSignOnUri string
    listingType string

    Possible values: [BillingIntegratedManagedService]

    marketingSpec

    object

    description string
    displayNames string[]

    documentationSpecs

    object[]

  • Array [

  • description string
    title string
    uri string
  • ]

  • eulaUrl string

    externalLicenseSpecs

    object[]

  • Array [

  • description string
    uri string
  • ]

  • externalMarketingUrl string
    icon string

    in format of "base64://..."

    searchCategories string[]
    searchDescription string
    searchKeywords string[]
    signupUri string

    supportSpec

    object

    description string
    email string
    uri string
    tagLine string
    title string

    purchaseSpec

    object

    features

    object[]

  • Array [

  • description string
    name string
    title string
  • ]

  • metrics

    object[]

    GCP Marketplace Product Usage Metering Dimension/Metric

  • Array [

  • description string

    Description: A detailed description of the metric, which can be used in documentation.

    displayName string
    displayUnit string

    such as "min"

    displayUnitDescription string

    such as "minute"

    id string

    The usage metering metric/dimension key It is in format of "{plan_id}_{usage_dimension_key}". For example, "basic_plan_storage".

    metricKind string

    such as "DELTA"

    name string

    Name: The resource name of the metric descriptor, in format of "{productServiceName}/{plan_id}_{usage_dimension_key}"

    priceTiers

    object[]

    Price info of this usage metering metric. Only applicable for the default offer (plan) and private offer.

  • Array [

  • fromAmount number

    such as 0

    price

    object

    The one time credit in amount of money

    currencyCode string

    such as "USD"

    nanos integer

    for the decimal part, such as 30000000 = $0.03

    units string

    for the integer part, such as "500000" = $50K

    startingUsageAmount string

    such as "0"

  • ]

  • reportingUnit string

    such as "min"

    skuId string

    The SKU ID of this usage metering metric. Applicable only in Private Offer.

    unit string

    such as "min"

    valueType ValueType (string)

    Possible values: [``, VALUE_TYPE_UNSPECIFIED, BOOL, INT64, DOUBLE, STRING, DISTRIBUTION, MONEY]

    The value type of the metering dimension quantity. Applicable to GCP Marketplace only.

  • ]

  • purchaseOptionSpecs

    object[]

    GCP Marketplace Product Pricing Plans

  • Array [

  • featureValues

    object[]

  • Array [

  • featureDescription string

    such as "CPU per VM"

    featureName string

    such as "cpu"

    featureTitle string

    such as "CPU"

    featureValue string

    such as "2 CPU per VM"

  • ]

  • name string

    The plan ID, such as "starter", without the duration suffix, such as "P1Y".

    priceInfo

    object

    description string
    priceModel GcpMarketplacePriceModel (string)

    Possible values: [FREE, SUBSCRIPTION, USAGE, SUBSCRIPTION_PLUS_USAGE]

    subscriptionPlans

    object[]

    Subscription Plan (Flat Commitment)

  • Array [

  • period string

    such as "ONE_YEAR", "TWO_YEAR", "THREE_YEAR"

    price

    object

    The one time credit in amount of money

    currencyCode string

    such as "USD"

    nanos integer

    for the decimal part, such as 30000000 = $0.03

    units string

    for the integer part, such as "500000" = $50K

  • ]

  • usageFees

    object[]

    Usage Metering Dimension/Metric if available

  • Array [

  • displayQuantity integer

    such as 1

    metricId string

    such as "Starter_storage"

    priceTiers

    object[]

  • Array [

  • fromAmount number

    such as 0

    price

    object

    The one time credit in amount of money

    currencyCode string

    such as "USD"

    nanos integer

    for the decimal part, such as 30000000 = $0.03

    units string

    for the integer part, such as "500000" = $50K

    startingUsageAmount string

    such as "0"

  • ]

  • ]

  • purchaseMode string

    Possible values: [PURCHASE_MODE_PRIVATE, PURCHASE_MODE_PUBLIC]

    title string

    such as "Starter"

  • ]

  • termsSpec

    object

    eulaUri string
    inlineEula

    TODO: need to define the type

    standardEula

    TODO: need to define the type

    marketplace string

    Possible values: [marketplaces/google-cloud]

    name string

    In format of "projects/{project-number}/listings/{product-name}.endpoints.{provider-id}.cloud.goog"

    revisionCreateTime date-time
    revisionId string
    service string

    In format of "services/{product-name}.endpoints.{provider-id}.cloud.goog"

    serviceConfig

    object

    billing

    object

    metrics string[]

    The list of metrics that are available for billing for the product. In format of "product-name.endpoints.gcp-project-id.cloud.goog/plan_name_metric_name"

    metrics

    object[]

  • Array [

  • description string

    Description: A detailed description of the metric, which can be used in documentation.

    displayName string
    displayUnit string

    such as "min"

    displayUnitDescription string

    such as "minute"

    id string

    The usage metering metric/dimension key It is in format of "{plan_id}_{usage_dimension_key}". For example, "basic_plan_storage".

    metricKind string

    such as "DELTA"

    name string

    Name: The resource name of the metric descriptor, in format of "{productServiceName}/{plan_id}_{usage_dimension_key}"

    priceTiers

    object[]

    Price info of this usage metering metric. Only applicable for the default offer (plan) and private offer.

  • Array [

  • fromAmount number

    such as 0

    price

    object

    The one time credit in amount of money

    currencyCode string

    such as "USD"

    nanos integer

    for the decimal part, such as 30000000 = $0.03

    units string

    for the integer part, such as "500000" = $50K

    startingUsageAmount string

    such as "0"

  • ]

  • reportingUnit string

    such as "min"

    skuId string

    The SKU ID of this usage metering metric. Applicable only in Private Offer.

    unit string

    such as "min"

    valueType ValueType (string)

    Possible values: [``, VALUE_TYPE_UNSPECIFIED, BOOL, INT64, DOUBLE, STRING, DISTRIBUTION, MONEY]

    The value type of the metering dimension quantity. Applicable to GCP Marketplace only.

  • ]

  • name string

    in format of "product-name.endpoints.gcp-project-id.cloud.goog"

    producerProjectId string

    The GCP project ID of the producer.

    title string

    The title of the product listing.

    validationSummary

    TODO: add type

    refundCancellationPolicy string
    sellerNotes string

    snowflakeProduct

    object

    additionalRegions string
    applicationPackageName string
    attachedShare string
    autofulfillment boolean
    comment string
    createdOn date-time
    customizedContactInfo string

    defaultPricingPlan

    object

    allow_early_access boolean

    If true, consumers can access the listing before making a payment. You'll need to remind them to pay.

    base_fee number
    billing_duration integer
    currency string
    free_unit_kind string
    free_units number

    installment_schedule

    object

    The installment schedule for the offer.

    default_installment_amount number
    installment_duration number

    overridden_installments

    object[]

  • Array [

  • installment_amount number
    installment_number number
  • ]

  • is_auto_renewable boolean

    IsAutoRenewable is true if the product is auto renewable.

    max_fee number
    payment_type string
    trial_usage_limit number
    trial_usage_unit string
    type string
    usage_unit_kind string
    usage_unit_price number

    detailedTargetAccounts

    object[]

  • Array [

  • account_identifier string
    company_name string
  • ]

  • distribution string
    evaluationPlan string
    firstPublishedOn date-time
    flags string
    fulfillmentType string
    globalName string
    isMountlessQueryable boolean
    lastApprovedOn date-time
    lastPublishedOn date-time
    lastSubmittedOn date-time
    listingType string

    metadata

    object

    areTermsProvidedOffline boolean
    businessNeeds
    description string
    hasFreeSampleData boolean
    isWithStandardTerms boolean
    paidAttributes
    share string
    title string
    usage
    monetizationVersion string
    name string

    pricingPlans

    object[]

  • Array [

  • base_fee number
    billing_duration_months string
    comment string
    contract_duration_months string
    contract_type string

    PAY_AS_YOU_GO, LIMITED_TIME

    currency string
    display_name string

    metadata

    object

    For pricing display purpose. eg: {"price":"10","button_text":"starter plan"}

    property name* string
    name string
    pricing_model string

    pricing model: USAGE_BASED, FLAT_FEE

    sales_motion string

    SELF_SERVE, PROACTIVE

    state string

    state of pricing plan

    updated_on date-time

    usage_details

    object

    free_unit_kind string
    free_units number
    max_fee number
    usage_unit_kind string
    usage_unit_price number
    visibility string
  • ]

  • private boolean

    productTypes

    object[]

  • Array [

  • is_addon boolean
    type string
  • ]

  • profileName string
    publishOnApproval boolean
    regions string
    rejectedOn date-time
    rejectedReason string
    replicationSchedule string
    retiredOn date-time
    scheduledDropTime date-time
    shareType string
    state string
    targetAccounts string

    trialDetails

    object

    description string
    trial_time_limit number
    trial_type string
    unpublishedByAdminReason string
    updatedOn date-time

    stripeProduct

    object

    active boolean

    Whether the product is currently available for purchase.

    created integer

    Time at which the object was created. Measured in seconds since the Unix epoch.

    description string

    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

    id string

    Unique identifier for the product in Stripe.

    images string[]

    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

    livemode boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    marketing_features

    object[]

    A list of up to 15 marketing features for this product. These are displayed in pricing tables.

  • Array [

  • name string

    Possible values: <= 80 characters

    The marketing feature name. Up to 80 characters long.

  • ]

  • metadata

    object

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    property name* string
    name string

    The product's name, meant to be displayable to the customer.

    object string

    String representing the object's type. Always has the value product.

    package_dimensions

    object

    The dimensions of this product for shipping purposes.

    height number

    Height, in inches.

    length number

    Length, in inches.

    weight number

    Weight, in ounces.

    width number

    Width, in inches.

    shippable boolean

    Whether this product is shipped (i.e., physical goods).

    statement_descriptor string

    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.

    tax_code

    A tax code ID.

    unit_label string

    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.

    updated integer

    Time at which the product was last updated. Measured in seconds since the Unix epoch.

    url string

    A URL of a publicly-accessible webpage for this product.

    lastUpdateTime date-time

    LastUpdateTime holds the value of the "last_update_time" field.

    lastUpdatedBy string

    LastUpdatedBy holds the value of the "last_updated_by" field.

    metaInfo

    object

    MetaInfo holds the value of the "meta_info" field.

    aceApnCrmUniqueIdentifier string

    The linked ACE ApnCrmUniqueIdentifier of the private offer if available.

    approvalInfo

    object

    ApprovalInfo holds the value of the "approval_info" field.

    approvalStatus ApprovalStatus (string)

    Possible values: [Submitted, Approved, Declined, Action Required]

    ApprovalStatus holds the current approval status of the offer | "Submitted" | "Approved" | "Declined" | "Action Required";

    decisionDate date-time

    DecisionDate is when the final approval/decline happened (nil when pending) Latest DecisionDate

    message string

    Message is the reason or explanation provided when the approval status is set to Declined or Action Required. It always stores the latest message for the current status transition. Historical messages are stored in notification events.

    requestDate date-time

    Latest RequestDate

    awsSaasProductDimensions

    object[]

    The AWS SaaS product dimensions. Applicable for AWS SaaS products only. This is used to save price info when creating AWS SaaS product.

  • Array [

  • Description string
    Key string
    Length integer

    The term length for the commit amount, such as 6 months, or 1 year. The length is used together with timeUnit. Length and TimeUnit are only used for commit dimension.

    Name string
    Rate number

    Below three fields are only used for pass data when create or update product's public offer pricing. Rate is only used for update public offer, becasue rate will be set as 0.01 when create new product.

    TimeUnit TimeUnit (string)

    Possible values: [DAY, WEEK, MONTH, YEAR]

    The term unit for the commit amount. Applicable to Direct only.

    Types string[]
    Unit string
  • ]

  • azureBillingAccountID string

    The Azure billing account ID of the buyer for this entitlement. It is populated when syncing Azure private offers or subscriptions.

    azureOriginalOfferIDForUpgrade string

    Original offer ID for Azure Upgrade

    baseAgreementId string

    Applicable for AWS Marketplace only, when the IsAgreementBasedOffer is true.

    buyerIds string[]

    The Suger buyer IDs of the private offer if available.

    chargebeeSubscriptionID string

    The Chargebee subscription ID of the private offer if available.

    contacts

    object[]

    The contacts of the offer to notify if any updates.

  • Array [

  • company string
    email string
    name string
  • ]

  • cppoInOfferId string

    The Suger CPPO_IN offer ID.

    cppoOfferId string

    The Suger CPPO offer ID. Reseller to end buyer

    cppoOutOfferId string

    The Suger CPPO_OUT offer ID. ISV to reseller

    createdByEmail string

    The email address of the user who created the offer. This field is immutable after creation. Especially useful for offers created from Salesforce/HubSpot integrations where the creator may not have a Suger account yet.

    createdBySource CreatedBySource (string)

    Possible values: [``, CONSOLE, SALESFORCE, HUBSPOT, API, CLOUD_PARTNER, AUTO_SHARE]

    The source system that created the offer (CONSOLE, SALESFORCE, HUBSPOT, API). This field is immutable after creation, auto-detected from the authentication context.

    customMetaInfo

    object

    The custom meta info of the offer can be updated by seller via API or console.

    property name* string
    enableTestUsageMetering boolean

    If enabled, Suger will test metering the usage for this entitlement hourly.

    entitlementCancellationSchedule

    object

    The cancellation schedule for the entitlement. It is nill if no cancellation schedule.

    cancelDate date-time

    The cancellation date of the entitlement. It is required when the type is SpecificDate.

    creationDate date-time

    When this cancellation schedule is created.

    note string

    Possible values: <= 500 characters

    The cancellation note. Max 500 characters.

    type CancellationScheduleType (string)

    Possible values: [EndOfTerm, Immediate, SpecificDate]

    Cancellation type

    errorMessages string[]

    The error messages when the offer is invalid or offer related tasks failed. This is the raw error messages from the offer related tasks.

    gcpBillingAccountID string

    The GCP billing account ID of the buyer for this entitlement. It is populated when syncing GCP Marketplace entitlements.

    hubspotDealId string

    Hubsport deal ID of the private offer if available.

    internalNote string

    The Internal note of the private offer. It is only visible to the seller/ISV, not visible to the buyer. Up to MaxInternalNoteLength characters.

    isAgreementBasedOffer boolean

    Applicable for AWS Marketplace only, If this offer is agreement based offer.

    isAzureUpgradeOffer boolean

    If this offer is an Azure upgrade offer.

    isGrossRevenueFullSync boolean

    Whether the gross revenue is fully synced for the entitlement.

    isRenewalOffer boolean

    Applicable for AWS Marketplace only. If this offer is renewal offer of existing agreement. The existing agreement can be within or outside AWS Marketplace. AWS may audit and verify your offer is a renewal. If AWS is unable to verify your offer, then AWS may revoke the offer and entitlements from your customer.

    isReplacementOffer boolean

    If this offer is a GCP replacement offer. Applicable for GCP Marketplace replacement offer only.

    lastModifiedBy

    object

    The user who last modified the product/offer/buyer/contact.

    email string

    The email of the creator.

    entityId string

    The ID of the creator.

    entityType EntityType (string)

    Possible values: [``, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, FUNDING_APPLICATION, HEADLESS_ENTITLEMENTS, HUBSPOT_USER, INTEGRATION, INTERNAL_ACTION_REQUEST, INVOICE, JOIN_ORG_REQUEST, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SERVICE, SUPPORT_TICKET, UNPURCHASED_OFFERS, USAGE_RECORD_GROUP, USAGE_RECORD_REPORT, USER, WORKFLOW, WORKFLOW_EXECUTION, WORKFLOW_WEBHOOK, ORGANIZATION_INFO]

    The Entity type of the creator, either USER or API_CLIENT.

    name string

    The name of the creator.

    notifications

    object[]

    The notifications of the offer if any updates. In most cases, it is to notify contacts/buyers when the offer is pending acceptance.

  • Array [

  • action NotificationEventAction (string)

    Possible values: [``, ABNORMAL_ALERT, ACCEPT, ADD, APPROVE, CANCEL, CLOSE, CREATE, DELETE, ARCHIVE, PENDING_CREATE, CREATE_FAILED, ACTIVE, VOID, DISBURSE, END_SOON, EXPIRE, EXPIRE_SOON, MERGE, METER, NEW_CLIENT_SIGNUP, NOTIFY, NOTIFY_CONTACTS, OPEN_EMAIL, PENDING_CANCEL, PENDING_ACCEPTANCE, REINSTATE, REJECT, REOPEN, CHARGE, REFUND, ISSUE, SIGN, PENDING_PARTNER_ACTION, TERMINATE, ROTATE_SECRET, SUSPEND, TEST, UPDATE, SUBMIT_APPROVAL_REQUEST, REVIEW_APPROVAL_REQUEST, APPROVE_APPROVAL_REQUEST, DECLINE_APPROVAL_REQUEST, COMPLETE, FAIL, WEBHOOK, INBOUND]

    The action of this notification message.

    ccContactIds string[]

    Cc contactIds that will receive this notification

    channels NotificationChannel (string)[]

    Possible values: [EMAIL, SLACK, SMS, SNS, SALESFORCE, WEBHOOK, SUGER_SUPPORT, MICROSOFT_TEAMS]

    The list of channels this event will be sent to, e.g., ["SLACK", "EMAIL"]

    contactEmails string[]

    Contact emails that will receive this notification

    contactIds string[]

    ContactIds that will receive this notification

    createdBy

    object

    The user who last modified the product/offer/buyer/contact.

    email string

    The email of the creator.

    entityId string

    The ID of the creator.

    entityType EntityType (string)

    Possible values: [``, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, FUNDING_APPLICATION, HEADLESS_ENTITLEMENTS, HUBSPOT_USER, INTEGRATION, INTERNAL_ACTION_REQUEST, INVOICE, JOIN_ORG_REQUEST, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SERVICE, SUPPORT_TICKET, UNPURCHASED_OFFERS, USAGE_RECORD_GROUP, USAGE_RECORD_REPORT, USER, WORKFLOW, WORKFLOW_EXECUTION, WORKFLOW_WEBHOOK, ORGANIZATION_INFO]

    The Entity type of the creator, either USER or API_CLIENT.

    name string

    The name of the creator.

    customFields

    object

    Custom fields of the notification event.

    property name* any

    Custom fields of the notification event.

    entityID string
    entityName string

    The name of the entity.

    entityStatus string
    entityType EntityType (string)

    Possible values: [``, API_CLIENT, AUDITING_EVENT, AUTO_SHARE_TASK, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, FUNDING_APPLICATION, HEADLESS_ENTITLEMENTS, HUBSPOT_USER, INTEGRATION, INTERNAL_ACTION_REQUEST, INVOICE, JOIN_ORG_REQUEST, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SERVICE, SUPPORT_TICKET, UNPURCHASED_OFFERS, USAGE_RECORD_GROUP, USAGE_RECORD_REPORT, USER, WORKFLOW, WORKFLOW_EXECUTION, WORKFLOW_WEBHOOK, ORGANIZATION_INFO]

    The Entity type of the creator, either USER or API_CLIENT.

    eventID string

    notification event id.

    eventStatus NotificationEventStatus (string)

    Possible values: [``, SCHEDULED, PENDING, DONE, FAILED]

    notification event status.

    info

    Additional info of the notification event.

    isActionItem boolean

    If this notification event is an action item.

    lastUpdateTime date-time

    timestamp of the event when it is updated.

    message string

    The message of the notification event such as email body, action item description.

    organizationID string

    suger organization id.

    partner Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, DNS, GCP, GONG, GOOGLE, HUBSPOT, INTUIT, LAGO, MARKETO, METRONOME, MICROSOFT, OPENAI, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, SNOWFLAKE, STRIPE, ZOHO, OAUTH2, SALESFORCE, HUBSPOT, AWS, AZURE, GCP]

    The partner where this usage metering daily record is from. Such as AWS, AZURE or GCP.

    priority AuditingEventPriority (string)

    Possible values: [``, LOW, MEDIUM, HIGH, CRITICAL]

    The priority of the notification event.

    requireAudit boolean

    If this notification event is an auditing event and need to store in DB.

    timestamp date-time

    timestamp of the event when it is scheduled or created.

    title string

    The title of the notification event such as email subject, action item title.

    trackEvents

    object[]

    The track events of the notification event.

  • Array [

  • action TrackEventActionType (string)

    Possible values: [OPEN_EMAIL]

    contactId string

    The ID of the contact who triggered the track event if applicable.

    timestamp date-time

    timestamp of the track event happened.

  • ]

  • ]

  • offerAcceptDate date-time

    The date when the offer is accepted by the buyer. Only available when the private offer has been accepted.

    offerCreationSuccessDate date-time

    The datetime when the offer was successfully created on the partner's marketplace (AWS, Azure, GCP, etc).

    originalEulaInfo

    object

    Original EULA info of the offer. It is used to store the original EULA info of the offer. used for clone offer.

    additionalEulaUrls string[]

    The URL of the additional EULA files. Only applicable when EulaType = CUSTOM. The additional EULA files will be attached to the EULA file in the EulaUrl, and form a single EULA file.

    additionalResellerEulaUrls string[]

    The URL of the additional reseller EULA files. Only applicable when ResellerEulaType = CUSTOM.

    attachEulaType EulaType (string)

    Possible values: [``, SCMP, ECMP, RCMP, CUSTOM, ISV, CURRENT]

    Attach the standard EULA file to the CUSTOM EULA file. Only applicable when EulaType = CUSTOM

    eulaMergeOrder integer[]

    The merge order of the EULA files. Only applicable when EulaType = CUSTOM. Elements are the original index of the EULA files in the index they should be transferred to, where original indexes are: AttachEulaType is index 0, EulaUrl is index 1, additionalEulaUrls is index 2 onwards.

    eulaType EulaType (string)

    Possible values: [``, SCMP, ECMP, RCMP, CUSTOM, ISV, CURRENT]

    Attach the standard EULA file to the CUSTOM EULA file. Only applicable when EulaType = CUSTOM

    eulaUrl string

    The URL of the EULA file.

    resellerAttachEulaType EulaType (string)

    Possible values: [``, SCMP, ECMP, RCMP, CUSTOM, ISV, CURRENT]

    Attach the standard EULA file to the CUSTOM EULA file. Only applicable when EulaType = CUSTOM

    resellerEulaType EulaType (string)

    Possible values: [``, SCMP, ECMP, RCMP, CUSTOM, ISV, CURRENT]

    Attach the standard EULA file to the CUSTOM EULA file. Only applicable when EulaType = CUSTOM

    resellerEulaUrl string
    prettifiedErrorMessages string[]

    The prettified ErrorMessages. Using AI to make it more readable and understandable. The prettified error messages will be used for the offer related UI display.

    renewalOfferType AwsRenewalOfferType (string)

    Possible values: [``, External, AwsMarketplace]

    Indicates if the existing agreement was signed outside AWS Marketplace or within AWS Marketplace. one of values ["External", "AwsMarketplace"]

    replacedOfferEndTime date-time

    The end time of the replaced offer. Applicable for GCP Marketplace replacement offer only.

    replacedOfferResourceName string

    The resource name of the GCP Marketplace offer that this offer is replacing. In format of "projects/{gcpProjectNumber}/services/{productServiceName}/privateOffers/{privateOfferId}" Applicable for GCP Marketplace replacement offer only.

    replacedResellerPrivateOfferPlan string

    The resource name of the GCP marketplace reseller private offer plan that this offer is replacing. In format of "resellerPrivateOfferPlans/{resellerOfferPrivatePlanId}"

    resellerIds string[]

    The reseller IDs (in the identity.buyer table) associated with this offer. Only applicable for CPPO_OUT & CPPO offers.

    salesforceEntitlementURL string

    The Salesforce entitlement URL

    salesforceOpportunityId string

    The Salesforce opportunity ID of the private offer if available.

    salesforceQuoteId string

    The Salesforce Quote ID of the private offer if available.

    testUsageMeteringEndTime date-time

    The test usage metering end time. It is used for test usage metering only. Required if EnableTestUsageMetering is true.

    updateMessage string

    The message to notify when the offer is updated.

    warningMessages string[]

    Warning messages for non-blocking issues that were auto-fixed. For example, deal type auto-fix when Native Renewal eligibility criteria are not met.

    name string

    Name holds the value of the "name" field.

    organizationID string

    OrganizationID holds the value of the "organization_id" field.

    partner string

    Partner holds the value of the "partner" field.

    partnerID string

    PartnerID holds the value of the "partner_id" field.

    productType product.ProductType (string)

    Possible values: [UNKNOWN, SUBSCRIPTION, CONTRACT, FLAT_RATE, PER_USER, USAGE_BASED]

    ProductType holds the value of the "product_type" field.

    sellerID string

    SellerID holds the value of the "seller_id" field.

    service string

    Service holds the value of the "service" field.

    status string

    Status holds the value of the "status" field.

  • ]

  • page_number integer
    page_size integer
    total_count integer
Loading...