Cancel sessionPOST

OpenStock Docs

POST

/api/checkout-api/sessions/{session_id}/cancel

checkout_api

Cancels a session that has not been paid. Completed sessions cannot be cancelled.

Authorization#

AuthorizationBearer <token>

In: header. A store API key starting with sk_ that has the checkout_api permission.

Path parameters#

session_idrequiredstring

The session to cancel.

Responses#

200Session cancelled.
400The session is already completed.
404Unknown session.
401Missing, malformed, disabled or expired API key.

curl -X POST "https://openstock.dev/api/checkout-api/sessions/cs_9f2c4e1a7b3d4c5e8f90a1b2c3d4e5f6/cancel" \
  -H "Authorization: Bearer $OPENSTOCK_API_KEY"

Session cancelled.

{
  "id": "cs_9f2c4e1a7b3d4c5e8f90a1b2c3d4e5f6",
  "status": "cancelled"
}