AgreementService / Client / send_agreement_cancellation_request

send_agreement_cancellation_request¶

AgreementService.Client.send_agreement_cancellation_request(**kwargs)¶

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

Request Syntax

response = client.send_agreement_cancellation_request(
    agreementId='string',
    reasonCode='INCORRECT_TERMS_ACCEPTED'|'REPLACING_AGREEMENT'|'TEST_AGREEMENT'|'ALTERNATIVE_PROCUREMENT_CHANNEL'|'PRODUCT_DISCONTINUED'|'UNINTENDED_RENEWAL'|'BUYER_DISSATISFACTION'|'OTHER',
    clientToken='string',
    description='string'
)

Parameters:

agreementId (string) –
[REQUIRED]

The unique identifier of the agreement for which the cancellation request is being submitted.
reasonCode (string) –
[REQUIRED]

The reason code for the cancellation request. Valid values include INCORRECT_TERMS_ACCEPTED, REPLACING_AGREEMENT, TEST_AGREEMENT, ALTERNATIVE_PROCUREMENT_CHANNEL, PRODUCT_DISCONTINUED, UNINTENDED_RENEWAL, BUYER_DISSATISFACTION, and OTHER.
clientToken (string) –
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.
description (string) – An optional detailed description of the cancellation reason (1-2000 characters).

Return type:

dict

Returns:

Response Syntax

{
    'agreementId': 'string',
    'agreementCancellationRequestId': 'string',
    'status': 'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED'|'VALIDATION_FAILED',
    'reasonCode': 'INCORRECT_TERMS_ACCEPTED'|'REPLACING_AGREEMENT'|'TEST_AGREEMENT'|'ALTERNATIVE_PROCUREMENT_CHANNEL'|'PRODUCT_DISCONTINUED'|'UNINTENDED_RENEWAL'|'BUYER_DISSATISFACTION'|'OTHER',
    'description': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- agreementId (string) –
  
  The unique identifier of the agreement.
- agreementCancellationRequestId (string) –
  
  The unique identifier for the created cancellation request.
- status (string) –
  
  The current status of the cancellation request. The initial status is PENDING_APPROVAL.
- reasonCode (string) –
  
  The reason code provided for the cancellation.
- description (string) –
  
  The detailed description of the cancellation reason, if provided.
- createdAt (datetime) –
  
  The time when the cancellation request was created, as a POSIX timestamp (Unix epoch seconds).
- updatedAt (datetime) –
  
  The time when the cancellation request was last updated, as a POSIX timestamp (Unix epoch seconds).

Exceptions

AgreementService.Client.exceptions.ValidationException
AgreementService.Client.exceptions.AccessDeniedException
AgreementService.Client.exceptions.ResourceNotFoundException
AgreementService.Client.exceptions.ThrottlingException
AgreementService.Client.exceptions.InternalServerException
AgreementService.Client.exceptions.ConflictException