Request an agreement cancellation

post

https://aws-agreement-api.tackle.io/api/agreements/{agreementId}/cancellations

Asks the buyer to approve cancelling the agreement, forwarded to the AWS
Marketplace SendAgreementCancellationRequest API.

The request is created at PENDING_APPROVAL. The buyer may approve or reject it.
AWS auto-approves a request the buyer has not acted on after 7 days; an
auto-approval is indistinguishable from an explicit buyer approval — the status
becomes APPROVED either way, and no deadline is returned on the resource. Track
the deadline from created if you need to show one.

You may withdraw a request that is still PENDING_APPROVAL. See the withdraw
operation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

agreementId

string

required

length ≤ 64

^[A-Za-z0-9_/-]+$

AWS Marketplace agreement identifier

Body Params

reasonCode

string

enum

required

Why the cancellation is being requested. This set is not interchangeable with
the billing-adjustment reason codes: it excludes INCORRECT_METERING and
TEST_ENVIRONMENT_CHARGES, and adds PRODUCT_DISCONTINUED,
REPLACING_AGREEMENT, and TEST_AGREEMENT.

description

string

length between 1 and 2000

Free-text detail shown with the request

clientToken

string

length ≤ 64

^[a-zA-Z0-9-]+$

Idempotency key. Replaying it returns the original request rather than creating a second one.

Headers

X-Tackle-Vendor

string

The Tackle vendor this request operates on. Must be one of the vendors your token
permits, or the request is rejected with 403.

Optional only for single-vendor tokens, where it defaults to the token's primary
vendor. Multi-vendor callers should always send it — the fallback picks an
arbitrary vendor from the organizational unit, not a meaningful default.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Cancellation request created at PENDING_APPROVAL

400The request is malformed, or no vendor could be resolved because neither X-Tackle-Vendor nor a token primary vendor was available.

401The bearer token is missing, malformed, or expired

403The token is valid but is not permitted to act for the requested vendor, or lacks the required entitlement. Most often the X-Tackle-Vendor value is outside the set your token allows.

404The parent agreement does not exist for the resolved vendor. An agreement that exists but has no sub-resources returns 200 with an empty collection instead.

409The agreement already has a cancellation request awaiting buyer approval, or its state does not permit cancellation.

500Internal server error