7_DescribeOffer
GET {{_.CAPI_PROD}}/DescribeEntity?catalog=AWSMarketplace&entityId={{OFFER_ID}}
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
catalog | string | ||
entityId | string |
RESPONSES
status: OK
{"EntityType":"Offer@1.0","EntityIdentifier":"offer-1234567890@3","EntityArn":"arn:aws:aws-marketplace:us-east-1:111111111111:AWSMarketplace/Offer/offer-1234567890","LastModifiedDate":"2024-10-07T22:36:53Z","Details":"{\"Id\":\"offer-1234567890\",\"Name\":\"Demo Private Offer\",\"Description\":\"Demo Private Offer Description\",\"ProductId\":\"prod-1234567890\",\"Terms\":[{\"Type\":\"UsageBasedPricingTerm\",\"CurrencyCode\":\"USD\",\"RateCards\":[{\"RateCard\":[{\"DimensionKey\":\"metered_1_id\",\"Price\":\"0.001\"},{\"DimensionKey\":\"metered_2_id\",\"Price\":\"0.001\"},{\"DimensionKey\":\"metered_3_id\",\"Price\":\"0.001\"}]}]},{\"Type\":\"LegalTerm\",\"Documents\":[{\"Type\":\"StandardEula\",\"Version\":\"2022-07-14\",\"Url\":\"https://aws-mp-offer-legal-artifacts-us-east-1-prod.s3.amazonaws.com/offer-x52lclvbyma3a/36b99325-4fe1-4a38-b2d6-0f247b4fc71b?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEN3%2F%2F%2F%2\"}]},{\"Type\":\"FixedUpfrontPricingTerm\",\"CurrencyCode\":\"USD\",\"Price\":\"0\",\"Grants\":[{\"DimensionKey\":\"dimension_1_id\",\"MaxQuantity\":22000},{\"DimensionKey\":\"dimension_2_id\",\"MaxQuantity\":22000},{\"DimensionKey\":\"dimension_3_id\",\"MaxQuantity\":22000}]},{\"Type\":\"ValidityTerm\",\"AgreementDuration\":\"P12M\"},{\"Type\":\"PaymentScheduleTerm\",\"CurrencyCode\":\"USD\",\"Schedule\":[{\"ChargeDate\":\"2025-01-01T00:00:00.000Z\",\"ChargeAmount\":\"30.00\"},{\"ChargeDate\":\"2025-01-15T00:00:00.000Z\",\"ChargeAmount\":\"30.00\"}]}],\"Rules\":[{\"Type\":\"AvailabilityRule\",\"AvailabilityEndDate\":\"2024-12-12T23:59:59.999Z\"},{\"Type\":\"TargetingRule\",\"PositiveTargeting\":{\"BuyerAccounts\":[\"222222222222\",\"333333333333\"]}}],\"State\":\"Released\"}","DetailsDocument":{"Id":"offer-x52lclvbyma3a","Name":"Demo Private Offer","Description":"Demo Private Offer Description","ProductId":"prod-1234567890","Terms":[{"Type":"UsageBasedPricingTerm","CurrencyCode":"USD","RateCards":[{"RateCard":[{"DimensionKey":"metered_1_id","Price":"0.001"},{"DimensionKey":"metered_2_id","Price":"0.001"},{"DimensionKey":"metered_3_id","Price":"0.001"}]}]},{"Type":"LegalTerm","Documents":[{"Type":"StandardEula","Version":"2022-07-14","Url":"https://aws-mp-offer-legal-artifacts-us-east-1-prod.s3.amazonaws.com/offer-x52lclvbyma3a/36b99325-4fe1-4a38-b2d6-0f247b4fc71b"}]},{"Type":"FixedUpfrontPricingTerm","CurrencyCode":"USD","Price":"0","Grants":[{"DimensionKey":"dimension_1_id","MaxQuantity":22000},{"DimensionKey":"dimension_2_id","MaxQuantity":22000},{"DimensionKey":"dimension_3_id","MaxQuantity":22000}]},{"Type":"ValidityTerm","AgreementDuration":"P12M"},{"Type":"PaymentScheduleTerm","CurrencyCode":"USD","Schedule":[{"ChargeDate":"2025-01-01T00:00:00.000Z","ChargeAmount":"30.00"},{"ChargeDate":"2025-01-15T00:00:00.000Z","ChargeAmount":"30.00"}]}],"Rules":[{"Type":"AvailabilityRule","AvailabilityEndDate":"2024-12-12T23:59:59.999Z"},{"Type":"TargetingRule","PositiveTargeting":{"BuyerAccounts":["222222222222","333333333333"]}}],"State":"Released"}}