DescribeOffer

GET {{_.CAPI_PROD}}/DescribeEntity?catalog=AWSMarketplace&entityId={{OFFER_ID}}

DescribeOffer API get request returns the metadata and content of the entity. In this case, with entityId set to OFFER_ID in your environment variable, it will return the details of an offer.

Request Params

RESPONSES

status: OK

{"Details":"{\"Id\":\"offer-euxmbalqomroa\",\"Name\":\"CAPI Integ Test Product (SAAS) Test Offer\",\"Description\":\"CAPI Integ Test Product (SAAS) Test Offer\",\"ProductId\":\"product-111111111111\",\"MarkupPercentage\":\"5.0\",\"Terms\":[{\"Type\":\"LegalTerm\",\"Documents\":[{\"Type\":\"CustomEula\",\"Url\":\"https://aws-mp-offer-legal-artifacts-us-east-1-prod.s3.amazonaws.com/offer-euxmbalqomroa/dd555292-38ec-4df1-ab5c-415f703d5182?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEEsaCXVz\"}]},{\"Type\":\"FixedUpfrontPricingTerm\",\"CurrencyCode\":\"USD\",\"Price\":\"0\",\"Grants\":[{\"DimensionKey\":\"mdrbasic\",\"MaxQuantity\":2},{\"DimensionKey\":\"Custom\",\"MaxQuantity\":1},{\"DimensionKey\":\"CustomDimension2\",\"MaxQuantity\":3}]},{\"Type\":\"ValidityTerm\",\"AgreementDuration\":\"P12M\"},{\"Type\":\"PaymentScheduleTerm\",\"CurrencyCode\":\"USD\",\"Schedule\":[{\"ChargeDate\":\"2025-08-01T00:00:00.000Z\",\"ChargeAmount\":\"10.5\"}]}],\"Rules\":[{\"Type\":\"AvailabilityRule\",\"AvailabilityEndDate\":\"2025-07-01T23:59:59.999Z\"},{\"Type\":\"TargetingRule\",\"PositiveTargeting\":{\"BuyerAccounts\":[\"222222222222\"]}}],\"State\":\"Released\",\"ResaleAuthorizationId\":\"resaleauthz-111111111111\"}","DetailsDocument":{"Id":"offer-euxmbalqomroa","Name":"CAPI Integ Test Product (SAAS) Test Offer","Description":"CAPI Integ Test Product (SAAS) Test Offer","ProductId":"prod-11111111111","MarkupPercentage":"5.0","Terms":[{"Type":"LegalTerm","Documents":[{"Type":"CustomEula","Url":"https://aws-mp-offer-legal-artifacts-us-east-1-prod.s3.amazonaws.com/offer-euxmbalqomroa/dd555292-38ec-4df1-ab5c-415f703d5182?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEEsaCXVz"}]},{"Type":"FixedUpfrontPricingTerm","CurrencyCode":"USD","Price":"0","Grants":[{"DimensionKey":"mdrbasic","MaxQuantity":2},{"DimensionKey":"Custom","MaxQuantity":1},{"DimensionKey":"CustomDimension2","MaxQuantity":3}]},{"Type":"ValidityTerm","AgreementDuration":"P12M"},{"Type":"PaymentScheduleTerm","CurrencyCode":"USD","Schedule":[{"ChargeDate":"2025-08-01T00:00:00.000Z","ChargeAmount":"10.5"}]}],"Rules":[{"Type":"AvailabilityRule","AvailabilityEndDate":"2025-07-01T23:59:59.999Z"},{"Type":"TargetingRule","PositiveTargeting":{"BuyerAccounts":["222222222222"]}}],"State":"Released","ResaleAuthorizationId":"resaleauthz-111111111111"},"EntityArn":"arn:aws:aws-marketplace:us-east-1:111111111111:AWSMarketplace/Offer/offer-1234567890","EntityIdentifier":"offer-1234567890@1","EntityType":"Offer@1.0","LastModifiedDate":"2024-10-01T20:49:21Z"}