Skip to main content

List checkout sessions

GEThttps://api.radom.com/checkout_sessions

Authorization

Send your API key in the Authorization header. Scheme: radomToken.

Parameters

offsetinteger<int64>query
limitinteger<int64>query
statusCheckoutSessionStatusquery

Responses

200List of checkout sessions retrieved successfully
idstring<uuid>required

Unique identifier for the checkout session.

sessionStatusCheckoutSessionStatusrequired
AllowedpendingsuccesscancelledexpiredrefundedrefundFailed
organizationIdstring<uuid>required

Product's owning organization ID.

sellerPaymentAddressstringnullable

Seller's payment address (optional).

totalnumber<float>nullable>= 0

Total price of checkout (optional).

currencyCurrencynullable
AllowedUSDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATIC
successUrlstringrequired

Redirect URL after checkout is completed.

cancelUrlstringnullable

Redirect URL if checkout fails (optional).

subscriptionBackButtonUrlstringnullable

URL for subscription cancel/back button.

expiresAtstring<date-time>nullable

Time at which the checkout session expires (optional).

createdAtstring<date-time>required

Time at which the checkout session was created.

updatedAtstring<date-time>required

Time at which the checkout session was last updated.

chargeCustomerNetworkFeebooleanrequired

Whether or not to pass the network fee to the customer to pay, in addition to the total supplied. If this is false, the network fee is subtracted from the supplied total, otherwise, it's added to the total. Defaults to true.

401Unauthorized
errorstringrequired
500Internal server error
errorstringrequired