Developer Hub
Sign In

Update session

put
https://api.fastspring.com/v2/checkouts//sessions/

Updates an existing order session. Overwrites customer details, items, and custom prices with the provided arrays. Requires an authenticated request to modify restricted fields.

Path Params
string
required

The unique identifier for the checkout instance, in the format store-id/checkout-id (e.g., fastspring/main).

Note: Target a specific checkout path to route the session to a single buyer experience and ensure accurate pricing. Stores frequently run multiple checkout variations simultaneously.

string
required
length ≤ 64

The unique identifier of the order session.

Body Params

The primary request payload used to formulate a new order session.

string
length ≤ 5

Set the language for the buyer's experience. Accepts standard 2-letter language codes (e.g., en). Defaults to the browser locale if omitted.

string
^[A-Za-z]{2}$

The 2-letter ISO country code defining the buyer's billing location. Inferred from buyerIp if omitted.

string
length ≤ 39

The IPv4 or IPv6 address of the buyer. Used to infer country and currency if they are omitted. When executing an authenticated server-to-server request, this field acts as an override.

boolean
Defaults to true

Indicate whether the session processes in live mode (true) or test mode (false).
Review the Test orders documentation to learn how to safely simulate the buyer experience using test credit cards.

Note: If the targeted checkout is set to 'test mode' in your checkout settings, this value automatically defaults to false regardless of what you pass in the request.

customer
object

Specifies the customer and billing information applied to the order session.

orderTags
object

A key-value map of custom metadata attached to the finalized order record. Requires an authenticated request.

cart
object

The collection of line items and applied promotions constituting the order session.

paymentMethodOrder
array of objects

Dictates the explicit sorting order of payment methods presented to the buyer. Unsupported payment methods are automatically suppressed. Requires an authenticated request.

paymentMethodOrder
hidePaymentMethods
array of objects

Explicitly filters the provided payment methods from the buyer's interface. Requires an authenticated request.

hidePaymentMethods
Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?