Sign in

Delete API v1 checkout sessions by ID

Changed on
delete/api/v1/checkout/sessions/{id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

idstring required

ID of the checkout session

Example:cs_123

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

createdinteger required
idstring required
modestring required
statusstring required
subscription_idstring
urlstring required

Example response

{
  "$schema": "https://example.com/schemas/StripeCheckoutSessionResponse.json",
  "created": 1700000000,
  "id": "cs_test_12345",
  "mode": "subscription",
  "status": "open",
  "subscription_id": "sub_12345",
  "url": "https://checkout.stripe.com/c/pay/cs_test_12345"
}

Changes