← Home
POST/hyax-api/v1/checkout-sessions/:id/expire

Expire a checkout session

Closes an unpaid session so its URL stops working (status becomes `CANCELED`). A `COMPLETED` session can't be expired.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request

curl -X POST 'https://platform.hyax.com/hyax-api/v1/checkout-sessions/clx_example_id/expire' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response

{
  "success": true,
  "data": { "id": "cs_clx…", "status": "CANCELED", "…": "…" }
}