Expire a checkout session

Marks a checkout session as expired so it can no longer accept payment.

Use this when you mint a fresh checkout session for a logical purchase that already had one outstanding (for example, a customer requested a new payment link after the original expired). Without explicitly expiring the old session, its URL remains payable until the session’s natural 30-minute TTL elapses, which can let a customer who reloads the old tab pay twice.

Mirrors Stripe’s POST /checkout/sessions/{id}/expire.

Idempotent. Calling expire on a session that is already in a terminal state (success, failed, cancelled, expired) returns 200 with the current status — no error. Only pending and initiated sessions are flipped.

POST /v1/checkout/{id}/expire

curl

cURL

curl -X POST https://api.paybridgenp.com/v1/checkout/cs_01j9x2k3m4n5p6q7r8s9t0u1v2/expire \
  -H "Authorization: Bearer pk_sandbox_your_key"

200

{
  "id": "cs_01j9x2k3m4n5p6q7r8s9t0u1v2",
  "status": "expired",
  "flow": "hosted",
  "provider": null,
  "expires_at": "2026-03-30T14:30:00.000Z"
}

Authorizations

Authorization · string · header · required

Your PayBridge API key. Obtain one from the dashboard under Settings → API Keys. Prefix: pk_sandbox_ for testing, pk_live_ for production.

Path Parameters

id · string · required

The checkout session id (e.g. cs_01j9x2k3m4n5p6q7r8s9t0u1v2).

Response

200

application/json

Session expired (or was already terminal).

id · string

Example:

"cs_01j9x2k3m4n5p6q7r8s9t0u1v2"

status · enum<string>

The session's current status after the expire call.

Available options: pending, initiated, success, failed, cancelled, expired

flow · enum<string>

Available options: hosted, redirect

provider · enum<string> | null

Available options: esewa, khalti, fonepay

expires_at · string<date-time>