Sign in

Cancel Checkout Session

post/checkout/v3/cancel

Headers

Authorizationstring required
Example:Bearer ba5af26a21ec497cb1551821c630d9f9

Authorization header in the format: Bearer ${checkoutSessionToken}.

The checkout session token is retrieved from the Create Checkout Session API and serves as the checkout session ID.

Response

Result.

isOrderCancelledboolean

Whether the checkout session is no longer available, and can't accept further payments. Note: This property only reflects the cancellation of the session, not the order. To track order status, listen for Order Events, or view the list of orders in the Publisher Dashboard.

Changes

No recorded changes to this endpoint across all 1 revision of this API.