Cancel session
Cancel a terminal session.
It might be necessary to cancel a terminal session without payment.
Path
When you need to cancel a terminal session, you can use the endpoint:
PUT /terminal-sessions/{terminalSessionId}/cancel
Note that the API method for cancelling a terminal session is PUT
rather than DELETE
. The
session itself is not deleted, and it can be called up using the get terminal operation for reference.
If payment has been attempted or completed on a terminal session, it will no longer be possible to cancel it. This includes failed payment attempts.
In the successful cancel session response, the status
of the session will change to CancelRequested
. The status will first move to CancelRequested
. Finally, status
of the session will change to Canceled
.
Sample requests
- cURL
- Python
- PowerShell
loading...
loading...
loading...