Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1425213171.1 KB

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

post/#X-Amz-Target=AWSMPCommerceService_v20200301.DescribeAgreement

Headers

X-Amz-Target'AWSMPCommerceService_v20200301.DescribeAgreement' required

Request body

agreementIdstring required

The unique identifier of the agreement.

Response

Success

agreementIdstring

The unique identifier of the agreement.

startTimestring date-time

The date and time when the agreement starts.

endTimestring date-time

The date and time when the agreement ends. The field is <code>null</code> for pay-as-you-go agreements, which don’t have end dates.

acceptanceTimestring date-time
<p>The date and time the offer was accepted or the agreement was created.</p> <note> <p> <code>AcceptanceTime</code> and <code>StartTime</code> can differ for future dated agreements (FDAs).</p> </note>
agreementTypestring

The type of agreement. Values are <code>PurchaseAgreement</code> or <code>VendorInsightsAgreement</code>.

status'ACTIVE' | 'ARCHIVED' | 'CANCELLED' | 'EXPIRED' | 'RENEWED' | 'REPLACED' | 'ROLLED_BACK' | 'SUPERSEDED' | 'TERMINATED'
<p>The current status of the agreement.</p> <p>Statuses include:</p> <ul> <li> <p> <code>ACTIVE</code> – The terms of the agreement are active.</p> </li> <li> <p> <code>ARCHIVED</code> – The agreement ended without a specified reason.</p> </li> <li> <p> <code>CANCELLED</code> – The acceptor ended the agreement before the defined end date.</p> </li> <li> <p> <code>EXPIRED</code> – The agreement ended on the defined end date.</p> </li> <li> <p> <code>RENEWED</code> – The agreement was renewed into a new agreement (for example, an auto-renewal).</p> </li> <li> <p> <code>REPLACED</code> – The agreement was replaced using an agreement replacement offer.</p> </li> <li> <p> <code>TERMINATED</code> – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).</p> </li> </ul>