create product
POST/org/:orgId/product
create a new product in the marketplace
Request
Path Parameters
Organization ID
- application/json
Body
required
the product to create
Array [
]
Array [
Array [
Array [
Array [
]
]
]
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
Array [
]
Array [
]
]
Array [
]
Array [
]
Array [
Array [
]
Array [
]
Array [
]
]
Array [
]
Array [
Array [
Array [
]
]
Array [
]
]
Array [
]
Array [
]
Array [
Array [
]
Array [
]
Array [
Array [
]
]
]
Array [
Array [
Array [
]
]
Array [
]
Array [
Array [
Array [
]
]
Array [
]
Array [
]
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
]
]
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
Array [
]
Array [
]
Array [
Array [
]
]
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
info
object
alibabaProduct
object
ProductExtras
object
ProductExtra
object[]
ProductSkus
object
ProductSku
object[]
POSTPAY or PREPAY
Modules
object
Module
object[]
Properties
object
Property
object[]
PropertyValues
object
PropertyValue
object[]
OrderPeriods
object
OrderPeriod
object[]
ShopInfo
object
Telephones
object
WangWangs
object
WangWang
object[]
attributes
object
awsAmiProduct
object
Description
object
Dimensions
object[]
PromotionalResources
object
AdditionalResources
object[]
Currently, AWS only support 1 url in the array.
Repositories
object[]
SignatureVerificationKeys
object[]
SupportInformation
object
Versions
object[]
DeliveryOptions
object[]
Exclusive Fields For AWS AMI Product
Exclusive Fields For AWS SaaS Product
Exclusive Fields For AWS Container Product
The product Id in AWS Marketplace Data Feed Service.
AWS Product ID
awsContainerProduct
object
Description
object
Dimensions
object[]
PromotionalResources
object
AdditionalResources
object[]
Currently, AWS only support 1 url in the array.
Repositories
object[]
SignatureVerificationKeys
object[]
SupportInformation
object
Versions
object[]
DeliveryOptions
object[]
Exclusive Fields For AWS AMI Product
Exclusive Fields For AWS SaaS Product
Exclusive Fields For AWS Container Product
The product Id in AWS Marketplace Data Feed Service.
AWS Product ID
awsProfessionalServicesProduct
object
Description
object
Dimensions
object[]
PromotionalResources
object
AdditionalResources
object[]
Currently, AWS only support 1 url in the array.
Repositories
object[]
SignatureVerificationKeys
object[]
SupportInformation
object
Versions
object[]
DeliveryOptions
object[]
Exclusive Fields For AWS AMI Product
Exclusive Fields For AWS SaaS Product
Exclusive Fields For AWS Container Product
The product Id in AWS Marketplace Data Feed Service.
AWS Product ID
awsSaasProduct
object
Description
object
Dimensions
object[]
PromotionalResources
object
AdditionalResources
object[]
Currently, AWS only support 1 url in the array.
Repositories
object[]
SignatureVerificationKeys
object[]
SupportInformation
object
Versions
object[]
DeliveryOptions
object[]
Exclusive Fields For AWS AMI Product
Exclusive Fields For AWS SaaS Product
Exclusive Fields For AWS Container Product
The product Id in AWS Marketplace Data Feed Service.
AWS Product ID
awsSnsSubscriptions
object[]
Possible values: [UNKNOWN, CONFIRMED, PENDING_CONFIRMATION]
azureProduct
object
availabilities
object[]
emailAudiences
object[]
subscriptionAudiences
object[]
branches
object[]
externalIDs
object[]
listings
object[]
assets
object[]
Not original fields. They are populated by other API calls
Possible values: [ListingAsset, ListingImage, ListingVideo]
Possible values: [PendingUpload, Uploaded, InProcessing, Processed, ProcessFailed]
listingContacts
object[]
Possible values: [CustomerSupport, Engineering, ChannelManager]
listingUris
object[]
Possible values: [AzureListing]
packageConfigurations
object[]
Possible values: [AzureSoftwareAsAServicePackageConfiguration]
plans
object[]
All plans under this product
Possible values: [``, editExistingOfferPricingOnly, saasNewCustomizedPlans, vmSoftwareReservations]
The azure plan friendly name, from the Azure Marketplace.
pricing
object
customMeters
object
One of PriceAndAvailabilityCustomMeter_USD or PriceAndAvailabilityCustomMeter_PerMarket
Possible values: [perMarket, usd]
default "usd"
recurrentPrice
object
Possible values: [perMarket, usd]
default "usd"
prices
object[]
billingTerm
object
Possible values: [day, week, month, year]
default 0
paymentOption
object
Possible values: [day, week, month, year]
default 0
prices
object[]
ISO 4217 currency code
default 0
Possible values: [flatRate, perUser]
default "flatRate"
userLimits
object
softwareReservation
object
paymentSchedule
object
Possible values: [day, week, month, year]
default 0
reservationDuration
object
Possible values: [day, week, month, year]
default 0
vmPrices
object
patternProperties
object
property name*
AzureMarketplaceVmPricePropertyItem
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
properties
object[]
leveledCategories
object
leveledIndustries
object
setup
object
Possible values: [free, free-trial, contact-me]
channelStates
object[]
Possible values: [AzureProductSetup]
Possible values: [ListingOnly, ListAndSell]
submissions
object[]
pendingUpdateInfo
object
Possible values: [Submission]
resources
object[]
Possible values: [Inprogress, Published]
Possible values: [InDraft, Submitted, Failed, FailedInCertification, ReadyToPublish, Publishing, Published, InStore]
targets
object[]
variantResources
object[]
resources
object[]
variants
object[]
azureGovernmentCertifications
object[]
validationResults
object[]
extendedProperties
object[]
featureAvailabilities
object[]
Not original fields. They are populated by other API calls
customMeters
object[]
includedBaseQuantities
object[]
Possible values: [Monthly, Annual]
marketStates
object[]
ISO Country Code
Possible values: [Disabled, Enabled, StopSelling, Terminated]
markets
object[]
ISO Country Code
priceSchedules
object[]
dateTimeRange
object
endAt
object
startAt
object
There is only one base schedule.
ISO country code
schedules
object[]
priceCadence
object
Possible values: [Month, Year]
Possible values: [Flat, Recurring, Usage]
pricingUnits
object[]
Possible values: [sharedcore, transactions]
retailPrice
object
ISO currency code, Three characters
properties
object[]
ResourceType = FeatureAvailability
subscriptionAudiences
object[]
tenantAudiences
object[]
trial
object
dateTimeRange
object
endAt
object
startAt
object
Possible values: [Minute, Days, Months]
Possible values: [NoTrial, TimedAccess, TimedUsage, Unlimited]
Possible values: [Public, Private]
Possible values: [AzureSkuVariant, AzureTestDriveVariant]
Possible values: [InActive, Active]
azureProductResource
object
customerLeads
object
Possible values: [none, blob, dynamics, email, httpsEndpoint, marketo, salesforce, table]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
listing
object
cloudSolutionProviderContact
object
in patern of "^(http|https)://"
engineeringContact
object
in patern of "^(http|https)://"
generalLinks
object[]
in patern of "^(http|https)://"
Possible values: [azureSaaS, azureVM, xbox360NonBackCompat]
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
Product resource name, in format of "product/product-durable-id"
supportContact
object
in patern of "^(http|https)://"
Max string length is 200.
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
listingAssets
object[]
minimum: 0
Possible values: [azure]
Max string length is 10.
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
Product resource name, in format of "product/product-durable-id"
Possible values: [azureLogoSmall, azureLogoMedium, azureLogoLarge, azureLogoWide, azureLogoScreenshot, azureLogoHero, pdfDocument]
pattern: "^https?://"
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
plans
object[]
plan
object
azureGovernmentCertifications
object[]
in patern of "^(http|https)://"
enums:[azureGlobal,azureGovernment,azureGermany,azureChina]
deprecationSchedule
object
alternative
object
format: date-time
format: duration
Possible values: [criticalSecurityIssue, endOfSupport, other]
default 2147483647
in format of "plan/product-durable-id/plan-durable-id"
identity
object
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
in format of "product/product-durable-id"
Possible values: [managedApplication, solutionTemplate]
Specifies the plan type (AzureApplication-type products only) see: https://go.microsoft.com/fwlink/?linkid=2106322
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
planListing
object
Possible values: [azureVM-plan, azureSaaS-plan, azureCoreVM-plan, azureContainer-plan]
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
priceAndAvailabilityPlan
object
Possible values: [public, private]
pricing
object
corePricing
object
Possible values: [free, flat, perCore, perCoreSize, perMarketAndCoreSize]
prices
object[]
ISO 4217 currency code
default 0
customMeters
object
meters
object
property name*
AzureMarketplacePriceAndAvailabilityCustomMeterPriceMeterItem
billingTerm
object
Possible values: [day, week, month, year]
default 0
includedQuantities
object[]
billingTerm
object
Possible values: [day, week, month, year]
default 0
paymentOption
object
Possible values: [day, week, month, year]
default 0
prices
object[]
prices
object[]
ISO 4217 currency code
default 0
Possible values: [perMarket, usd]
default "usd"
Possible values: [byol, payAsYouGo]
recurrentPrice
object
Possible values: [perMarket, usd]
default "usd"
prices
object[]
billingTerm
object
Possible values: [day, week, month, year]
default 0
paymentOption
object
Possible values: [day, week, month, year]
default 0
prices
object[]
ISO 4217 currency code
default 0
Possible values: [flatRate, perUser]
default "flatRate"
userLimits
object
systemMeterPricing
object
default 0
Possible values: [perCore, perEveryCoreInCluster, perNode, perEveryNodeInCluster, perPod, perCluster]
prices
object[]
ISO 4217 currency code
default 0
privateAudiences
object[]
Possible values: [none, subscription, ea, msdn, tenant, email]
softwareReservation
object[]
default 0
default 0
Possible values: [month, year]
trial
object
Possible values: [day, week, month, year]
default 0
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
Possible values: [visible, hidden]
priceAndAvailabilityCustomMeter
object
customMeters
object
property name*
AzureMarketplacePriceAndAvailabilityCustomMeterItem
Suger's custom field, for Suger internal use only. Not from Microsoft official schema.
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
priceAndAvailabilityOffer
object
previewAudiences
object[]
Possible values: [none, subscription, ea, msdn, tenant, email]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
product
object
The Product Display Name
in format of "product/product-durable-id"
identity
object
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
Possible values: [azureApplication, azureContainer, azureVirtualMachine, consultingService, containerApp, coreVirtualMachine, cosellOnly, dynamics365BusinessCentral, dynamics365ForCustomerEngagement, dynamics365ForOperations, iotEdgeModule, managedService, powerBiApp, powerBiVisual, softwareAsAService, xbox360NonBackcompat]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
property
object
categories
object
property name*
string[]
string
cloudIndustries
object
property name*
string[]
string
customAmendments
object[]
tenants
object
manualEntries
object[]
industries
object
property name*
string[]
string
Possible values: [azureSaaS, azureVM]
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
Possible values: [custom, standardMicrosoft]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
reseller
object
audiences
object[]
Possible values: [subscription]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
setup
object
in patern of "^(http|https)://"
Possible values: [free, freeTrial, contactMe]
In format of "commercial-marketplace-setup/setup-durable-id"
Product resource name, in format of "product/product-durable-id"
If true, only per_user pricing model is allowed.
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
submission
object
Date-time string
deprecationSchedule
object
alternative
object
format: date-time
format: duration
Possible values: [criticalSecurityIssue, endOfSupport, other]
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
Possible values: [succeeded, failed, pending]
Possible values: [notStarted, running, completed]
target
object
Possible values: [flight, sandbox, draft, preview, live, certification, retail]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
technicalConfiguration
object
Azure AD Application Id
Azure AD Tenant Id
in format of "product/product-durable-id"
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
commits
object[]
Whether this commit dimension is newly created by user, when creating AWS Marketplace Contract private offer.
API name of the dimension
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.
Possible values: >= 1 and <= 1000000
Default value: 1000000
The maximum number of users for PER_USER commit
Possible values: >= 1 and <= 1000000
Default value: 1
The minimum number of users for PER_USER commit
Display name of the dimension
The quantity of this commit.
The commit amount. For GCP, it is monthly commitment.
The term of the commit amount. It is used for front-end display only.
The end time of the commit term.
Possible values: [DAY, MONTH, YEAR]
Possible values: [FLAT_RATE, PER_USER]
These indicate whether the dimension covers metering, entitlement, or support for external metering
dimensions
object[]
includedBaseQuantities
object[]
how many quantities of this dimension are included in the commit.
Possible values: [Monthly, Annual]
Display name of the dimension. For GCP Marketplace, it is the metering metric ID without plan prefix.
The plan ID of the metering dimension. Applicable to GCP Marketplace only. No ISO duration suffix.
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.
such as 0
price
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
such as "0"
The unit price of this usage metering dimension.
The SKU ID of the metering dimension. Applicable to GCP Marketplace only.
usageCount
object
The count of this dimension usage records that are handled as credit.
The count of this dimension usage records that are handled as included in IncludedBaseQuantity
The count of this dimension usage records that are reported to cloud vendors.
Possible values: [``, VALUE_TYPE_UNSPECIFIED, BOOL, INT64, DOUBLE, STRING, DISTRIBUTION, MONEY]
Possible values: [``, SCMP, ECMP, RCMP, CUSTOM, ISV, CURRENT]
The public offer's EULA URL.
gcpProduct
object
derivedDiscoveryState
object
Possible values: [ALLUSERS_ACCESSIBLE, NOT_ALLUSERS_ACCESSIBLE, NOT_PUBLISHED]
Possible values: [ADMIN_OVERRIDE_UNSEARCHABLE, SEARCHABLE]
Nullable, GCP Marketplace Product UUID
listingSpec
object
externalAccountSpec
object
Possible values: [BillingIntegratedManagedService]
marketingSpec
object
documentationSpecs
object[]
externalLicenseSpecs
object[]
in format of "base64://..."
supportSpec
object
purchaseSpec
object
features
object[]
metrics
object[]
GCP Marketplace Product Usage Metering Dimension/Metric
Description: A detailed description of the metric, which can be used in documentation.
such as "min"
such as "minute"
The usage metering metric/dimension key, all in lower case with underscore. It is in format of "{plan_id}_{usage_dimension_key}". For example, "basic_plan_storage".
such as "DELTA"
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.
such as 0
price
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
such as "0"
such as "min"
The SKU ID of this usage metering metric. Applicable only in Private Offer.
such as "min"
Possible values: [``, VALUE_TYPE_UNSPECIFIED, BOOL, INT64, DOUBLE, STRING, DISTRIBUTION, MONEY]
purchaseOptionSpecs
object[]
GCP Marketplace Product Pricing Plans
featureValues
object[]
such as "CPU per VM"
such as "cpu"
such as "CPU"
such as "2 CPU per VM"
The plan ID, such as "starter", without the duration suffix, such as "P1Y".
priceInfo
object
Possible values: [FREE, SUBSCRIPTION, USAGE, SUBSCRIPTION_PLUS_USAGE]
subscriptionPlans
object[]
Subscription Plan (Flat Commitment)
such as "ONE_YEAR", "TWO_YEAR", "THREE_YEAR"
price
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
usageFees
object[]
Usage Metering Dimension/Metric if available
such as 1
such as "Starter_storage"
priceTiers
object[]
such as 0
price
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
such as "0"
Possible values: [PURCHASE_MODE_PRIVATE, PURCHASE_MODE_PUBLIC]
such as "Starter"
termsSpec
object
TODO: need to define the type
TODO: need to define the type
Possible values: [marketplaces/google-cloud]
In format of "projects/{project-number}/listings/{product-name}.endpoints.{provider-id}.cloud.goog"
In format of "services/{product-name}.endpoints.{provider-id}.cloud.goog"
serviceConfig
object
billing
object
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[]
Description: A detailed description of the metric, which can be used in documentation.
such as "min"
such as "minute"
The usage metering metric/dimension key, all in lower case with underscore. It is in format of "{plan_id}_{usage_dimension_key}". For example, "basic_plan_storage".
such as "DELTA"
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.
such as 0
price
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
such as "0"
such as "min"
The SKU ID of this usage metering metric. Applicable only in Private Offer.
such as "min"
Possible values: [``, VALUE_TYPE_UNSPECIFIED, BOOL, INT64, DOUBLE, STRING, DISTRIBUTION, MONEY]
in format of "product-name.endpoints.gcp-project-id.cloud.goog"
The GCP project ID of the producer.
The title of the product listing.
TODO: add type
stripeProduct
object
Whether the product is currently available for purchase.
Time at which the object was created. Measured in seconds since the Unix epoch.
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.
Unique identifier for the product in Stripe.
A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
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.
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.
The product's name, meant to be displayable to the customer.
String representing the object's type. Always has the value product.
package_dimensions
object
Height, in inches.
Length, in inches.
Weight, in ounces.
Width, in inches.
Whether this product is shipped (i.e., physical goods).
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.
A tax code ID.
A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
Time at which the product was last updated. Measured in seconds since the Unix epoch.
A URL of a publicly-accessible webpage for this product.
metaInfo
object
The linked ACE ApnCrmUniqueIdentifier of the private offer if available.
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.
Applicable for AWS Marketplace only, when the IsAgreementBasedOffer is true.
The Suger buyer IDs of the private offer if available.
contacts
object[]
The contacts of the offer to notify if any updates.
The Suger CPPO_IN offer ID.
The Suger CPPO offer ID.
The Suger CPPO_OUT offer ID.
customMetaInfo
object
The custom meta info of the offer can be updated by seller via API or console.
If enabled, Suger will test metering the usage for this entitlement hourly.
entitlementCancellationSchedule
object
The cancellation date of the entitlement. It is required when the type is SpecificDate.
When this cancellation schedule is created.
Possible values: <= 500 characters
The cancellation note. Max 500 characters.
Possible values: [EndOfTerm, Immediate, SpecificDate]
Cancellation type
The error messages when the offer is invalid or offer related tasks failed. Populated by Suger service.
Hubsport deal ID of the private offer if available.
The Internal note of the private offer. It is only visible to the seller/ISV, not visible to the buyer. Up to 1000 characters.
Applicable for AWS Marketplace only, If this offer is agreement based offer.
Whether the gross revenue is fully synced for the entitlement.
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.
If this offer is a GCP replacement offer. Applicable for GCP Marketplace replacement offer only.
lastModifiedBy
object
The email of the creator.
The ID of the creator.
Possible values: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]
The Entity type of the creator, either USER or API_CLIENT.
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.
Possible values: [``, ABNORMAL_ALERT, ACCEPT, ADD, APPROVE, CANCEL, CLOSE, CREATE, DELETE, DISBURSE, END_SOON, EXPIRE, EXPIRE_SOON, METER, NEW_CLIENT_SIGNUP, NOTIFY, NOTIFY_CONTACTS, OPEN_EMAIL, PENDING_CANCEL, PENDING_ACCEPTANCE, REINSTATE, REJECT, REOPEN, CHARGE, REFUND, ISSUE, ROTATE_SECRET, SUSPEND, TEST, UPDATE]
Cc contactIds that will receive this notification
Possible values: [EMAIL, SLACK, SMS, SNS, WEBHOOK, SUGER_SUPPORT, MICROSOFT_TEAMS]
The list of channels this event will be sent to, e.g., ["SLACK", "EMAIL"]
Contact emails that will receive this notification
ContactIds that will receive this notification
createdBy
object
The email of the creator.
The ID of the creator.
Possible values: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]
The Entity type of the creator, either USER or API_CLIENT.
The name of the creator.
customFields
object
Custom fields of the notification event.
Custom fields of the notification event.
The name of the entity.
Possible values: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]
notification event id.
Possible values: [``, SCHEDULED, PENDING, DONE, FAILED]
Additional info of the notification event.
If this notification event is an action item.
timestamp of the event when it is updated.
The message of the notification event such as email body, action item description.
suger organization id.
Possible values: [``, ADYEN, ALIBABA, AWS, AWS_CHINA, AZURE, GCP, GOOGLE, HUBSPOT, LAGO, MARKETO, METRONOME, MICROSOFT, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, STRIPE, ZOHO]
Possible values: [``, LOW, MEDIUM, HIGH, CRITICAL]
If this notification event is an auditing event and need to store in DB.
timestamp of the event when it is scheduled or created.
The title of the notification event such as email subject, action item title.
trackEvents
object[]
The track events of the notification event.
Possible values: [OPEN_EMAIL]
The ID of the contact who triggered the track event if applicable.
timestamp of the track event happened.
The date when the offer is accepted by the buyer. Only available when the private offer has been accepted.
Possible values: [``, External, AwsMarketplace]
The end time of the replaced offer. Applicable for GCP Marketplace replacement offer only.
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.
The Salesforce entitlement URL
The Salesforce opportunity ID of the private offer if available.
The test usage metering end time. It is used for test usage metering only. Required if EnableTestUsageMetering is true.
The message to notify when the offer is updated.
Possible values: [``, ADYEN, ALIBABA, AWS, AWS_CHINA, AZURE, GCP, GOOGLE, HUBSPOT, LAGO, MARKETO, METRONOME, MICROSOFT, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, STRIPE, ZOHO]
Possible values: [UNKNOWN, SUBSCRIPTION, CONTRACT, FLAT_RATE, PER_USER, USAGE_BASED]
Possible values: [DEFAULT, MARKETPLACE, ACE, COSELL, CRM, CPQ, CHATBOT, BILLING, BIGQUERY, DRIVE, EMAIL, STORAGE, PAYMENT, TEAMS]
Responses
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
Array [
Array [
Array [
]
]
]
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
Array [
]
Array [
]
]
Array [
]
Array [
]
Array [
Array [
]
Array [
]
Array [
]
]
Array [
]
Array [
Array [
Array [
]
]
Array [
]
]
Array [
]
Array [
]
Array [
Array [
]
Array [
]
Array [
Array [
]
]
]
Array [
Array [
Array [
]
]
Array [
]
Array [
Array [
Array [
]
]
Array [
]
Array [
]
Array [
Array [
Array [
]
]
]
Array [
]
Array [
]
Array [
]
]
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
Array [
Array [
]
Array [
]
Array [
Array [
]
]
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
info
object
alibabaProduct
object
ProductExtras
object
ProductExtra
object[]
ProductSkus
object
ProductSku
object[]
POSTPAY or PREPAY
Modules
object
Module
object[]
Properties
object
Property
object[]
PropertyValues
object
PropertyValue
object[]
OrderPeriods
object
OrderPeriod
object[]
ShopInfo
object
Telephones
object
WangWangs
object
WangWang
object[]
attributes
object
awsAmiProduct
object
Description
object
Dimensions
object[]
PromotionalResources
object
AdditionalResources
object[]
Currently, AWS only support 1 url in the array.
Repositories
object[]
SignatureVerificationKeys
object[]
SupportInformation
object
Versions
object[]
DeliveryOptions
object[]
Exclusive Fields For AWS AMI Product
Exclusive Fields For AWS SaaS Product
Exclusive Fields For AWS Container Product
The product Id in AWS Marketplace Data Feed Service.
AWS Product ID
awsContainerProduct
object
Description
object
Dimensions
object[]
PromotionalResources
object
AdditionalResources
object[]
Currently, AWS only support 1 url in the array.
Repositories
object[]
SignatureVerificationKeys
object[]
SupportInformation
object
Versions
object[]
DeliveryOptions
object[]
Exclusive Fields For AWS AMI Product
Exclusive Fields For AWS SaaS Product
Exclusive Fields For AWS Container Product
The product Id in AWS Marketplace Data Feed Service.
AWS Product ID
awsProfessionalServicesProduct
object
Description
object
Dimensions
object[]
PromotionalResources
object
AdditionalResources
object[]
Currently, AWS only support 1 url in the array.
Repositories
object[]
SignatureVerificationKeys
object[]
SupportInformation
object
Versions
object[]
DeliveryOptions
object[]
Exclusive Fields For AWS AMI Product
Exclusive Fields For AWS SaaS Product
Exclusive Fields For AWS Container Product
The product Id in AWS Marketplace Data Feed Service.
AWS Product ID
awsSaasProduct
object
Description
object
Dimensions
object[]
PromotionalResources
object
AdditionalResources
object[]
Currently, AWS only support 1 url in the array.
Repositories
object[]
SignatureVerificationKeys
object[]
SupportInformation
object
Versions
object[]
DeliveryOptions
object[]
Exclusive Fields For AWS AMI Product
Exclusive Fields For AWS SaaS Product
Exclusive Fields For AWS Container Product
The product Id in AWS Marketplace Data Feed Service.
AWS Product ID
awsSnsSubscriptions
object[]
Possible values: [UNKNOWN, CONFIRMED, PENDING_CONFIRMATION]
azureProduct
object
availabilities
object[]
emailAudiences
object[]
subscriptionAudiences
object[]
branches
object[]
externalIDs
object[]
listings
object[]
assets
object[]
Not original fields. They are populated by other API calls
Possible values: [ListingAsset, ListingImage, ListingVideo]
Possible values: [PendingUpload, Uploaded, InProcessing, Processed, ProcessFailed]
listingContacts
object[]
Possible values: [CustomerSupport, Engineering, ChannelManager]
listingUris
object[]
Possible values: [AzureListing]
packageConfigurations
object[]
Possible values: [AzureSoftwareAsAServicePackageConfiguration]
plans
object[]
All plans under this product
Possible values: [``, editExistingOfferPricingOnly, saasNewCustomizedPlans, vmSoftwareReservations]
The azure plan friendly name, from the Azure Marketplace.
pricing
object
customMeters
object
One of PriceAndAvailabilityCustomMeter_USD or PriceAndAvailabilityCustomMeter_PerMarket
Possible values: [perMarket, usd]
default "usd"
recurrentPrice
object
Possible values: [perMarket, usd]
default "usd"
prices
object[]
billingTerm
object
Possible values: [day, week, month, year]
default 0
paymentOption
object
Possible values: [day, week, month, year]
default 0
prices
object[]
ISO 4217 currency code
default 0
Possible values: [flatRate, perUser]
default "flatRate"
userLimits
object
softwareReservation
object
paymentSchedule
object
Possible values: [day, week, month, year]
default 0
reservationDuration
object
Possible values: [day, week, month, year]
default 0
vmPrices
object
patternProperties
object
property name*
AzureMarketplaceVmPricePropertyItem
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
properties
object[]
leveledCategories
object
leveledIndustries
object
setup
object
Possible values: [free, free-trial, contact-me]
channelStates
object[]
Possible values: [AzureProductSetup]
Possible values: [ListingOnly, ListAndSell]
submissions
object[]
pendingUpdateInfo
object
Possible values: [Submission]
resources
object[]
Possible values: [Inprogress, Published]
Possible values: [InDraft, Submitted, Failed, FailedInCertification, ReadyToPublish, Publishing, Published, InStore]
targets
object[]
variantResources
object[]
resources
object[]
variants
object[]
azureGovernmentCertifications
object[]
validationResults
object[]
extendedProperties
object[]
featureAvailabilities
object[]
Not original fields. They are populated by other API calls
customMeters
object[]
includedBaseQuantities
object[]
Possible values: [Monthly, Annual]
marketStates
object[]
ISO Country Code
Possible values: [Disabled, Enabled, StopSelling, Terminated]
markets
object[]
ISO Country Code
priceSchedules
object[]
dateTimeRange
object
endAt
object
startAt
object
There is only one base schedule.
ISO country code
schedules
object[]
priceCadence
object
Possible values: [Month, Year]
Possible values: [Flat, Recurring, Usage]
pricingUnits
object[]
Possible values: [sharedcore, transactions]
retailPrice
object
ISO currency code, Three characters
properties
object[]
ResourceType = FeatureAvailability
subscriptionAudiences
object[]
tenantAudiences
object[]
trial
object
dateTimeRange
object
endAt
object
startAt
object
Possible values: [Minute, Days, Months]
Possible values: [NoTrial, TimedAccess, TimedUsage, Unlimited]
Possible values: [Public, Private]
Possible values: [AzureSkuVariant, AzureTestDriveVariant]
Possible values: [InActive, Active]
azureProductResource
object
customerLeads
object
Possible values: [none, blob, dynamics, email, httpsEndpoint, marketo, salesforce, table]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
listing
object
cloudSolutionProviderContact
object
in patern of "^(http|https)://"
engineeringContact
object
in patern of "^(http|https)://"
generalLinks
object[]
in patern of "^(http|https)://"
Possible values: [azureSaaS, azureVM, xbox360NonBackCompat]
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
Product resource name, in format of "product/product-durable-id"
supportContact
object
in patern of "^(http|https)://"
Max string length is 200.
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
listingAssets
object[]
minimum: 0
Possible values: [azure]
Max string length is 10.
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
Product resource name, in format of "product/product-durable-id"
Possible values: [azureLogoSmall, azureLogoMedium, azureLogoLarge, azureLogoWide, azureLogoScreenshot, azureLogoHero, pdfDocument]
pattern: "^https?://"
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
plans
object[]
plan
object
azureGovernmentCertifications
object[]
in patern of "^(http|https)://"
enums:[azureGlobal,azureGovernment,azureGermany,azureChina]
deprecationSchedule
object
alternative
object
format: date-time
format: duration
Possible values: [criticalSecurityIssue, endOfSupport, other]
default 2147483647
in format of "plan/product-durable-id/plan-durable-id"
identity
object
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
in format of "product/product-durable-id"
Possible values: [managedApplication, solutionTemplate]
Specifies the plan type (AzureApplication-type products only) see: https://go.microsoft.com/fwlink/?linkid=2106322
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
planListing
object
Possible values: [azureVM-plan, azureSaaS-plan, azureCoreVM-plan, azureContainer-plan]
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
priceAndAvailabilityPlan
object
Possible values: [public, private]
pricing
object
corePricing
object
Possible values: [free, flat, perCore, perCoreSize, perMarketAndCoreSize]
prices
object[]
ISO 4217 currency code
default 0
customMeters
object
meters
object
property name*
AzureMarketplacePriceAndAvailabilityCustomMeterPriceMeterItem
billingTerm
object
Possible values: [day, week, month, year]
default 0
includedQuantities
object[]
billingTerm
object
Possible values: [day, week, month, year]
default 0
paymentOption
object
Possible values: [day, week, month, year]
default 0
prices
object[]
prices
object[]
ISO 4217 currency code
default 0
Possible values: [perMarket, usd]
default "usd"
Possible values: [byol, payAsYouGo]
recurrentPrice
object
Possible values: [perMarket, usd]
default "usd"
prices
object[]
billingTerm
object
Possible values: [day, week, month, year]
default 0
paymentOption
object
Possible values: [day, week, month, year]
default 0
prices
object[]
ISO 4217 currency code
default 0
Possible values: [flatRate, perUser]
default "flatRate"
userLimits
object
systemMeterPricing
object
default 0
Possible values: [perCore, perEveryCoreInCluster, perNode, perEveryNodeInCluster, perPod, perCluster]
prices
object[]
ISO 4217 currency code
default 0
privateAudiences
object[]
Possible values: [none, subscription, ea, msdn, tenant, email]
softwareReservation
object[]
default 0
default 0
Possible values: [month, year]
trial
object
Possible values: [day, week, month, year]
default 0
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
Possible values: [visible, hidden]
priceAndAvailabilityCustomMeter
object
customMeters
object
property name*
AzureMarketplacePriceAndAvailabilityCustomMeterItem
Suger's custom field, for Suger internal use only. Not from Microsoft official schema.
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
priceAndAvailabilityOffer
object
previewAudiences
object[]
Possible values: [none, subscription, ea, msdn, tenant, email]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
product
object
The Product Display Name
in format of "product/product-durable-id"
identity
object
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
Possible values: [azureApplication, azureContainer, azureVirtualMachine, consultingService, containerApp, coreVirtualMachine, cosellOnly, dynamics365BusinessCentral, dynamics365ForCustomerEngagement, dynamics365ForOperations, iotEdgeModule, managedService, powerBiApp, powerBiVisual, softwareAsAService, xbox360NonBackcompat]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
property
object
categories
object
property name*
string[]
string
cloudIndustries
object
property name*
string[]
string
customAmendments
object[]
tenants
object
manualEntries
object[]
industries
object
property name*
string[]
string
Possible values: [azureSaaS, azureVM]
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
Possible values: [custom, standardMicrosoft]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
reseller
object
audiences
object[]
Possible values: [subscription]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
setup
object
in patern of "^(http|https)://"
Possible values: [free, freeTrial, contactMe]
In format of "commercial-marketplace-setup/setup-durable-id"
Product resource name, in format of "product/product-durable-id"
If true, only per_user pricing model is allowed.
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
submission
object
Date-time string
deprecationSchedule
object
alternative
object
format: date-time
format: duration
Possible values: [criticalSecurityIssue, endOfSupport, other]
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
Possible values: [succeeded, failed, pending]
Possible values: [notStarted, running, completed]
target
object
Possible values: [flight, sandbox, draft, preview, live, certification, retail]
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
technicalConfiguration
object
Azure AD Application Id
Azure AD Tenant Id
in format of "product/product-durable-id"
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
commits
object[]
Whether this commit dimension is newly created by user, when creating AWS Marketplace Contract private offer.
API name of the dimension
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.
Possible values: >= 1 and <= 1000000
Default value: 1000000
The maximum number of users for PER_USER commit
Possible values: >= 1 and <= 1000000
Default value: 1
The minimum number of users for PER_USER commit
Display name of the dimension
The quantity of this commit.
The commit amount. For GCP, it is monthly commitment.
The term of the commit amount. It is used for front-end display only.
The end time of the commit term.
Possible values: [DAY, MONTH, YEAR]
Possible values: [FLAT_RATE, PER_USER]
These indicate whether the dimension covers metering, entitlement, or support for external metering
dimensions
object[]
includedBaseQuantities
object[]
how many quantities of this dimension are included in the commit.
Possible values: [Monthly, Annual]
Display name of the dimension. For GCP Marketplace, it is the metering metric ID without plan prefix.
The plan ID of the metering dimension. Applicable to GCP Marketplace only. No ISO duration suffix.
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.
such as 0
price
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
such as "0"
The unit price of this usage metering dimension.
The SKU ID of the metering dimension. Applicable to GCP Marketplace only.
usageCount
object
The count of this dimension usage records that are handled as credit.
The count of this dimension usage records that are handled as included in IncludedBaseQuantity
The count of this dimension usage records that are reported to cloud vendors.
Possible values: [``, VALUE_TYPE_UNSPECIFIED, BOOL, INT64, DOUBLE, STRING, DISTRIBUTION, MONEY]
Possible values: [``, SCMP, ECMP, RCMP, CUSTOM, ISV, CURRENT]
The public offer's EULA URL.
gcpProduct
object
derivedDiscoveryState
object
Possible values: [ALLUSERS_ACCESSIBLE, NOT_ALLUSERS_ACCESSIBLE, NOT_PUBLISHED]
Possible values: [ADMIN_OVERRIDE_UNSEARCHABLE, SEARCHABLE]
Nullable, GCP Marketplace Product UUID
listingSpec
object
externalAccountSpec
object
Possible values: [BillingIntegratedManagedService]
marketingSpec
object
documentationSpecs
object[]
externalLicenseSpecs
object[]
in format of "base64://..."
supportSpec
object
purchaseSpec
object
features
object[]
metrics
object[]
GCP Marketplace Product Usage Metering Dimension/Metric
Description: A detailed description of the metric, which can be used in documentation.
such as "min"
such as "minute"
The usage metering metric/dimension key, all in lower case with underscore. It is in format of "{plan_id}_{usage_dimension_key}". For example, "basic_plan_storage".
such as "DELTA"
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.
such as 0
price
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
such as "0"
such as "min"
The SKU ID of this usage metering metric. Applicable only in Private Offer.
such as "min"
Possible values: [``, VALUE_TYPE_UNSPECIFIED, BOOL, INT64, DOUBLE, STRING, DISTRIBUTION, MONEY]
purchaseOptionSpecs
object[]
GCP Marketplace Product Pricing Plans
featureValues
object[]
such as "CPU per VM"
such as "cpu"
such as "CPU"
such as "2 CPU per VM"
The plan ID, such as "starter", without the duration suffix, such as "P1Y".
priceInfo
object
Possible values: [FREE, SUBSCRIPTION, USAGE, SUBSCRIPTION_PLUS_USAGE]
subscriptionPlans
object[]
Subscription Plan (Flat Commitment)
such as "ONE_YEAR", "TWO_YEAR", "THREE_YEAR"
price
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
usageFees
object[]
Usage Metering Dimension/Metric if available
such as 1
such as "Starter_storage"
priceTiers
object[]
such as 0
price
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
such as "0"
Possible values: [PURCHASE_MODE_PRIVATE, PURCHASE_MODE_PUBLIC]
such as "Starter"
termsSpec
object
TODO: need to define the type
TODO: need to define the type
Possible values: [marketplaces/google-cloud]
In format of "projects/{project-number}/listings/{product-name}.endpoints.{provider-id}.cloud.goog"
In format of "services/{product-name}.endpoints.{provider-id}.cloud.goog"
serviceConfig
object
billing
object
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[]
Description: A detailed description of the metric, which can be used in documentation.
such as "min"
such as "minute"
The usage metering metric/dimension key, all in lower case with underscore. It is in format of "{plan_id}_{usage_dimension_key}". For example, "basic_plan_storage".
such as "DELTA"
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.
such as 0
price
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
such as "0"
such as "min"
The SKU ID of this usage metering metric. Applicable only in Private Offer.
such as "min"
Possible values: [``, VALUE_TYPE_UNSPECIFIED, BOOL, INT64, DOUBLE, STRING, DISTRIBUTION, MONEY]
in format of "product-name.endpoints.gcp-project-id.cloud.goog"
The GCP project ID of the producer.
The title of the product listing.
TODO: add type
stripeProduct
object
Whether the product is currently available for purchase.
Time at which the object was created. Measured in seconds since the Unix epoch.
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.
Unique identifier for the product in Stripe.
A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
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.
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.
The product's name, meant to be displayable to the customer.
String representing the object's type. Always has the value product.
package_dimensions
object
Height, in inches.
Length, in inches.
Weight, in ounces.
Width, in inches.
Whether this product is shipped (i.e., physical goods).
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.
A tax code ID.
A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
Time at which the product was last updated. Measured in seconds since the Unix epoch.
A URL of a publicly-accessible webpage for this product.
metaInfo
object
The linked ACE ApnCrmUniqueIdentifier of the private offer if available.
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.
Applicable for AWS Marketplace only, when the IsAgreementBasedOffer is true.
The Suger buyer IDs of the private offer if available.
contacts
object[]
The contacts of the offer to notify if any updates.
The Suger CPPO_IN offer ID.
The Suger CPPO offer ID.
The Suger CPPO_OUT offer ID.
customMetaInfo
object
The custom meta info of the offer can be updated by seller via API or console.
If enabled, Suger will test metering the usage for this entitlement hourly.
entitlementCancellationSchedule
object
The cancellation date of the entitlement. It is required when the type is SpecificDate.
When this cancellation schedule is created.
Possible values: <= 500 characters
The cancellation note. Max 500 characters.
Possible values: [EndOfTerm, Immediate, SpecificDate]
Cancellation type
The error messages when the offer is invalid or offer related tasks failed. Populated by Suger service.
Hubsport deal ID of the private offer if available.
The Internal note of the private offer. It is only visible to the seller/ISV, not visible to the buyer. Up to 1000 characters.
Applicable for AWS Marketplace only, If this offer is agreement based offer.
Whether the gross revenue is fully synced for the entitlement.
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.
If this offer is a GCP replacement offer. Applicable for GCP Marketplace replacement offer only.
lastModifiedBy
object
The email of the creator.
The ID of the creator.
Possible values: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]
The Entity type of the creator, either USER or API_CLIENT.
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.
Possible values: [``, ABNORMAL_ALERT, ACCEPT, ADD, APPROVE, CANCEL, CLOSE, CREATE, DELETE, DISBURSE, END_SOON, EXPIRE, EXPIRE_SOON, METER, NEW_CLIENT_SIGNUP, NOTIFY, NOTIFY_CONTACTS, OPEN_EMAIL, PENDING_CANCEL, PENDING_ACCEPTANCE, REINSTATE, REJECT, REOPEN, CHARGE, REFUND, ISSUE, ROTATE_SECRET, SUSPEND, TEST, UPDATE]
Cc contactIds that will receive this notification
Possible values: [EMAIL, SLACK, SMS, SNS, WEBHOOK, SUGER_SUPPORT, MICROSOFT_TEAMS]
The list of channels this event will be sent to, e.g., ["SLACK", "EMAIL"]
Contact emails that will receive this notification
ContactIds that will receive this notification
createdBy
object
The email of the creator.
The ID of the creator.
Possible values: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]
The Entity type of the creator, either USER or API_CLIENT.
The name of the creator.
customFields
object
Custom fields of the notification event.
Custom fields of the notification event.
The name of the entity.
Possible values: [``, ABNORMAL_PAYMENT_TRANSACTIONS, API_CLIENT, AUDITING_EVENT, BUYER, CONTACT, ENTITLEMENT, ENTITLEMENT_TERM, HEADLESS_ENTITLEMENTS, INTEGRATION, INVOICE, NEW_CLIENT, NOTIFICATION_MESSAGE, OFFER, WORKFLOW, ORGANIZATION, PAYMENT_TRANSACTION, PRODUCT, REFERRAL, REVENUE_RECORD, SUPPORT_TICKET, UNPURCHASED_OFFERS, USER]
notification event id.
Possible values: [``, SCHEDULED, PENDING, DONE, FAILED]
Additional info of the notification event.
If this notification event is an action item.
timestamp of the event when it is updated.
The message of the notification event such as email body, action item description.
suger organization id.
Possible values: [``, ADYEN, ALIBABA, AWS, AWS_CHINA, AZURE, GCP, GOOGLE, HUBSPOT, LAGO, MARKETO, METRONOME, MICROSOFT, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, STRIPE, ZOHO]
Possible values: [``, LOW, MEDIUM, HIGH, CRITICAL]
If this notification event is an auditing event and need to store in DB.
timestamp of the event when it is scheduled or created.
The title of the notification event such as email subject, action item title.
trackEvents
object[]
The track events of the notification event.
Possible values: [OPEN_EMAIL]
The ID of the contact who triggered the track event if applicable.
timestamp of the track event happened.
The date when the offer is accepted by the buyer. Only available when the private offer has been accepted.
Possible values: [``, External, AwsMarketplace]
The end time of the replaced offer. Applicable for GCP Marketplace replacement offer only.
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.
The Salesforce entitlement URL
The Salesforce opportunity ID of the private offer if available.
The test usage metering end time. It is used for test usage metering only. Required if EnableTestUsageMetering is true.
The message to notify when the offer is updated.
Possible values: [``, ADYEN, ALIBABA, AWS, AWS_CHINA, AZURE, GCP, GOOGLE, HUBSPOT, LAGO, MARKETO, METRONOME, MICROSOFT, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, STRIPE, ZOHO]
Possible values: [UNKNOWN, SUBSCRIPTION, CONTRACT, FLAT_RATE, PER_USER, USAGE_BASED]
Possible values: [DEFAULT, MARKETPLACE, ACE, COSELL, CRM, CPQ, CHATBOT, BILLING, BIGQUERY, DRIVE, EMAIL, STORAGE, PAYMENT, TEAMS]
{
"createdBy": "string",
"creationTime": "2024-08-12T01:02:15.188Z",
"externalID": "string",
"fulfillmentUrl": "string",
"id": "string",
"info": {
"alibabaProduct": {
"AuditFailMsg": "string",
"AuditStatus": "string",
"AuditTime": 0,
"Code": "string",
"Description": "string",
"FrontCategoryId": 0,
"GmtCreated": 0,
"GmtModified": 0,
"Name": "string",
"PicUrl": "string",
"ProductExtras": {
"ProductExtra": [
{
"Key": "string",
"Label": "string",
"Order": 0,
"Type": "string",
"Values": {}
}
]
},
"ProductSkus": {
"ProductSku": [
{
"ChargeType": "string",
"Code": "string",
"Constraints": "string",
"Hidden": true,
"Modules": {
"Module": [
{
"Code": "string",
"Id": "string",
"Name": "string",
"Properties": {
"Property": [
{
"DisplayUnit": "string",
"Key": "string",
"Name": "string",
"PropertyValues": {
"PropertyValue": [
{
"DisplayName": "string",
"Max": "string",
"Min": "string",
"Remark": "string",
"Step": "string",
"Type": "string",
"Value": "string"
}
]
},
"showType": "string"
}
]
}
}
]
},
"Name": "string",
"OrderPeriods": {
"OrderPeriod": [
{
"Name": "string",
"PeriodType": "string"
}
]
}
}
]
},
"RequestId": "string",
"Score": 0,
"ShopInfo": {
"Emails": "string",
"Id": 0,
"Name": "string",
"Telephones": {
"Telephone": [
"string"
]
},
"WangWangs": {
"WangWang": [
{
"Remark": "string",
"UserName": "string"
}
]
}
},
"ShortDescription": "string",
"Status": "string",
"SupplierPk": 0,
"Type": "string",
"UseCount": 0
},
"attributes": {},
"awsAmiProduct": {
"Description": {
"AssociatedProducts": {},
"Categories": [
"string"
],
"EuW8Submitted": true,
"Highlights": [
"string"
],
"LongDescription": "string",
"Manufacturer": "string",
"ProductCode": "string",
"ProductTitle": "string",
"Registered": true,
"SearchKeywords": [
"string"
],
"ShortDescription": "string",
"Sku": "string",
"UsW9Submitted": true,
"Visibility": "string"
},
"Dimensions": [
{
"Description": "string",
"Key": "string",
"Name": "string",
"Rate": 0,
"Types": [
"string"
],
"Unit": "string"
}
],
"PromotionalResources": {
"AdditionalResources": [
{
"Text": "string",
"Type": "string",
"Url": "string"
}
],
"LogoUrl": "string",
"VideoUrls": [
"string"
]
},
"Repositories": [
{
"Type": "string",
"Url": "string"
}
],
"SignatureVerificationKeys": [
{
"PublicKey": "string",
"PublicKeyVersion": 0,
"Status": "string"
}
],
"SupportInformation": {
"Description": "string"
},
"Versions": [
{
"CreationDate": "2024-08-12T01:02:15.190Z",
"DeliveryOptions": [
{
"AmiAlias": "string",
"FulfillmentUrl": "string",
"Id": "string",
"Recommendations": {},
"ShortDescription": "string",
"SourceId": "string",
"Title": "string",
"Type": "string",
"Visibility": "string"
}
],
"Id": "string",
"ReleaseNotes": "string",
"VersionTitle": "string"
}
],
"dataFeedProductId": "string",
"productId": "string"
},
"awsContainerProduct": {
"Description": {
"AssociatedProducts": {},
"Categories": [
"string"
],
"EuW8Submitted": true,
"Highlights": [
"string"
],
"LongDescription": "string",
"Manufacturer": "string",
"ProductCode": "string",
"ProductTitle": "string",
"Registered": true,
"SearchKeywords": [
"string"
],
"ShortDescription": "string",
"Sku": "string",
"UsW9Submitted": true,
"Visibility": "string"
},
"Dimensions": [
{
"Description": "string",
"Key": "string",
"Name": "string",
"Rate": 0,
"Types": [
"string"
],
"Unit": "string"
}
],
"PromotionalResources": {
"AdditionalResources": [
{
"Text": "string",
"Type": "string",
"Url": "string"
}
],
"LogoUrl": "string",
"VideoUrls": [
"string"
]
},
"Repositories": [
{
"Type": "string",
"Url": "string"
}
],
"SignatureVerificationKeys": [
{
"PublicKey": "string",
"PublicKeyVersion": 0,
"Status": "string"
}
],
"SupportInformation": {
"Description": "string"
},
"Versions": [
{
"CreationDate": "2024-08-12T01:02:15.190Z",
"DeliveryOptions": [
{
"AmiAlias": "string",
"FulfillmentUrl": "string",
"Id": "string",
"Recommendations": {},
"ShortDescription": "string",
"SourceId": "string",
"Title": "string",
"Type": "string",
"Visibility": "string"
}
],
"Id": "string",
"ReleaseNotes": "string",
"VersionTitle": "string"
}
],
"dataFeedProductId": "string",
"productId": "string"
},
"awsProfessionalServicesProduct": {
"Description": {
"AssociatedProducts": {},
"Categories": [
"string"
],
"EuW8Submitted": true,
"Highlights": [
"string"
],
"LongDescription": "string",
"Manufacturer": "string",
"ProductCode": "string",
"ProductTitle": "string",
"Registered": true,
"SearchKeywords": [
"string"
],
"ShortDescription": "string",
"Sku": "string",
"UsW9Submitted": true,
"Visibility": "string"
},
"Dimensions": [
{
"Description": "string",
"Key": "string",
"Name": "string",
"Rate": 0,
"Types": [
"string"
],
"Unit": "string"
}
],
"PromotionalResources": {
"AdditionalResources": [
{
"Text": "string",
"Type": "string",
"Url": "string"
}
],
"LogoUrl": "string",
"VideoUrls": [
"string"
]
},
"Repositories": [
{
"Type": "string",
"Url": "string"
}
],
"SignatureVerificationKeys": [
{
"PublicKey": "string",
"PublicKeyVersion": 0,
"Status": "string"
}
],
"SupportInformation": {
"Description": "string"
},
"Versions": [
{
"CreationDate": "2024-08-12T01:02:15.190Z",
"DeliveryOptions": [
{
"AmiAlias": "string",
"FulfillmentUrl": "string",
"Id": "string",
"Recommendations": {},
"ShortDescription": "string",
"SourceId": "string",
"Title": "string",
"Type": "string",
"Visibility": "string"
}
],
"Id": "string",
"ReleaseNotes": "string",
"VersionTitle": "string"
}
],
"dataFeedProductId": "string",
"productId": "string"
},
"awsSaasProduct": {
"Description": {
"AssociatedProducts": {},
"Categories": [
"string"
],
"EuW8Submitted": true,
"Highlights": [
"string"
],
"LongDescription": "string",
"Manufacturer": "string",
"ProductCode": "string",
"ProductTitle": "string",
"Registered": true,
"SearchKeywords": [
"string"
],
"ShortDescription": "string",
"Sku": "string",
"UsW9Submitted": true,
"Visibility": "string"
},
"Dimensions": [
{
"Description": "string",
"Key": "string",
"Name": "string",
"Rate": 0,
"Types": [
"string"
],
"Unit": "string"
}
],
"PromotionalResources": {
"AdditionalResources": [
{
"Text": "string",
"Type": "string",
"Url": "string"
}
],
"LogoUrl": "string",
"VideoUrls": [
"string"
]
},
"Repositories": [
{
"Type": "string",
"Url": "string"
}
],
"SignatureVerificationKeys": [
{
"PublicKey": "string",
"PublicKeyVersion": 0,
"Status": "string"
}
],
"SupportInformation": {
"Description": "string"
},
"Versions": [
{
"CreationDate": "2024-08-12T01:02:15.190Z",
"DeliveryOptions": [
{
"AmiAlias": "string",
"FulfillmentUrl": "string",
"Id": "string",
"Recommendations": {},
"ShortDescription": "string",
"SourceId": "string",
"Title": "string",
"Type": "string",
"Visibility": "string"
}
],
"Id": "string",
"ReleaseNotes": "string",
"VersionTitle": "string"
}
],
"dataFeedProductId": "string",
"productId": "string"
},
"awsSnsSubscriptions": [
{
"Endpoint": "string",
"Protocol": "string",
"Status": "UNKNOWN",
"SubscriptionArn": "string",
"TopicArn": "string"
}
],
"azureProduct": {
"availabilities": [
{
"emailAudiences": [
{
"description": "string",
"id": "string"
}
],
"enterpriseLicensing": "string",
"id": "string",
"resourceType": "string",
"subscriptionAudiences": [
{
"description": "string",
"id": "string"
}
],
"visibility": "string"
}
],
"branches": [
{
"currentDraftInstanceID": "string",
"friendlyName": "string",
"id": "string",
"module": "string",
"resourceType": "string",
"type": "string",
"variantID": "string"
}
],
"externalIDs": [
{
"type": "string",
"value": "string"
}
],
"id": "string",
"isModularPublishing": true,
"listings": [
{
"accessInformation": "string",
"assets": [
{
"description": "string",
"fileName": "string",
"fileSasUri": "string",
"friendlyName": "string",
"id": "string",
"order": 0,
"publisherDefinedSasUri": "string",
"resourceType": "ListingAsset",
"state": "PendingUpload",
"type": "string"
}
],
"compatibleProducts": [
"string"
],
"description": "string",
"gettingStartedInstructions": "string",
"id": "string",
"keywords": [
"string"
],
"languageCode": "string",
"listingContacts": [
{
"email": "string",
"name": "string",
"phone": "string",
"type": "CustomerSupport",
"uri": "string"
}
],
"listingUris": [
{
"displayText": "string",
"subtype": "string",
"type": "string",
"uri": "string"
}
],
"productDisplayName": "string",
"publisherName": "string",
"resourceType": "AzureListing",
"shortDescription": "string",
"summary": "string",
"title": "string"
}
],
"name": "string",
"packageConfigurations": [
{
"azureActiveDirectoryApplicationID": "string",
"azureActiveDirectoryTenantID": "string",
"connectionWebhook": "string",
"id": "string",
"landingPageUri": "string",
"resourceType": "AzureSoftwareAsAServicePackageConfiguration"
}
],
"plans": [
{
"$schema": "string",
"id": "string",
"offerPricingType": "",
"plan": "string",
"planName": "string",
"pricing": {
"customMeters": {
"priceInputOption": "perMarket"
},
"recurrentPrice": {
"priceInputOption": "perMarket",
"prices": [
{
"billingTerm": {
"type": "day",
"value": 0
},
"paymentOption": {
"type": "day",
"value": 0
},
"pricePerPaymentInUsd": 0,
"prices": [
{
"currency": "string",
"markets": [
"string"
],
"price": 0,
"prices": {}
}
]
}
],
"recurrentPriceMode": "flatRate",
"userLimits": {
"max": 0,
"min": 0
}
}
},
"product": "string",
"resourceName": "string",
"softwareReservation": {
"paymentSchedule": {
"type": "day",
"value": 0
},
"reservationDuration": {
"type": "day",
"value": 0
},
"vmPrices": {
"patternProperties": {}
}
},
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
}
],
"properties": [
{
"additionalCategories": [
"string"
],
"appVersion": "string",
"applicableProducts": [
"string"
],
"categories": [
"string"
],
"customAmendments": [
"string"
],
"extendedProperties": [
"string"
],
"globalAmendmentTerms": "string",
"hideKeys": [
"string"
],
"id": "string",
"industries": [
"string"
],
"leveledCategories": {},
"leveledIndustries": {},
"marketingOnlyChange": true,
"productTags": [
"string"
],
"resourceType": "string",
"submissionVersion": "string",
"termsOfUse": "string",
"useEnterpriseContract": true
}
],
"resourceType": "string",
"setup": {
"callToAction": "free",
"channelStates": [
{
"type": "string",
"value": "string"
}
],
"enableTestDrive": true,
"resourceType": "AzureProductSetup",
"sellingOption": "ListingOnly",
"testDriveType": "string",
"trialUri": "string"
},
"submissions": [
{
"areResourcesReady": true,
"friendlyName": "string",
"id": "string",
"pendingUpdateInfo": {
"status": "string",
"updateType": "string"
},
"publishedTimeInUtc": "2024-08-12T01:02:15.192Z",
"releaseNumber": 0,
"resourceType": "Submission",
"resources": [
{
"type": "string",
"value": "string"
}
],
"state": "Inprogress",
"subState": "InDraft",
"targets": [
{
"type": "string",
"value": "string"
}
],
"variantResources": [
{
"resources": [
{
"type": "string",
"value": "string"
}
],
"variantID": "string"
}
]
}
],
"variants": [
{
"azureGovernmentCertifications": [
{
"title": "string",
"uri": "string",
"validationResults": [
{
"errorMessage": "string",
"memberNames": [
"string"
]
}
]
}
],
"cloudAvailabilities": [
"string"
],
"conversionPaths": "string",
"extendedProperties": [
{
"type": "string",
"value": "string"
}
],
"externalID": "string",
"featureAvailabilities": [
{
"customMeters": [
{
"displayName": "string",
"id": "string",
"includedBaseQuantities": [
{
"isInfinite": true,
"quantity": 0,
"recurringUnit": "Monthly"
}
],
"isEnabled": true,
"priceInUsd": 0,
"uniqueID": "string",
"unitOfMeasure": "string"
}
],
"id": "string",
"isHidden": true,
"marketStates": [
{
"marketCode": "string",
"state": "Disabled"
}
],
"markets": [
{
"friendlyName": "string",
"marketCode": "string"
}
],
"priceSchedules": [
{
"dateTimeRange": {
"endAt": {
"dateTimeInUtc": "string",
"localizePerMarket": true
},
"startAt": {
"dateTimeInUtc": "string",
"localizePerMarket": true
}
},
"friendlyName": "string",
"isBaseSchedule": true,
"marketCodes": [
"string"
],
"schedules": [
{
"priceCadence": {
"type": "Month",
"value": 0
},
"pricingModel": "Flat",
"pricingUnits": [
{
"isUnlimitedUnit": true,
"lowerUnit": 0,
"name": "sharedcore",
"unitType": "string",
"upperUnit": 0
}
],
"retailPrice": {
"currencyCode": "string",
"openPrice": 0,
"priceTierID": "string"
}
}
]
}
],
"properties": [
{
"type": "string",
"value": "string"
}
],
"resourceType": "string",
"subscriptionAudiences": [
{
"description": "string",
"id": "string"
}
],
"tenantAudiences": [
{
"description": "string",
"id": "string"
}
],
"trial": {
"dateTimeRange": {
"endAt": {
"dateTimeInUtc": "string",
"localizePerMarket": true
},
"startAt": {
"dateTimeInUtc": "string",
"localizePerMarket": true
}
},
"duration": 0,
"durationType": "Minute",
"type": "NoTrial"
},
"visibility": "Public"
}
],
"friendlyName": "string",
"id": "string",
"leadGenID": "string",
"referenceVariantID": "string",
"resourceType": "AzureSkuVariant",
"state": "InActive"
}
]
},
"azureProductResource": {
"customerLeads": {
"$schema": "string",
"blobLeadConfiguration": {},
"dynamicsLeadConfiguration": {},
"emailLeadConfiguration": {},
"httpsEndpointLeadConfiguration": {},
"id": "string",
"leadDestination": "none",
"marketoLeadConfiguration": {},
"product": "string",
"resourceName": "string",
"salesforceLeadConfiguration": {},
"tableLeadConfiguration": {},
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
},
"listing": {
"$schema": "string",
"cloudSolutionProviderContact": {
"email": "string",
"name": "string",
"phone": "string",
"url": "string"
},
"cloudSolutionProviderMarketingMaterials": "string",
"description": "string",
"engineeringContact": {
"email": "string",
"name": "string",
"phone": "string",
"url": "string"
},
"generalLinks": [
{
"displayText": "string",
"link": "string"
}
],
"gettingStartedInstructions": "string",
"gloabalSupportWebsite": "string",
"governmentSupportWebsite": "string",
"id": "string",
"kind": "azureSaaS",
"languageId": "string",
"lifecycleState": "notAvailable",
"privacyPolicyLink": "string",
"product": "string",
"resourceName": "string",
"searchKeywords": [
"string"
],
"searchResultSummary": "string",
"shortDescription": "string",
"supportContact": {
"email": "string",
"name": "string",
"phone": "string",
"url": "string"
},
"title": "string",
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
},
"listingAssets": [
{
"$schema": "string",
"description": "string",
"displayOrder": 0,
"fileName": "string",
"friendlyName": "string",
"id": "string",
"kind": "azure",
"languageId": "string",
"lifecycleState": "notAvailable",
"listing": "string",
"product": "string",
"resourceName": "string",
"type": "azureLogoSmall",
"url": "string",
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
}
],
"plans": [
{
"plan": {
"$schema": "string",
"alias": "string",
"azureGovernmentCertifications": [
{
"link": "string",
"name": "string"
}
],
"azureRegions": [
"string"
],
"deprecationSchedule": {
"$schema": "string",
"alternative": {
"plan": {},
"product": {}
},
"date": "string",
"dateOffset": "string",
"reason": "criticalSecurityIssue"
},
"displayRank": 0,
"id": "string",
"identity": {
"externalId": "string"
},
"lifecycleState": "notAvailable",
"product": "string",
"resourceName": "string",
"subtype": "managedApplication",
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
},
"planListing": {
"$schema": "string",
"description": "string",
"id": "string",
"kind": "azureVM-plan",
"languageId": "string",
"lifecycleState": "notAvailable",
"name": "string",
"plan": "string",
"product": "string",
"resourceName": "string",
"summary": "string",
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
},
"priceAndAvailabilityPlan": {
"$schema": "string",
"audience": "public",
"billingTag": "string",
"id": "string",
"markets": [
"string"
],
"meterDefine": "string",
"plan": "string",
"pricing": {
"corePricing": {
"price": 0,
"priceInputOption": "free",
"pricePerCore": 0,
"pricePerCoreSize": {},
"prices": [
{
"currency": "string",
"markets": [
"string"
],
"price": 0,
"prices": {}
}
]
},
"customMeters": {
"meters": {},
"priceInputOption": "perMarket"
},
"licenseModel": "byol",
"recurrentPrice": {
"priceInputOption": "perMarket",
"prices": [
{
"billingTerm": {
"type": "day",
"value": 0
},
"paymentOption": {
"type": "day",
"value": 0
},
"pricePerPaymentInUsd": 0,
"prices": [
{
"currency": "string",
"markets": [
"string"
],
"price": 0,
"prices": {}
}
]
}
],
"recurrentPriceMode": "flatRate",
"userLimits": {
"max": 0,
"min": 0
}
},
"systemMeterPricing": {
"price": 0,
"priceInputOption": "perCore",
"prices": [
{
"currency": "string",
"markets": [
"string"
],
"price": 0,
"prices": {}
}
]
}
},
"privateAudiences": [
{
"id": "string",
"label": "string",
"type": "none"
}
],
"product": "string",
"resourceName": "string",
"softwareReservation": [
{
"percentageSave": 0,
"term": 0,
"type": "month"
}
],
"trial": {
"type": "day",
"value": 0
},
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
],
"visibility": "visible"
}
}
],
"priceAndAvailabilityCustomMeter": {
"$schema": "string",
"customMeters": {},
"id": "string",
"product": "string",
"resourceName": "string",
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
},
"priceAndAvailabilityOffer": {
"$schema": "string",
"id": "string",
"previewAudiences": [
{
"id": "string",
"label": "string",
"type": "none"
}
],
"product": "string",
"resourceName": "string",
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
},
"product": {
"$schema": "string",
"alias": "string",
"id": "string",
"identity": {
"externalId": "string"
},
"lifecycleState": "notAvailable",
"productGroup": "string",
"resourceName": "string",
"type": "azureApplication",
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
},
"property": {
"$schema": "string",
"appVersion": "string",
"categories": {},
"cloudIndustries": {},
"customAmendments": [
{
"tenants": {
"manualEntries": [
{
"description": "string",
"id": "string"
}
]
},
"terms": "string"
}
],
"id": "string",
"industries": {},
"kind": "azureSaaS",
"lifecycleState": "notAvailable",
"product": "string",
"resourceName": "string",
"standardContractAmendment": "string",
"termsConditions": "custom",
"termsOfUse": "string",
"termsOfUseUrl": "string",
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
},
"reseller": {
"$schema": "string",
"audiences": [
{
"description": "string",
"resourceId": "string",
"type": "subscription"
}
],
"id": "string",
"product": "string",
"resellerChannelState": "string",
"resourceName": "string",
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
},
"setup": {
"$schema": "string",
"accessUrl": "string",
"callToAction": "free",
"id": "string",
"product": "string",
"requireLicenseForInstall": true,
"resourceName": "string",
"sellThroughMicrosoft": true,
"useMicrosoftLicenseManagementService": true,
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
},
"submission": {
"$schema": "string",
"created": "string",
"deprecationSchedule": {
"$schema": "string",
"alternative": {
"plan": {},
"product": {}
},
"date": "string",
"dateOffset": "string",
"reason": "criticalSecurityIssue"
},
"id": "string",
"lifecycleState": "notAvailable",
"product": "string",
"resourceName": "string",
"result": "succeeded",
"status": "notStarted",
"target": {
"targetId": "string",
"targetType": "flight"
},
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
},
"technicalConfiguration": {
"$schema": "string",
"azureAdAppId": "string",
"azureAdTenantId": "string",
"connectionWebhook": "string",
"id": "string",
"landingPageUrl": "string",
"product": "string",
"resourceName": "string",
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
]
}
},
"commits": [
{
"category": "string",
"description": "string",
"isUserCreated": true,
"key": "string",
"length": 0,
"maximumUsers": 1000000,
"minimumUsers": 1,
"name": "string",
"quantity": 0,
"rate": 0,
"term": "string",
"termEndTime": "string",
"timeUnit": "DAY",
"type": "FLAT_RATE",
"types": [
"string"
]
}
],
"currency": "string",
"dimensions": [
{
"category": "string",
"description": "string",
"includedBaseQuantities": [
{
"isInfinite": true,
"quantity": 0,
"recurringUnit": "Monthly"
}
],
"key": "string",
"name": "string",
"planId": "string",
"planName": "string",
"priceTiers": [
{
"fromAmount": 0,
"price": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"startingUsageAmount": "string"
}
],
"rate": 0,
"skuId": "string",
"types": [
"string"
],
"usageCount": {
"creditCount": 0,
"includedCount": 0,
"reportedCount": 0
},
"valueType": ""
}
],
"eulaType": "",
"eulaUrl": "string",
"gcpProduct": {
"createTime": "2024-08-12T01:02:15.202Z",
"derivedDiscoveryState": {
"accessState": "ALLUSERS_ACCESSIBLE",
"searchState": "ADMIN_OVERRIDE_UNSEARCHABLE"
},
"id": "string",
"lastPublishTime": "2024-08-12T01:02:15.202Z",
"listingSpec": {
"externalAccountSpec": {
"loginUri": "string",
"signupUri": "string",
"singleSignOnUri": "string"
},
"listingType": "BillingIntegratedManagedService",
"marketingSpec": {
"description": "string",
"displayNames": [
"string"
],
"documentationSpecs": [
{
"description": "string",
"title": "string",
"uri": "string"
}
],
"eulaUrl": "string",
"externalLicenseSpecs": [
{
"description": "string",
"uri": "string"
}
],
"externalMarketingUrl": "string",
"icon": "string",
"searchCategories": [
"string"
],
"searchDescription": "string",
"searchKeywords": [
"string"
],
"signupUri": "string",
"supportSpec": {
"description": "string",
"email": "string",
"uri": "string"
},
"tagLine": "string",
"title": "string"
},
"purchaseSpec": {
"features": [
{
"description": "string",
"name": "string",
"title": "string"
}
],
"metrics": [
{
"description": "string",
"displayName": "string",
"displayUnit": "string",
"displayUnitDescription": "string",
"id": "string",
"metricKind": "string",
"name": "string",
"priceTiers": [
{
"fromAmount": 0,
"price": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"startingUsageAmount": "string"
}
],
"reportingUnit": "string",
"skuId": "string",
"unit": "string",
"valueType": ""
}
],
"purchaseOptionSpecs": [
{
"featureValues": [
{
"featureDescription": "string",
"featureName": "string",
"featureTitle": "string",
"featureValue": "string"
}
],
"name": "string",
"priceInfo": {
"description": "string",
"priceModel": "FREE",
"subscriptionPlans": [
{
"period": "string",
"price": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
}
],
"usageFees": [
{
"displayQuantity": 0,
"metricId": "string",
"priceTiers": [
{
"fromAmount": 0,
"price": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"startingUsageAmount": "string"
}
]
}
]
},
"purchaseMode": "PURCHASE_MODE_PRIVATE",
"title": "string"
}
]
},
"termsSpec": {
"eulaUri": "string"
}
},
"marketplace": "marketplaces/google-cloud",
"name": "string",
"revisionCreateTime": "2024-08-12T01:02:15.202Z",
"revisionId": "string",
"service": "string",
"serviceConfig": {
"billing": {
"metrics": [
"string"
]
},
"metrics": [
{
"description": "string",
"displayName": "string",
"displayUnit": "string",
"displayUnitDescription": "string",
"id": "string",
"metricKind": "string",
"name": "string",
"priceTiers": [
{
"fromAmount": 0,
"price": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"startingUsageAmount": "string"
}
],
"reportingUnit": "string",
"skuId": "string",
"unit": "string",
"valueType": ""
}
],
"name": "string",
"producerProjectId": "string",
"title": "string"
}
},
"refundCancellationPolicy": "string",
"sellerNotes": "string",
"stripeProduct": {
"active": true,
"created": 0,
"description": "string",
"id": "string",
"images": [
"string"
],
"livemode": true,
"marketing_features": [
{
"name": "string"
}
],
"metadata": {},
"name": "string",
"object": "string",
"package_dimensions": {
"height": 0,
"length": 0,
"weight": 0,
"width": 0
},
"shippable": true,
"statement_descriptor": "string",
"unit_label": "string",
"updated": 0,
"url": "string"
}
},
"lastUpdateTime": "2024-08-12T01:02:15.203Z",
"lastUpdatedBy": "string",
"metaInfo": {
"aceApnCrmUniqueIdentifier": "string",
"awsSaasProductDimensions": [
{
"Description": "string",
"Key": "string",
"Name": "string",
"Rate": 0,
"Types": [
"string"
],
"Unit": "string"
}
],
"baseAgreementId": "string",
"buyerIds": [
"string"
],
"contacts": [
{
"company": "string",
"email": "string",
"name": "string"
}
],
"cppoInOfferId": "string",
"cppoOfferId": "string",
"cppoOutOfferId": "string",
"customMetaInfo": {},
"enableTestUsageMetering": true,
"entitlementCancellationSchedule": {
"cancelDate": "string",
"creationDate": "string",
"note": "string",
"type": "EndOfTerm"
},
"errorMessages": [
"string"
],
"hubspotDealId": "string",
"internalNote": "string",
"isAgreementBasedOffer": true,
"isGrossRevenueFullSync": true,
"isRenewalOffer": true,
"isReplacementOffer": true,
"lastModifiedBy": {
"email": "string",
"entityId": "string",
"entityType": "",
"name": "string"
},
"notifications": [
{
"action": "",
"ccContactIds": [
"string"
],
"channels": [
"EMAIL"
],
"contactEmails": [
"string"
],
"contactIds": [
"string"
],
"createdBy": {
"email": "string",
"entityId": "string",
"entityType": "",
"name": "string"
},
"customFields": {},
"entityID": "string",
"entityName": "string",
"entityStatus": "string",
"entityType": "",
"eventID": "string",
"eventStatus": "",
"isActionItem": true,
"lastUpdateTime": "2024-08-12T01:02:15.204Z",
"message": "string",
"organizationID": "string",
"partner": "",
"priority": "",
"requireAudit": true,
"timestamp": "2024-08-12T01:02:15.204Z",
"title": "string",
"trackEvents": [
{
"action": "OPEN_EMAIL",
"contactId": "string",
"timestamp": "2024-08-12T01:02:15.204Z"
}
]
}
],
"offerAcceptDate": "2024-08-12T01:02:15.204Z",
"renewalOfferType": "",
"replacedOfferEndTime": "2024-08-12T01:02:15.204Z",
"replacedOfferResourceName": "string",
"salesforceEntitlementURL": "string",
"salesforceOpportunityId": "string",
"testUsageMeteringEndTime": "2024-08-12T01:02:15.204Z",
"updateMessage": "string"
},
"name": "string",
"organizationID": "string",
"partner": "",
"productType": "UNKNOWN",
"service": "DEFAULT",
"status": "string"
}
Bad request error
- application/json
- Schema
Schema
string
Internal server error
- application/json
- Schema
Schema
string