get offer by external ID
GET/org/:orgId/offerExternalId/:offerExternalId
Get the offer by the given offer external ID.
Request
Path Parameters
Organization ID
Offer External ID
Responses
- 200
- 400
- 404
- 405
- 500
the Offer Object
- 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 [
]
]
nullable
nullable
info
object
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.
Possible values: [``, SCMP, ECMP, RCMP, CUSTOM, ISV, CURRENT]
Is this offer Auto Renew enabled.
Aws private subscription offer Usage duration. ISO8601 format. P300D means the contract Usage start date At acceptance, and with duration 300 days.
awsChannelPartner
object
The AWS Account ID of the Channel Partner
The name of the Channel Partner
awsCppoEventDetail
object
manufacturer
object
The seller/ISV's AWS Account Id.
offer
object
product
object
sellerOfRecord
object
For private offer created by a channel partner, this is the channel partner's AWS Account Id. For private offer created by a seller/ISV, this is the seller/ISV's AWS Account Id.
awsCppoOpportunity
object
Dimensions
object[]
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.
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.
Possible values: [DAY, MONTH, YEAR]
OfferDetails
object
PreExistingBuyerAgreement
object
Possible values: [``, External, AwsMarketplace]
Indicates if the existing agreement was signed outside AWS Marketplace or within AWS Marketplace. one of values ["External", "AwsMarketplace"]
Possible values: [Contract, Usage, Byol, Free, Unknown]
Indicates which pricing model the existing agreement uses.
Rules
object[]
Output only.
NegativeTargeting
object
Negative targeting defines the criteria which any customer's profile should fulfill to be restricted to access the offer.
PositiveTargeting
object
Positive targeting defines the criteria which any buyer's profile should fulfill in order to be allowed to access the offer.
BuyerAccounts
object[]
List of AWS account IDs that are allowed to subscribe to the offer.
List as option for allowing targeting based on country. If the intention isn’t to target the offer to a country, this field should be omitted. If it’s present, the list must contain at least one country code. Each element in this list should be a valid 2-letter country code, using this format: ISO 3166-1 alpha-2.
Possible values: [AvailabilityRule, PartnerTargetingRule, TargetingRule, TaxConfigurationRule]
Possible values: [Active, Restricted, Complete]
Terms
object[]
Documents
object[]
Possible values: [CustomEula, CustomDsa, StandardEula, StandardDsa, StandardResellerContract, CustomResellerContract]
A URL to the legal document for buyers to read. Required when Type is one of the following [CustomEula, CustomDsa].
Version of standard contracts provided by AWS Marketplace. Required when Type is one of the following [StandardEula, StandardDsa]. The version of StandardEula is "2022-07-14". The version of StandardDsa is "2019-12-12".
ISO 8601 duration format. For example, "P12M" represents 12 months.
Grants
object[]
PositiveTargeting
object
BuyerAccounts
object[]
List of AWS account IDs that are allowed to subscribe to the offer.
List as option for allowing targeting based on country. If the intention isn’t to target the offer to a country, this field should be omitted. If it’s present, the list must contain at least one country code. Each element in this list should be a valid 2-letter country code, using this format: ISO 3166-1 alpha-2.
For ResaleFixedUpfrontPricingTerm
RateCards
object[]
Constraints
object
Defines constraints on how the term can be configured by acceptors. Applicable only to ConfigurableUpfrontPricingTerm.
Determines if buyers are allowed to select multiple dimensions in the rate card. Possible values are "Allowed" and "Disallowed". Default value is "Allowed".
Determines if acceptors are allowed to configure quantity for each dimension in rate card. Possible values are "Allowed" and "Disallowed". Default value is "Allowed".
RateCard
object[]
These fields are used for aws discovery API result.
Selector
object
Selector is used to differentiate between the mutually exclusive rate cards in the same pricing term, to be selected by the buyer. Applicable only to ConfigurableUpfrontPricingTerm.
At this time, only "Duration" is supported.
ISO 8601 duration format. For example, "P1M" represents one month.
Schedule
object[]
For ResalePaymentScheduleTerm
Possible values: [BuyerTargetingTerm, UpdateAvailability, BuyerValidityTerm, BuyerLegalTerm, ResaleLegalTerm, ResaleUsageBasedPricingTerm, ResaleConfigurableUpfrontPricingTerm, ResaleFixedUpfrontPricingTerm, ResalePaymentScheduleTerm]
Possible values: [DISCOUNT_PERCENT, CUSTOM_PRICE, CUSTOM_PRICE_WITH_FPS]
The following fields are not from aws catalog API, only used for cppo_out offer create. They shouldn't be read in other places because they will absent when fetch opportunity from aws catalog API.
Possible values: [SPECIFIC_DATES, ONE_TIME, NO_SET_TIME]
AWS private reseller offer using markup percentage. 10.0 represent 10% partner margin.
AWS ResaleAuthorizationId(CPPO_IN offer id) for CPPO offers of the reseller.
azureOriginalPlan
object
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
Possible values: [``, editExistingOfferPricingOnly, saasNewCustomizedPlans, vmSoftwareReservations]
default "editExistingOfferPricingOnly"
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
PriceAndAvailability audience definition
Prices interface{} json:"prices,omitempty"
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]
Possible values: [visible, hidden]
default "visible"
azurePrivateOffer
object
in format YYYY-MM-DD
acceptanceLinks
object[]
The Customer Billing Account ID.
beneficiaries
object[]
beneficiaryRecipients
object[]
Possible values: [cspCustomer, billingGroup]
the customer billing account id.
in format YYYY-MM-DD
in format of "private-offer/private-offer-durable-id"
in format YYYY-MM-DD
array of email addresses of the users to be notified of any changes in the private offer status.
Possible values: [``, editExistingOfferPricingOnly, saasNewCustomizedPlans, vmSoftwareReservations]
partners
object[]
pricing
object[]
Up to 10 pricing entries are allowed.
required for SaasNewCustomizedPlans
between 0.01 to 100
Possible values: [absolute, percentage]
between 0.00000001 to 100
newPlanDetails
object
required for SaasNewCustomizedPlans
originalPlan
object
the pricing plan of the original plan.
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
Possible values: [``, editExistingOfferPricingOnly, saasNewCustomizedPlans, vmSoftwareReservations]
default "editExistingOfferPricingOnly"
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
PriceAndAvailability audience definition
Prices interface{} json:"prices,omitempty"
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]
Possible values: [visible, hidden]
default "visible"
The base/original/default plan of the private offer, in format of "plan/product-durable-id/plan-durable-id"
Possible values: [FLAT_RATE, PER_USER]
The type of the plan, FLAT_RATE or PER_USER.
privateOfferPlan
object
the pricing plan of the private offer
Possible values: [notAvailable, neverUsed, test, preview, generallyAvailable, deprecated, decommissioned, deleted]
Possible values: [``, editExistingOfferPricingOnly, saasNewCustomizedPlans, vmSoftwareReservations]
default "editExistingOfferPricingOnly"
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
PriceAndAvailability audience definition
Prices interface{} json:"prices,omitempty"
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]
Possible values: [visible, hidden]
default "visible"
in format of "product/product-durable-id"
Possible values: [``, customerPromotion, cspPromotion, multipartyPromotionChannelPartner, multipartyPromotionOriginator]
in format YYYY-MM-DD, if VariableStartDate = true, this field should be empty.
Possible values: [draft, live, deleted, withdrawn]
Possible values: [accepted, pendingAcceptance]
Only applicable to private offers with privateOfferType = customerPromotion || cspPromotion
termsAndConditionsDocs
object[]
Only applicable to private offers with privateOfferType = multipartyPromotionOriginator || multipartyPromotionChannelPartner
upgradedFrom
object
validations
object[]
Possible values: [businessValidationError, collectionLimitExceeded, invalidId, invalidEntityStatus, invalidRequest, invalidResource, invalidState, notDeployed, notSupported, operationCanceled, productLocked, resourceNotFound, schemaValidationError]
Possible values: [informational, warning]
azureProductVariant
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]
billableDimensions
object[]
Usage based metering dimensions based on Billable Metrics, managed by Suger only.
The ID for the billable metric.
Possible values: [basic, tiered, bulk, volume, percentage, tiered-percentage, matrix]
Description of the dimension. This is used in the UI to display the dimension.
discount
object
Possible values: [PERCENTAGE, ABSOLUTE]
The term length for the commit amount. Applicable to Direct only.
The minimum commit amount. Applicable to Direct only. Ignored if the value is 0 or less.
If the minimum commit is appled with pro-rata. Applicable to Direct only. If true, the minimum commit amount will be prorated based on the usage period (starting time and ending time).
Possible values: [``, DIMENSION, DIMENSION_GROUP_BY]
Display name of the dimension. This is used in the UI to display the dimension.
priceModelBasic
object
priceModelBulk
object
A currency amount to rate usage by
An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating
priceModelMatrix
object
matrix
object[]
The matrix of the pricing model
properties
object[]
priceModelPercentage
object
Basis point take rate per event
priceModelTiered
object
tiers
object[]
Inclusive tier starting value
Exclusive tier ending value. If null, this is treated as the last tier
Amount per unit
priceModelTieredPercentage
object
tiers
object[]
Inclusive tier starting value
Exclusive tier ending value. If null, this is treated as the last tier
priceModelVolume
object
tiers
object[]
Upper bound for this tier
Amount per unit
Possible values: [DAY, MONTH, YEAR]
Possible values: [MONTH_FIRST_DAY, ENTITLEMENT_START_DATE]
The buyers' AWS Account IDs of this offer.
buyerAzureTenants
object[]
The buyers' Azure tenants of this offer.
The amount that the buyer has committed to pay, before discount if applicable. It can be monthly commitment or total commitment. For frontend display or analysis purposes, not used for billing.
Billing interval in months for commitDimensions
commits
object[]
Recurring flat fee for the offer, managed by cloud marketplaces or Suger.
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[]
Usage based metering dimensions defined on cloud marketplaces, managed by Cloud marketplaces only.
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]
The discount percentage off the original price. For example, 20 means 20% off. 0 means no discount. It can be discount off the commitment amount or discount off the usage price.
Possible values: [``, SCMP, ECMP, RCMP, CUSTOM, ISV, CURRENT]
gcpCustomerInfo
object
The address of the customer
The contact name of the customer
The email address of the customer
The company name of the customer
The GCP billing account ID of the customer
The duration of the offer in months. Only required when creating GCP Marketplace private offer.
gcpMetrics
object[]
Only applicable for GCP Marketplace Offers (the default or private offer)
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]
Possible values: [``, PREPAY, POSTPAY]
gcpPlans
object[]
Only applicable for GCP Marketplace
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"
gcpPrivateOffer
object
activeEntitlement
object
The resource name of the account that this entitlement is based on, if any, in format ""providers/{provider_id}/accounts/{account_id}"
consumers
object[]
The resources using this entitlement, if applicable.
The project name with format projects/.
Entitlement Id generated by GCP Marketplace. For Marketplace pub/sub event.
The custom properties that were collected from the user to create this entitlement.
Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
The resource name of the entitlement. Entitlement names have the form of
providers/{provider_id}/entitlements/{entitlement_id}.
in ISO 8601 duration format, such as "P2Y3M". For Marketplace pub/sub event.
Output only. The end time of the new offer. Field is empty if the pending plan change is not moving to an offer. If the offer was created with a term instead of a specified end date, this field is empty.
Output only. The start time of the new offer. Field is empty if the pending plan change is not moving to an offer.
The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
The offer duration of the new offer in ISO 8601 duration format. Field is empty if the pending plan change is not moving to an offer since the entitlement is not pending, only the plan change is pending.
The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
When the buyer changes plan, For Marketplace pub/sub event.
The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer, such as "P1Y", "P2M"
When the offer is effective.
Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.
The identifier of the plan that was procured. Required if the product has plans.
The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. For Private offer, "projects/project-id/services/product-id.endpoints.partner-id.cloud.goog/privateOffers/private-offer-id"
The identifier of the product that was procured.
The ID of the service provider under Cloud Commerce platform that this entitlement was created against.
The identifier of the quote that was used to procure, such as the private offer Id. Empty if the order is not purchased using a quote.
Possible values: [ENTITLEMENT_STATE_UNSPECIFIED, ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_CANCELLED, ENTITLEMENT_PENDING_PLAN_CHANGE, ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, ENTITLEMENT_SUSPENDED]
Enums of the Entitlement State. https://cloud.google.com/marketplace/docs/partners/commerce-procurement-api/reference/rest/v1/providers.entitlements#EntitlementState
The End time for the subscription corresponding to this entitlement.
The last update timestamp. It is the endTime for the cancelled entitlement.
The consumerId to use when reporting usage through the Service Control API. See the consumerId field at Reporting Metrics (https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.
The resource name of agreement(entitlement) In format of "projects/{projectNumber}/agreements/{agreementId}"
customEula
object
such as "PARTNER_EULA"
externalGoogleLink
object
The external link to Standard EULA such as https://cloud.google.com/terms/marketplace/eula-standard-v2-01272021.
in format of "projects/{projectNumber}/agreements/{agreementId}/documents/{documentId}"
unstructuredDocument
object
customerInfo
object
The address of the customer
The contact name of the customer
The email address of the customer
The company name of the customer
The GCP billing account ID of the customer
eulaAgreementDocument
object
such as "PARTNER_EULA"
externalGoogleLink
object
The external link to Standard EULA such as https://cloud.google.com/terms/marketplace/eula-standard-v2-01272021.
in format of "projects/{projectNumber}/agreements/{agreementId}/documents/{documentId}"
unstructuredDocument
object
existingOfferData
object
entitlement
object
The resource name of the account that this entitlement is based on, if any, in format ""providers/{provider_id}/accounts/{account_id}"
consumers
object[]
The resources using this entitlement, if applicable.
The project name with format projects/.
Entitlement Id generated by GCP Marketplace. For Marketplace pub/sub event.
The custom properties that were collected from the user to create this entitlement.
Provider-supplied message that is displayed to the end user. Currently this is used to communicate progress and ETA for provisioning. This field can be updated only when a user is waiting for an action from the provider, i.e. entitlement state is EntitlementState.ENTITLEMENT_ACTIVATION_REQUESTED or EntitlementState.ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL. This field is cleared automatically when the entitlement state changes.
The resource name of the entitlement. Entitlement names have the form of
providers/{provider_id}/entitlements/{entitlement_id}.
in ISO 8601 duration format, such as "P2Y3M". For Marketplace pub/sub event.
Output only. The end time of the new offer. Field is empty if the pending plan change is not moving to an offer. If the offer was created with a term instead of a specified end date, this field is empty.
Output only. The start time of the new offer. Field is empty if the pending plan change is not moving to an offer.
The name of the offer the entitlement is switching to upon a pending plan change. Only exists if the pending plan change is moving to an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
The offer duration of the new offer in ISO 8601 duration format. Field is empty if the pending plan change is not moving to an offer since the entitlement is not pending, only the plan change is pending.
The identifier of the pending new plan. Required if the product has plans and the entitlement has a pending plan change.
When the buyer changes plan, For Marketplace pub/sub event.
The name of the offer that was procured. Field is empty if order was not made using an offer. Format: 'projects/{project}/services/{service}/privateOffers/{offer-id}' OR 'projects/{project}/services/{service}/standardOffers/{offer-id}', depending on whether the offer is private or public.
The offer duration of the current offer in ISO 8601 duration format. Field is empty if entitlement was not made using an offer, such as "P1Y", "P2M"
When the offer is effective.
Output only. End time for the Offer association corresponding to this entitlement. The field is only populated if the entitlement is currently associated with an Offer.
The identifier of the plan that was procured. Required if the product has plans.
The identifier of the entity that was purchased. This may actually represent a product, quote, or offer. For Private offer, "projects/project-id/services/product-id.endpoints.partner-id.cloud.goog/privateOffers/private-offer-id"
The identifier of the product that was procured.
The ID of the service provider under Cloud Commerce platform that this entitlement was created against.
The identifier of the quote that was used to procure, such as the private offer Id. Empty if the order is not purchased using a quote.
Possible values: [ENTITLEMENT_STATE_UNSPECIFIED, ENTITLEMENT_ACTIVATION_REQUESTED, ENTITLEMENT_ACTIVE, ENTITLEMENT_PENDING_CANCELLATION, ENTITLEMENT_CANCELLED, ENTITLEMENT_PENDING_PLAN_CHANGE, ENTITLEMENT_PENDING_PLAN_CHANGE_APPROVAL, ENTITLEMENT_SUSPENDED]
Enums of the Entitlement State. https://cloud.google.com/marketplace/docs/partners/commerce-procurement-api/reference/rest/v1/providers.entitlements#EntitlementState
The End time for the subscription corresponding to this entitlement.
The last update timestamp. It is the endTime for the cancelled entitlement.
The consumerId to use when reporting usage through the Service Control API. See the consumerId field at Reporting Metrics (https://cloud.google.com/service-control/reporting-metrics) for more details. This field is present only if the product has usage-based billing configured.
Possible values: [``, PRICE_MODEL_TYPE_UNSPECIFIED, CUD, FIXED_FEE, FIXED_FEE_WITH_OVERAGE, PAYG, PAYG_WITH_CUD]
privateOffer
object
customEula
object
such as "PARTNER_EULA"
externalGoogleLink
object
The external link to Standard EULA such as https://cloud.google.com/terms/marketplace/eula-standard-v2-01272021.
in format of "projects/{projectNumber}/agreements/{agreementId}/documents/{documentId}"
unstructuredDocument
object
installmentTimeline
object
installments
object[]
priceModel
object
in format of "projects/{projectNumber}/services/service-name.endpoints.gcp-project-id.cloud.goog/standardOffers/base-offer-id"
commitment
object
commitmentAmountPerPeriod
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
fixedPrice
object
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
oneTimeCredit
object
The one time credit in amount of money
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
overage
object
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
TODO: need to define the type
payg
object
Pay as you go.
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
TODO: need to define the type
such as "PREVIOUS_CREDIT_BALANCE_POLICY_UNSPECIFIED"
GCP private offer resource name.
offerTerm
object
Possible values: [``, OFFER_START_POLICY_IMMEDIATE, OFFER_START_POLICY_SCHEDULED]
termDuration
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
Possible values: [``, PREPAY, POSTPAY]
priceModel
object
Nill if the offer has payment installments.
in format of "projects/{projectNumber}/services/service-name.endpoints.gcp-project-id.cloud.goog/standardOffers/base-offer-id"
commitment
object
commitmentAmountPerPeriod
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
fixedPrice
object
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
oneTimeCredit
object
The one time credit in amount of money
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
overage
object
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
TODO: need to define the type
payg
object
Pay as you go.
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
TODO: need to define the type
such as "PREVIOUS_CREDIT_BALANCE_POLICY_UNSPECIFIED"
The Plan of the offer.
features
object[]
such as "CPU per VM"
such as "cpu"
such as "CPU"
such as "2 CPU per VM"
installmentTimeline
object
installments
object[]
priceModel
object
in format of "projects/{projectNumber}/services/service-name.endpoints.gcp-project-id.cloud.goog/standardOffers/base-offer-id"
commitment
object
commitmentAmountPerPeriod
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
fixedPrice
object
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
oneTimeCredit
object
The one time credit in amount of money
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
overage
object
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
TODO: need to define the type
payg
object
Pay as you go.
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
TODO: need to define the type
such as "PREVIOUS_CREDIT_BALANCE_POLICY_UNSPECIFIED"
such as "PUBLISHED"
metricInformation
object
metricDetails
object[]
such as "CPU"
in format of "projects/{projectNumber}/services/service-name.endpoints.gcp-project-id.cloud.goog"
such as "BC1B-6259-BF57"
tiers
object[]
Price tiers for this metric.
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 "minute"
migrationMetadata
object
Plan name maybe with term suffix, such as "plan-name-P1Y"
in format of "product-service-id.endpoints.gcp-project-id.cloud.goog"
The GCP project number of the provider.
The GCP project ID of the provider.
In format of "projects/{projectNumber}/services/{serviceName, such as service-name.endpoints.gcp-project-id.cloud.goog}/privateOffers/{privateOfferId}"
GCP private offer ID
Possible values: [OFFER, RESOLD]
such as "OFFER" or "RESOLD" (resold via channel partner)
Possible values: [OFFER_ACTIVE, OFFER_ACTIVATING, OFFER_SCHEDULED, OFFER_ENTITLEMENT_ACCOUNT_PENDING, OFFER_PUBLISHED, OFFER_LAPSED, OFFER_EXPIRED, OFFER_CANCELLED, OFFER_UNAVAILABLE, OFFER_DRAFT]
offerTerm
object
Possible values: [``, OFFER_START_POLICY_IMMEDIATE, OFFER_START_POLICY_SCHEDULED]
termDuration
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
The offer title in the GCP Marketplace.
Possible values: [``, PREPAY, POSTPAY]
such as "PREPAY" or "POSTPAY"
policies
object
priceModel
object
Nill if the offer has payment installments.
in format of "projects/{projectNumber}/services/service-name.endpoints.gcp-project-id.cloud.goog/standardOffers/base-offer-id"
commitment
object
commitmentAmountPerPeriod
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
fixedPrice
object
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
oneTimeCredit
object
The one time credit in amount of money
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
overage
object
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
TODO: need to define the type
payg
object
Pay as you go.
discount
object
discountPercentage
object
such as {"units": "0", "nanos": 0} as no discount, or {"units": "10", "nanos": 0} as 10% off discount
discountedPrice
object
The discounted price of the private offer. If the discount is 10% off, and the original price is $100, then the discounted price is $90.
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
TODO: need to define the type
such as "PREVIOUS_CREDIT_BALANCE_POLICY_UNSPECIFIED"
Possible values: [``, PRICE_MODEL_TYPE_UNSPECIFIED, CUD, FIXED_FEE, FIXED_FEE_WITH_OVERAGE, PAYG, PAYG_WITH_CUD]
providerInfo
object
The email address of who create the private offer in the provider.
The sales contact email of the provider.
The sales contact name of the provider.
purchaseChannel
object
replacementMetadata
object
The resource name of the private offer being replaced. in format of "projects/{projectNumber}/services/{productServiceName}/privateOffers/{privateOfferId}"
resellerInfo
object
The info of the reseller who resold the offer and when OfferSource is "RESOLD".
The Plan of the offer.
gcpProviderInfo
object
The email address of who create the private offer in the provider.
The sales contact email of the provider.
The sales contact name of the provider.
Optional when creating GCP Marketplace private offer. The internal note for the seller/ISV. It is only visible to the seller/ISV.
Optional when creating GCP Marketplace private offer. By default, it is the same as offer name. The public note for the buyer. It is visible to the buyer.
gcpResellerPrivateOfferPlan
object
The resource name of agreement(entitlement) In format of "projects/{projectNumber}/agreements/{agreementId}"
agreementDocuments
object
isvToCustomerAgreementDocument
object
such as "PARTNER_EULA"
externalGoogleLink
object
in format of "projects/{projectNumber}/agreements/{agreementId}/documents/{documentId}"
unstructuredDocument
object
isvToResellerAgreementDocument
object
such as "PARTNER_EULA"
externalGoogleLink
object
in format of "projects/{projectNumber}/agreements/{agreementId}/documents/{documentId}"
unstructuredDocument
object
durationConfig
object
features
object[]
such as "CPU per VM"
such as "cpu"
such as "CPU"
such as "2 CPU per VM"
installmentTimelineTemplate
object
installmentTemplates
object[]
priceModelTemplate
object
in format of "projects/{projectNumber}/services/service-name.endpoints.gcp-project-id.cloud.goog/standardOffers/base-offer-id"
commitment
object
commitmentAmountPerPeriodTemplate
object
decimalAmountConstraint
object
defaultAmount
object
maxAmount
object
minAmount
object
discountTemplate
object
discountPercentage
object
defaultAmount
object
maxAmount
object
minAmount
object
discountedPrice
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
Possible values: [overage, payg]
fixedPrice
object
discountTemplate
object
discountPercentage
object
defaultAmount
object
maxAmount
object
minAmount
object
discountedPrice
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
overage
object
discountTemplate
object
discountPercentage
object
defaultAmount
object
maxAmount
object
minAmount
object
discountedPrice
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
skuRepresentation
object
skuList
object
payg
object
discountTemplate
object
discountPercentage
object
defaultAmount
object
maxAmount
object
minAmount
object
discountedPrice
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
skuRepresentation
object
skuList
object
Possible values: [fixedPrice, commitment]
isvInfo
object
margin
object
marginPercentage
object
The percentage value of the margin in the range of 0 to 100.
metaInfo
object
Gcp Organiztion ID from integration with GCP Marketplace.
Gcp Project Number from integration with GCP Marketplace.
In format of "projects/{projectNumber}/partnerAccounts/{partnerAccountId}/resellerPrivateOfferPlans/{resellerPrivateOfferPlanId}"
offerTemplatePolicies
object
such as "3"
Possible values: [PRORATION_UNSPECIFIED, NOT_PRORATED_ANNIVERSARY_DATES, PRORATED]
offerTermTemplate
object
Possible values: [``, OFFER_START_POLICY_IMMEDIATE, OFFER_START_POLICY_SCHEDULED]
termDuration
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
termDurationConstraint
object
defaultDuration
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
Possible values: [``, PREPAY, POSTPAY]
priceModelTemplate
object
in format of "projects/{projectNumber}/services/service-name.endpoints.gcp-project-id.cloud.goog/standardOffers/base-offer-id"
commitment
object
commitmentAmountPerPeriodTemplate
object
decimalAmountConstraint
object
defaultAmount
object
maxAmount
object
minAmount
object
discountTemplate
object
discountPercentage
object
defaultAmount
object
maxAmount
object
minAmount
object
discountedPrice
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
Possible values: [overage, payg]
fixedPrice
object
discountTemplate
object
discountPercentage
object
defaultAmount
object
maxAmount
object
minAmount
object
discountedPrice
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
overage
object
discountTemplate
object
discountPercentage
object
defaultAmount
object
maxAmount
object
minAmount
object
discountedPrice
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
skuRepresentation
object
skuList
object
payg
object
discountTemplate
object
discountPercentage
object
defaultAmount
object
maxAmount
object
minAmount
object
discountedPrice
object
such as "USD"
for the decimal part, such as 30000000 = $0.03
for the integer part, such as "500000" = $50K
period
object
such as 1, 6, 12
Possible values: [MONTHLY_PERIOD, YEARLY_PERIOD]
skuRepresentation
object
skuList
object
Possible values: [fixedPrice, commitment]
productInfo
object
The service level (price plan) with time duration suffix, such as "basic-plan-P1Y"
The price plan, such as "basic-plan"
in format of "resellOfferTemplates/{resellOfferTemplateId}"
resellerInfo
object
Possible values: [``, REUSE_POLICY_SINGLE_USE, REUSE_POLICY_MULTI_USE]
Possible values: [``, START_POLICY_ON_ACCEPTANCE, START_POLICY_SCHEDULED]
state
object
Possible values: [``, STATE_TYPE_DRAFT, STATE_TYPE_READY_TO_ACCEPT, STATE_TYPE_READY_TO_USE, STATE_TYPE_USED, STATE_TYPE_CANCELED, STATE_TYPE_EXPIRED_NEVER_ACCEPTED, STATE_TYPE_EXPIRED_ACCEPTED]
stateTransitions
object[]
newState
object
Possible values: [``, STATE_TYPE_DRAFT, STATE_TYPE_READY_TO_ACCEPT, STATE_TYPE_READY_TO_USE, STATE_TYPE_USED, STATE_TYPE_CANCELED, STATE_TYPE_EXPIRED_NEVER_ACCEPTED, STATE_TYPE_EXPIRED_ACCEPTED]
Possible values: [``, CUD_LIST_PRICE, CUD_ALL_USAGE_DISCOUNTED, USAGE_DISCOUNT_ONLY]
The grace period in days for the offer. This is the number of days during which invoices remain in draft status, for reviewing. This filed can be overridden at the entitlement level.
The net terms in days for the offer. This is the number of days the buyer has to pay the invoice. This filed can be overridden at the entitlement level.
paymentInstallments
object[]
For flexible payment schedule, managed by cloud marketplaces or Suger.
The amount the buyer has paid for this installment. If there is a discount off the original price, the amount is the discounted price.
When the buyer will be charged for this installment. If it is null, the buyer will be charged on the effective date of the entitlement.
The charge on date in string format. It is used for front-end display only.
Used in GCP Marketplace private offer as one-time credit. Default as zero if there is no credit.
The discount percentage off the original price. For GCP Marketplace, it can be discount off the commitment amount or discount off the usage price. The value is between 0 to 100. For example, 20 means 20% off. Default as zero if there is no discount.
The original amount before discount if there is a discount off the original price. nil if there is no discount.
Possible values: [``, PREPAY, POSTPAY]
The URL of the private offer sent to buyers to accept. Only applicable for private offer.
Prorated billing for the offer. If true, the billing is prorated based on the start date and end date. If false, the billing is not prorated. This filed can be overridden at the entitlement level.
Possible values: [``, SCMP, ECMP, RCMP, CUSTOM, ISV, CURRENT]
Possible values: [``, SCMP, ECMP, RCMP, CUSTOM, ISV, CURRENT]
Optional when creating AWS or GCP Marketplace private offer on the contract product. The future start time of the offer if it is not started on the acceptance.
Tax ids for the offer, used to calculate the tax amount for the offer. This field can be overridden at the entitlement level.
trialConfig
object
Possible values: [DAY, MONTH, YEAR]
Billing interval in months for billableDimensions
Possible values: [PRIVATE, PUBLIC]
The default visibility of offer is PRIVATE.
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.
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.
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.
Possible values: [DAY, MONTH, YEAR]
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, MERGE, METER, NEW_CLIENT_SIGNUP, NOTIFY, NOTIFY_CONTACTS, OPEN_EMAIL, PENDING_CANCEL, PENDING_ACCEPTANCE, REINSTATE, REJECT, REOPEN, CHARGE, REFUND, ISSUE, ROTATE_SECRET, SUSPEND, TEST, UPDATE, ACE_ENGAGEMENT_SCORE_UPDATE, ACE_SALES_REP_UPDATE, SUBMIT_APPROVAL_REQUEST, REVIEW_APPROVAL_REQUEST]
Cc contactIds that will receive this notification
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"]
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, INTUIT, 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: [UNKNOWN, AMI, CONTAINER, CONTRACT, CPPO_OUT, CPPO_IN, CPPO, CUD, DEFAULT, FIXED_FEE, FIXED_FEE_WITH_OVERAGE, FLAT_RATE, FREE_TRIAL, PAYG, PAYG_WITH_CUD, PER_USER, PRIVATE, PROFESSIONAL_SERVICES, SUBSCRIPTION]
Possible values: [``, ADYEN, ALIBABA, AWS, AWS_CHINA, AZURE, GCP, GOOGLE, HUBSPOT, INTUIT, LAGO, MARKETO, METRONOME, MICROSOFT, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, STRIPE, ZOHO]
Possible values: [DEFAULT, MARKETPLACE, ACE, COSELL, CRM, CPQ, CHATBOT, BILLING, BIGQUERY, DRIVE, EMAIL, STORAGE, PAYMENT, TEAMS, QUICKBOOKS]
Possible values: [``, INVALID, ACCEPTED, ACTIVE, CANCEL_FAILED, CANCEL_SUCCESS, CANCELLED, CREATE_FAILED, CREATE_SUCCESS, DELETED, DEPRECATED, DRAFT, EXPIRED, PENDING_ACCEPTANCE, PENDING_CANCEL, PENDING_CREATE, PENDING_UPDATE, PREVIEW, RESTRICTED, TEST, UPDATE_FAILED, UPDATE_SUCCESS, USED]
{
"buyerID": "string",
"contactIds": [
"string"
],
"createdBy": "string",
"creationTime": "2024-07-29T15:51:28.071Z",
"endTime": "2024-07-29T15:51:28.071Z",
"expireTime": "2024-07-29T15:51:28.071Z",
"externalID": "string",
"id": "string",
"info": {
"additionalEulaUrls": [
"string"
],
"attachEulaType": "",
"autoRenew": true,
"awsAgreementDuration": "string",
"awsChannelPartner": {
"id": "string",
"name": "string"
},
"awsCppoEventDetail": {
"catalog": "string",
"eventCategory": "string",
"eventID": "string",
"eventName": "string",
"eventSource": "string",
"eventType": "string",
"eventVersion": "string",
"managementEvent": true,
"manufacturer": {
"accountId": "string",
"name": "string"
},
"offer": {
"arn": "string",
"expirationDate": "2024-07-29T15:51:28.071Z",
"id": "string",
"name": "string"
},
"product": {
"arn": "string",
"id": "string",
"title": "string"
},
"requestID": "string",
"requestParameters": {},
"responseElements": {},
"sellerOfRecord": {
"accountId": "string",
"name": "string"
},
"targetedBuyerAccountIds": [
"string"
]
},
"awsCppoOpportunity": {
"CreatedDate": "string",
"Description": "string",
"Dimensions": [
{
"Description": "string",
"Key": "string",
"Length": 0,
"Name": "string",
"Rate": 0,
"TimeUnit": "DAY",
"Types": [
"string"
],
"Unit": "string"
}
],
"ManufacturerAccountId": "string",
"ManufacturerLegalName": "string",
"Name": "string",
"OfferDetails": {
"OfferCreatedCount": 0,
"OfferExtendedStatus": "string"
},
"PreExistingBuyerAgreement": {
"AcquisitionChannel": "",
"PricingModel": "Contract"
},
"ProductId": "string",
"ProductName": "string",
"Rules": [
{
"AvailabilityEndDate": "string",
"Id": "string",
"NegativeTargeting": {
"CountryCodes": [
"string"
]
},
"OffersMaxQuantity": 0,
"PositiveTargeting": {
"BuyerAccounts": [
{
"AwsAccountId": "string"
}
],
"CountryCodes": [
"string"
]
},
"ResellerAccountId": "string",
"ResellerLegalName": "string",
"Type": "AvailabilityRule",
"Usage": "string"
}
],
"Status": "Active",
"Terms": [
{
"CurrencyCode": "string",
"Documents": [
{
"Type": "CustomEula",
"Url": "string",
"Version": "string"
}
],
"Duration": "string",
"Grants": [
{
"DimensionKey": "string",
"MaxQuantity": 0
}
],
"Id": "string",
"MaximumAgreementStartDate": "string",
"PositiveTargeting": {
"BuyerAccounts": [
{
"AwsAccountId": "string"
}
],
"CountryCodes": [
"string"
]
},
"Price": "string",
"RateCards": [
{
"Constraints": {
"MultipleDimensionSelection": "string",
"QuantityConfiguration": "string"
},
"RateCard": [
{
"Description": "string",
"DimensionKey": "string",
"DisplayName": "string",
"Price": "string",
"Quantity": "string",
"Unit": "string"
}
],
"Selector": {
"Type": "string",
"Value": "string"
}
}
],
"Schedule": [
{
"ChargeAmount": "string",
"ChargeDate": "2024-07-29T15:51:28.071Z"
}
],
"Type": "BuyerTargetingTerm"
}
],
"discountType": "DISCOUNT_PERCENT",
"opportunityDurationType": "SPECIFIC_DATES",
"opportunityId": "string",
"partnerId": "string"
},
"awsMarkupPercentage": 0,
"awsResaleAuthorizationId": "string",
"azureOriginalPlan": {
"$schema": "string",
"id": "string",
"lifecycleState": "notAvailable",
"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
}
]
}
],
"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"
}
],
"visibility": "visible"
},
"azurePrivateOffer": {
"$schema": "string",
"acceptBy": "2024-07-29T15:51:28.071Z",
"acceptanceLinks": [
{
"beneficiaryId": "string",
"link": "string"
}
],
"beneficiaries": [
{
"beneficiaryRecipients": [
{
"id": "string",
"recipientType": "cspCustomer"
}
],
"description": "string",
"id": "string"
}
],
"eTag": "string",
"end": "2024-07-29T15:51:28.071Z",
"id": "string",
"lastModified": "2024-07-29T15:51:28.071Z",
"name": "string",
"notificationContacts": [
"string"
],
"offerPricingType": "",
"partners": [
{
"id": "string",
"location": "string",
"partnerName": "string"
}
],
"preparedBy": "string",
"pricing": [
{
"basePlan": "string",
"discountPercentage": 0,
"discountType": "absolute",
"markupPercentage": 0,
"newPlanDetails": {
"description": "string",
"id": "string",
"name": "string"
},
"originalPlan": {
"$schema": "string",
"id": "string",
"lifecycleState": "notAvailable",
"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
}
]
}
],
"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"
}
],
"visibility": "visible"
},
"plan": "string",
"planId": "string",
"planName": "string",
"planType": "FLAT_RATE",
"priceDetails": {},
"privateOfferPlan": {
"$schema": "string",
"id": "string",
"lifecycleState": "notAvailable",
"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
}
]
}
],
"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"
}
],
"visibility": "visible"
},
"product": "string",
"productName": "string",
"sugerOfferId": "string"
}
],
"privateOfferType": "",
"resourceName": "string",
"start": "2024-07-29T15:51:28.071Z",
"state": "draft",
"subState": "accepted",
"termsAndConditionsDocSasUrl": "string",
"termsAndConditionsDocs": [
{
"customerFacingDocumentName": "string",
"fileName": "string",
"sasUrl": "string"
}
],
"upgradedFrom": {
"id": "string",
"name": "string"
},
"validations": [
{
"$schema": "string",
"code": "businessValidationError",
"level": "informational",
"message": "string",
"resourceId": "string"
}
],
"variableStartDate": true
},
"azureProductVariant": {
"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"
},
"billableDimensions": [
{
"billableMetricId": "string",
"category": "basic",
"description": "string",
"discount": {
"discountType": "PERCENTAGE",
"value": 0
},
"length": 0,
"minimumCommit": 0,
"minimumCommitProrata": true,
"minimumCommitScope": "",
"name": "string",
"priceModelBasic": {
"unitAmount": 0
},
"priceModelBulk": {
"bulkAmount": 0,
"bulkSize": 0
},
"priceModelMatrix": {
"defaultUnitAmount": 0,
"matrix": [
{
"properties": [
{
"name": "string",
"value": "string"
}
],
"unitAmount": 0
}
]
},
"priceModelPercentage": {
"flatFee": 0,
"percentageRate": 0
},
"priceModelTiered": {
"tiers": [
{
"firstUnit": 0,
"flatFee": 0,
"lastUnit": 0,
"unitAmount": 0
}
]
},
"priceModelTieredPercentage": {
"tiers": [
{
"firstUnit": 0,
"flatFee": 0,
"lastUnit": 0,
"percentageRate": 0
}
]
},
"priceModelVolume": {
"tiers": [
{
"flatFee": 0,
"maximumUnits": 0,
"unitAmount": 0
}
]
},
"timeUnit": "DAY"
}
],
"billingCycle": "MONTH_FIRST_DAY",
"buyerAwsAccountIds": [
"string"
],
"buyerAzureTenants": [
{
"description": "string",
"id": "string"
}
],
"commitAmount": 0,
"commitBillingIntervalInMonths": 0,
"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": ""
}
],
"discountPercentage": 0,
"eulaType": "",
"eulaUrl": "string",
"gcpCustomerInfo": {
"address": "string",
"contact": "string",
"email": "string",
"organization": "string",
"unverifiedBillingAccount": "string"
},
"gcpDuration": 0,
"gcpMetrics": [
{
"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": ""
}
],
"gcpPaymentSchedule": "",
"gcpPlans": [
{
"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"
}
],
"gcpPrivateOffer": {
"activeEntitlement": {
"account": "string",
"consumers": [
{
"project": "string"
}
],
"createTime": "2024-07-29T15:51:28.071Z",
"id": "string",
"inputProperties": [
0
],
"messageToUser": "string",
"name": "string",
"newOfferDuration": "string",
"newOfferEndTime": "string",
"newOfferStartTime": "string",
"newPendingOffer": "string",
"newPendingOfferDuration": "string",
"newPendingPlan": "string",
"newPlan": "string",
"offer": "string",
"offerDuration": "string",
"offerEffectiveTime": "2024-07-29T15:51:28.071Z",
"offerEndTime": "2024-07-29T15:51:28.071Z",
"plan": "string",
"product": "string",
"productExternalName": "string",
"provider": "string",
"quoteExternalName": "string",
"state": "ENTITLEMENT_STATE_UNSPECIFIED",
"subscriptionEndTime": "2024-07-29T15:51:28.071Z",
"updateTime": "2024-07-29T15:51:28.071Z",
"usageReportingId": "string"
},
"agencyEnabled": true,
"agreement": "string",
"cancelTime": "2024-07-29T15:51:28.071Z",
"customEula": {
"description": "string",
"documentBody": "string",
"documentType": "string",
"externalGoogleLink": {
"uri": "string"
},
"name": "string",
"unstructuredDocument": {
"content": "string"
},
"updateTime": "2024-07-29T15:51:28.071Z"
},
"customerInfo": {
"address": "string",
"contact": "string",
"email": "string",
"organization": "string",
"unverifiedBillingAccount": "string"
},
"eulaAgreementDocument": {
"description": "string",
"documentBody": "string",
"documentType": "string",
"externalGoogleLink": {
"uri": "string"
},
"name": "string",
"unstructuredDocument": {
"content": "string"
},
"updateTime": "2024-07-29T15:51:28.071Z"
},
"existingOfferData": {
"entitlement": {
"account": "string",
"consumers": [
{
"project": "string"
}
],
"createTime": "2024-07-29T15:51:28.071Z",
"id": "string",
"inputProperties": [
0
],
"messageToUser": "string",
"name": "string",
"newOfferDuration": "string",
"newOfferEndTime": "string",
"newOfferStartTime": "string",
"newPendingOffer": "string",
"newPendingOfferDuration": "string",
"newPendingPlan": "string",
"newPlan": "string",
"offer": "string",
"offerDuration": "string",
"offerEffectiveTime": "2024-07-29T15:51:28.071Z",
"offerEndTime": "2024-07-29T15:51:28.071Z",
"plan": "string",
"product": "string",
"productExternalName": "string",
"provider": "string",
"quoteExternalName": "string",
"state": "ENTITLEMENT_STATE_UNSPECIFIED",
"subscriptionEndTime": "2024-07-29T15:51:28.071Z",
"updateTime": "2024-07-29T15:51:28.071Z",
"usageReportingId": "string"
},
"existingPriceModelType": "",
"hasEntitlementChanged": true,
"privateOffer": {
"agreement": "string",
"customEula": {
"description": "string",
"documentBody": "string",
"documentType": "string",
"externalGoogleLink": {
"uri": "string"
},
"name": "string",
"unstructuredDocument": {
"content": "string"
},
"updateTime": "2024-07-29T15:51:28.071Z"
},
"installmentTimeline": {
"installments": [
{
"priceModel": {
"baseOffer": "string",
"commitment": {
"commitmentAmountPerPeriod": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"fixedPrice": {
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"oneTimeCredit": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"overage": {
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"skuDiscounts": [
null
]
},
"payg": {
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"skuDiscounts": [
null
]
},
"previousCreditBalancePolicy": "string"
},
"startTime": "2024-07-29T15:51:28.071Z"
}
]
},
"name": "string",
"offerTerm": {
"enableScheduledStartTimes": true,
"endTime": "2024-07-29T15:51:28.071Z",
"startPolicy": "",
"startTime": "2024-07-29T15:51:28.071Z",
"termDuration": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"paymentSchedule": "",
"priceModel": {
"baseOffer": "string",
"commitment": {
"commitmentAmountPerPeriod": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"fixedPrice": {
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"oneTimeCredit": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"overage": {
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"skuDiscounts": [
null
]
},
"payg": {
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"skuDiscounts": [
null
]
},
"previousCreditBalancePolicy": "string"
},
"serviceLevel": "string"
},
"standardOffer": {}
},
"expireTime": "2024-07-29T15:51:28.071Z",
"features": [
{
"featureDescription": "string",
"featureName": "string",
"featureTitle": "string",
"featureValue": "string"
}
],
"installmentTimeline": {
"installments": [
{
"priceModel": {
"baseOffer": "string",
"commitment": {
"commitmentAmountPerPeriod": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"fixedPrice": {
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"oneTimeCredit": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"overage": {
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"skuDiscounts": [
null
]
},
"payg": {
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"skuDiscounts": [
null
]
},
"previousCreditBalancePolicy": "string"
},
"startTime": "2024-07-29T15:51:28.071Z"
}
]
},
"lifecycleState": "string",
"metricInformation": {
"metricDetails": [
{
"displayName": "string",
"parentCommerceService": "string",
"skuId": "string",
"tiers": [
{
"fromAmount": 0,
"price": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"startingUsageAmount": "string"
}
],
"unitDescription": "string"
}
]
},
"migrationMetadata": {
"inventoryFlavorExternalName": "string",
"productExternalName": "string",
"projectNumber": "string",
"providerId": "string"
},
"name": "string",
"offerId": "string",
"offerSource": "OFFER",
"offerState": "OFFER_ACTIVE",
"offerTerm": {
"enableScheduledStartTimes": true,
"endTime": "2024-07-29T15:51:28.071Z",
"startPolicy": "",
"startTime": "2024-07-29T15:51:28.071Z",
"termDuration": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"offerTitle": "string",
"offerTitleAutoGenerated": true,
"paymentSchedule": "",
"policies": {},
"priceModel": {
"baseOffer": "string",
"commitment": {
"commitmentAmountPerPeriod": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"fixedPrice": {
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"oneTimeCredit": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"overage": {
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"skuDiscounts": [
null
]
},
"payg": {
"discount": {
"discountPercentage": {
"nanos": 0,
"units": "string"
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
}
},
"skuDiscounts": [
null
]
},
"previousCreditBalancePolicy": "string"
},
"priceModelType": "",
"providerCancellationInternalNote": "string",
"providerInfo": {
"creatorEmailAddress": "string",
"salesContactEmail": "string",
"salesContactName": "string"
},
"providerInternalNote": "string",
"providerPublicNote": "string",
"purchaseChannel": {
"marketplace": true,
"reseller": true
},
"purchaseTime": "2024-07-29T15:51:28.071Z",
"replacementMetadata": {
"cotermAlignment": "string",
"replacedOffer": "string",
"replacedOfferEndTime": "2024-07-29T15:51:28.071Z",
"replacementPolicy": "string"
},
"resellerInfo": {
"billingAccountId": "string",
"billingAccountNickname": "string",
"billingAccountOrgDisplayName": "string",
"billingAccountType": "string",
"notesToReseller": "string"
},
"serviceLevel": "string",
"updateTime": "2024-07-29T15:51:28.071Z",
"useLegacyPartnerEula": true,
"userLabels": [
"string"
]
},
"gcpProviderInfo": {
"creatorEmailAddress": "string",
"salesContactEmail": "string",
"salesContactName": "string"
},
"gcpProviderInternalNote": "string",
"gcpProviderPublicNote": "string",
"gcpResellerPrivateOfferPlan": {
"acceptanceDeadlineTime": "2024-07-29T15:51:28.071Z",
"agreement": "string",
"agreementDocuments": {
"isvToCustomerAgreementDocument": {
"description": "string",
"documentBody": "string",
"documentType": "string",
"externalGoogleLink": {
"uri": "string"
},
"name": "string",
"unstructuredDocument": {
"content": "string"
},
"updateTime": "2024-07-29T15:51:28.071Z"
},
"isvToResellerAgreementDocument": {
"description": "string",
"documentBody": "string",
"documentType": "string",
"externalGoogleLink": {
"uri": "string"
},
"name": "string",
"unstructuredDocument": {
"content": "string"
},
"updateTime": "2024-07-29T15:51:28.071Z"
}
},
"amendmentContext": {},
"displayName": "string",
"durationConfig": {
"endTime": "2024-07-29T15:51:28.071Z",
"startTime": "2024-07-29T15:51:28.071Z"
},
"features": [
{
"featureDescription": "string",
"featureName": "string",
"featureTitle": "string",
"featureValue": "string"
}
],
"installmentTimelineTemplate": {
"installmentTemplates": [
{
"priceModelTemplate": {
"baseOffer": "string",
"commitment": {
"commitmentAmountPerPeriodTemplate": {
"currencyCode": "string",
"decimalAmountConstraint": {
"defaultAmount": {
"nanos": 0,
"units": "string"
},
"maxAmount": {
"nanos": 0,
"units": "string"
},
"minAmount": {
"nanos": 0,
"units": "string"
}
}
},
"discountTemplate": {
"discountEconomics": "string",
"discountPercentage": {
"defaultAmount": {
"nanos": 0,
"units": "string"
},
"maxAmount": {
"nanos": 0,
"units": "string"
},
"minAmount": {
"nanos": 0,
"units": "string"
}
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"hideDiscountPercentage": true
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"consumption": "overage",
"fixedPrice": {
"discountTemplate": {
"discountEconomics": "string",
"discountPercentage": {
"defaultAmount": {
"nanos": 0,
"units": "string"
},
"maxAmount": {
"nanos": 0,
"units": "string"
},
"minAmount": {
"nanos": 0,
"units": "string"
}
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"hideDiscountPercentage": true
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"overage": {
"discountTemplate": {
"discountEconomics": "string",
"discountPercentage": {
"defaultAmount": {
"nanos": 0,
"units": "string"
},
"maxAmount": {
"nanos": 0,
"units": "string"
},
"minAmount": {
"nanos": 0,
"units": "string"
}
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"hideDiscountPercentage": true
},
"skuDiscountTemplates": [
null
],
"skuRepresentation": {
"skuGroupList": {},
"skuList": {
"skus": [
"string"
]
},
"skus": "string"
}
},
"payg": {
"discountTemplate": {
"discountEconomics": "string",
"discountPercentage": {
"defaultAmount": {
"nanos": 0,
"units": "string"
},
"maxAmount": {
"nanos": 0,
"units": "string"
},
"minAmount": {
"nanos": 0,
"units": "string"
}
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"hideDiscountPercentage": true
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
},
"skuDiscountTemplates": [
null
],
"skuRepresentation": {
"skuGroupList": {},
"skuList": {
"skus": [
"string"
]
},
"skus": "string"
}
},
"subscription": "fixedPrice"
},
"startTime": "2024-07-29T15:51:28.071Z"
}
]
},
"isvInfo": {
"contactEmail": "string",
"contactName": "string",
"partnerAdvantageAccountLegalName": "string",
"partnerAdvantageId": "string"
},
"margin": {
"marginPercentage": {
"value": "string"
}
},
"metaInfo": {
"gcpOrganizationId": "string",
"gcpProjectNumber": "string"
},
"name": "string",
"offerTemplatePolicies": {
"allowAutoRenewal": true,
"allowScheduledStartDate": true,
"maxRenewalTimes": "string",
"proration": "PRORATION_UNSPECIFIED"
},
"offerTermTemplate": {
"enableScheduledStartTimes": true,
"endTime": "2024-07-29T15:51:28.071Z",
"paymentRecurrence": "string",
"startPolicy": "",
"startTime": "2024-07-29T15:51:28.071Z",
"termDuration": {
"count": 0,
"unit": "MONTHLY_PERIOD"
},
"termDurationConstraint": {
"defaultDuration": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
}
},
"paymentSchedule": "",
"priceModelTemplate": {
"baseOffer": "string",
"commitment": {
"commitmentAmountPerPeriodTemplate": {
"currencyCode": "string",
"decimalAmountConstraint": {
"defaultAmount": {
"nanos": 0,
"units": "string"
},
"maxAmount": {
"nanos": 0,
"units": "string"
},
"minAmount": {
"nanos": 0,
"units": "string"
}
}
},
"discountTemplate": {
"discountEconomics": "string",
"discountPercentage": {
"defaultAmount": {
"nanos": 0,
"units": "string"
},
"maxAmount": {
"nanos": 0,
"units": "string"
},
"minAmount": {
"nanos": 0,
"units": "string"
}
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"hideDiscountPercentage": true
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"consumption": "overage",
"fixedPrice": {
"discountTemplate": {
"discountEconomics": "string",
"discountPercentage": {
"defaultAmount": {
"nanos": 0,
"units": "string"
},
"maxAmount": {
"nanos": 0,
"units": "string"
},
"minAmount": {
"nanos": 0,
"units": "string"
}
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"hideDiscountPercentage": true
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
}
},
"overage": {
"discountTemplate": {
"discountEconomics": "string",
"discountPercentage": {
"defaultAmount": {
"nanos": 0,
"units": "string"
},
"maxAmount": {
"nanos": 0,
"units": "string"
},
"minAmount": {
"nanos": 0,
"units": "string"
}
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"hideDiscountPercentage": true
},
"skuDiscountTemplates": [
null
],
"skuRepresentation": {
"skuGroupList": {},
"skuList": {
"skus": [
"string"
]
},
"skus": "string"
}
},
"payg": {
"discountTemplate": {
"discountEconomics": "string",
"discountPercentage": {
"defaultAmount": {
"nanos": 0,
"units": "string"
},
"maxAmount": {
"nanos": 0,
"units": "string"
},
"minAmount": {
"nanos": 0,
"units": "string"
}
},
"discountedPrice": {
"currencyCode": "string",
"nanos": 0,
"units": "string"
},
"hideDiscountPercentage": true
},
"period": {
"count": 0,
"unit": "MONTHLY_PERIOD"
},
"skuDiscountTemplates": [
null
],
"skuRepresentation": {
"skuGroupList": {},
"skuList": {
"skus": [
"string"
]
},
"skus": "string"
}
},
"subscription": "fixedPrice"
},
"productInfo": {
"flavorExternalName": "string",
"productExternalName": "string",
"providerId": "string",
"serviceLevel": "string",
"serviceName": "string"
},
"replacementMetadata": {},
"resellOfferTemplate": "string",
"resellerInfo": {
"billingAccountId": "string",
"billingAccountNickname": "string",
"billingAccountOrgDisplayName": "string",
"billingAccountType": "string",
"notesToReseller": "string"
},
"reusePolicy": "",
"startPolicy": "",
"state": {
"cancellationReason": {},
"comment": "string",
"rejectionReason": {},
"stateType": ""
},
"stateTransitions": [
{
"newState": {
"stateType": ""
},
"transitionTime": "2024-07-29T15:51:28.071Z"
}
],
"updateTime": "2024-07-29T15:51:28.071Z"
},
"gcpUsagePlanPriceModel": "",
"gracePeriodInDays": 0,
"netTermsInDays": 0,
"paymentInstallments": [
{
"amount": 0,
"chargeOn": "2024-07-29T15:51:28.071Z",
"chargeOnStr": "string",
"credit": 0,
"discountPercentage": 0,
"originalAmount": 0
}
],
"paymentSchedule": "",
"privateOfferUrl": "string",
"proratedBilling": true,
"refundCancellationPolicy": "string",
"resellerAttachEulaType": "",
"resellerEulaType": "",
"resellerEulaUrl": "string",
"sellerNotes": "string",
"startTime": "2024-07-29T15:51:28.071Z",
"taxIds": [
"string"
],
"trialConfig": {
"trialPeriod": 0,
"trialPeriodUnit": "DAY"
},
"usageBillingIntervalInMonths": 0,
"visibility": "PRIVATE"
},
"lastUpdateTime": "2024-07-29T15:51:28.071Z",
"lastUpdatedBy": "string",
"metaInfo": {
"aceApnCrmUniqueIdentifier": "string",
"awsSaasProductDimensions": [
{
"Description": "string",
"Key": "string",
"Length": 0,
"Name": "string",
"Rate": 0,
"TimeUnit": "DAY",
"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-07-29T15:51:28.071Z",
"message": "string",
"organizationID": "string",
"partner": "",
"priority": "",
"requireAudit": true,
"timestamp": "2024-07-29T15:51:28.071Z",
"title": "string",
"trackEvents": [
{
"action": "OPEN_EMAIL",
"contactId": "string",
"timestamp": "2024-07-29T15:51:28.071Z"
}
]
}
],
"offerAcceptDate": "2024-07-29T15:51:28.071Z",
"renewalOfferType": "",
"replacedOfferEndTime": "2024-07-29T15:51:28.071Z",
"replacedOfferResourceName": "string",
"salesforceEntitlementURL": "string",
"salesforceOpportunityId": "string",
"testUsageMeteringEndTime": "2024-07-29T15:51:28.071Z",
"updateMessage": "string"
},
"name": "string",
"offerType": "UNKNOWN",
"organizationID": "string",
"partner": "",
"productID": "string",
"service": "DEFAULT",
"status": ""
}
Bad request error
- application/json
- Schema
Schema
string
Not found
- application/json
- Schema
Schema
string
Method not allowed
- application/json
- Schema
Schema
string
Internal error
- application/json
- Schema
Schema
string