Update session customer

Updates specific customer and billing information on an existing session. Provides a reduced scope update compared to modifying the entire session payload.

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

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

string
length ≤ 64

The unique identifier mapping the buyer to a FastSpring account. Requires an authenticated request.

string
length between 4 and 512

An external ID used to link the buyer to your internal systems. Requires an authenticated request.

billToContact
object

Capture the billing contact details used to process the payment, calculate localized taxes, and generate the invoice. Pass standard, single-buyer information here, as this acts as the primary contact for the order.

billToAddress
object

Capture the physical address associated with the buyer's payment method for tax calculation and invoicing.

shipToContact
object

Capture the recipient's contact and delivery details to ensure accurate fulfillment.

shipToAddress
object

Capture the physical destination address to ensure accurate delivery of shipped goods.

string
enum

Identifies the type of shipping destination mapping applied to the order.

Allowed:
accountTags
object

A key-value map of custom tags applied to the buyer's account. Requires an authenticated request.

string
length ≤ 255

Capture the buyer's VAT, GST, or CPF identification number used for tax calculation or exemption. Required for buyers located in Brazil.

string
length ≤ 2

The 2-letter state or province code associated with a US tax exemption.

Responses

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