GET
/
checkout
/
carts
/
{id}

Authorizations

Authorization
string
headerrequired

Value for the Authorization header parameter.

Path Parameters

id
string
required

Cart identifier

Response

200 - application/json
id
string
status
enum<string>
default: open

The status of the cart.

Possible values:

  • open: The cart is open and can be edited.
  • confirming: The cart is confirming and cannot be edited.
Available options:
open,
confirming,
redirect_to_payment,
expired,
completed
customer
object

The customer who owns the cart.

customerEmail
object

The customer email which is used for the cart.

invoiceAddress
object
paymentMethod
object

The payment method which should be used for the cart.

createdAt
string
updatedAt
string
completedAt
string | null
redirectUrl
string | null
items
object[]

The items of the cart.

invoice
object

The invoice of the cart. If the cart total amount is zero, no invoice will be created.

subscription
object

The subscription of the cart. If the cart has no recurring items (has only one-time fees), no subscription will be created.

metadata
string[]

A collection of key-value pairs that can be linked to an object. This feature is beneficial for storing extra details regarding the object in an organized manner. To remove all keys, simply submit an empty value to the metadata.

Was this page helpful?

Retrieves completed carts of the current tenantRetrieves a cart by its id 1