Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1425213171.1 KB

Allows sellers (proposers) to submit a cancellation request for an active agreement. The cancellation request is created in <code>PENDING_APPROVAL</code> status, at which point the buyer can review it.

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

Headers

X-Amz-Target'AWSMPCommerceService_v20200301.SendAgreementCancellationRequest' required

Request body

agreementIdstring required

The unique identifier of the agreement for which the cancellation request is being submitted.

reasonCode'INCORRECT_TERMS_ACCEPTED' | 'REPLACING_AGREEMENT' | 'TEST_AGREEMENT' | 'ALTERNATIVE_PROCUREMENT_CHANNEL' | 'PRODUCT_DISCONTINUED' | 'UNINTENDED_RENEWAL' | 'BUYER_DISSATISFACTION' | 'OTHER' required

The reason code for the cancellation request.

clientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

descriptionstring password

An optional detailed description of the cancellation reason (1-2000 characters).

Response

Success

agreementIdstring

The unique identifier of the agreement.

agreementCancellationRequestIdstring

The unique identifier for the created cancellation request.

status'PENDING_APPROVAL' | 'APPROVED' | 'REJECTED' | 'CANCELLED' | 'VALIDATION_FAILED'

The current status of the cancellation request. The initial status is <code>PENDING_APPROVAL</code>.

reasonCode'INCORRECT_TERMS_ACCEPTED' | 'REPLACING_AGREEMENT' | 'TEST_AGREEMENT' | 'ALTERNATIVE_PROCUREMENT_CHANNEL' | 'PRODUCT_DISCONTINUED' | 'UNINTENDED_RENEWAL' | 'BUYER_DISSATISFACTION' | 'OTHER'

The reason code provided for the cancellation.

descriptionstring password

The detailed description of the cancellation reason, if provided.

createdAtstring date-time

The time when the cancellation request was created.

updatedAtstring date-time

The time when the cancellation request was last updated.