API Reference

Request an agreement cancellation

post
https://aws-agreement-api.tackle.io/api/agreements//cancellations

Asks the buyer to approve cancelling the agreement.

The request is created at PENDING_APPROVAL. The buyer can approve or reject
it. If the buyer does not respond within 7 days, the request is automatically
approved and the status becomes APPROVED. Auto-approval looks the same as an
explicit buyer approval, and no deadline is returned on the resource. Use
created if you need to show a deadline in your UI.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 64
^[A-Za-z0-9_/-]+$

Agreement identifier

Body Params
string
enum
required

Why you are requesting the cancellation. Not interchangeable with billing
adjustment reason codes.

string
length between 1 and 2000

Optional note shown to the buyer with the request

string
length ≤ 64
^[a-zA-Z0-9-]+$

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

Responses

Updated 6 days ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago

Did this page help you?