Skip to main content
POST
Cancel Session

Authorizations

Authorization
string
header
required

API key (sk_test_* or sk_live_*)

Path Parameters

session_id
string<uuid>
required

Body

application/json
cancellation_reason
enum<string>
Available options:
duplicate,
fraudulent,
requested_by_customer,
abandoned

Response

Session canceled

id
string<uuid>
object
enum<string>
Available options:
payment_session
status
enum<string>
Available options:
requires_payment_method,
requires_action,
processing,
succeeded,
failed,
canceled
amount
integer
currency
string
client_secret
string
customer_email
string
customer_name
string
capture_method
enum<string>
Available options:
automatic,
manual
payment_method_types
enum<string>[]
Available options:
card,
apple_pay,
google_pay,
bank_account,
paypal
metadata
object
created_at
string<date-time>
livemode
boolean