Update checkout session

This endpoint requires the checkout-sessions.write scope.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

checkout_session_id

string

required

The unique ID for a Checkout Session.

Body

application/json

cart_items

object[] | null

An array of cart items that represents the line items of a transaction.

cart_items.name

string

required

The name of the cart item. The value you set for this property may be truncated if the maximum length accepted by a payment service provider is less than 255 characters.

cart_items.quantity

integer

required

The quantity of this item in the cart. This value cannot be negative or zero.

cart_items.unit_amount

integer

requireddeprecated

The amount for an individual item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99. The amount sent through to the payment processor as unitary amount will be calculated to include the discount and tax values sent as part of this cart item.

cart_items.discount_amount

integer | null

default: 0

The amount discounted for this item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99.

Please note that this amount is for the total of the cart item and not for an individual item. For example, if the quantity is 5, this value should be the total discount amount for 5 of the cart item.

You might see unexpected failed transactions if the discount_amount can not be equally divided by the quantity value. This is due to the fact that some payment services require this amount to be specified per unit.

In this situation we recommend splitting this item into separate items, each with their own specific discount.

cart_items.tax_amount

integer | null

default: 0

The tax amount for this item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99.

Please not that this amount is for the total of the cart item and not for an individual item. For example, if the quantity is 5, this value should be the total tax amount for 5 of the cart item.

You might see unexpected failed transactions if the tax_amount can not be equally divided by the quantity value. This is due to the fact that some payment services require this amount to be specified per unit.

In this situation we recommend splitting this item into separate items, each with their own specific tax amount.

cart_items.external_identifier

string | null

An external identifier for the cart item. This can be set to any value and is not sent to the payment service.

cart_items.sku

string | null

The SKU for the item.

cart_items.product_url

string | null

The product URL for the item.

cart_items.image_url

string | null

The URL for the image of the item.

cart_items.categories

string[] | null

A list of strings containing product categories for the item. Max length per item: 50.

cart_items.product_type

enum<string> | null

The product type of the cart item.

Available options:

physical,

discount,

shipping_fee,

sales_tax,

digital,

gift_card,

store_credit,

surcharge

metadata

object | null

Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.

Response

200 - application/json

type

enum<string>

checkout-session.

Available options:

checkout-session

string

The ID of the Checkout Session.

expires_at

string

The date and time when the Checkout Session will expire. By default this will be set to 1 hour from the date of creation.

cart_items

object[] | null

An array of cart items that represents the line items of a transaction.

cart_items.name

string

required

The name of the cart item. The value you set for this property may be truncated if the maximum length accepted by a payment service provider is less than 255 characters.

cart_items.quantity

integer

required

The quantity of this item in the cart. This value cannot be negative or zero.

cart_items.unit_amount

integer

requireddeprecated

cart_items.discount_amount

integer | null

default: 0

The amount discounted for this item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99.

In this situation we recommend splitting this item into separate items, each with their own specific discount.

cart_items.tax_amount

integer | null

default: 0

The tax amount for this item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99.

Please not that this amount is for the total of the cart item and not for an individual item. For example, if the quantity is 5, this value should be the total tax amount for 5 of the cart item.

In this situation we recommend splitting this item into separate items, each with their own specific tax amount.

cart_items.external_identifier

string | null

An external identifier for the cart item. This can be set to any value and is not sent to the payment service.

cart_items.sku

string | null

The SKU for the item.

cart_items.product_url

string | null

The product URL for the item.

cart_items.image_url

string | null

The URL for the image of the item.

cart_items.categories

string[] | null

A list of strings containing product categories for the item. Max length per item: 50.

cart_items.product_type

enum<string> | null

The product type of the cart item.

Available options:

physical,

discount,

shipping_fee,

sales_tax,

digital,

gift_card,

store_credit,

surcharge

metadata

object | null

Any additional information about the transaction that you would like to store as key-value pairs. This data is passed to payment service providers that support it.

payment_method

object | null

Details about the payment method for card type only.

Payments

Instruments

Vault

Connections

Dashboard

Errors

Update checkout session

Authorizations

Path Parameters

Body

Response