Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Session

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.

put/v2/checkouts/{checkoutPath}/sessions/{sessionId}/customer

Path parameters

checkoutPathstring 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.

Example:fastspring/main
sessionIdstring required

The unique identifier of the order session.

Example:OS123456789012345ABC

Request body

accountIdstring

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

externalAccountIdstring regex

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

shipToType'GIFT_PURCHASE' | 'SHIP_TO' | 'SAME_AS_BILL_TO'

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

accountTagsobject

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

taxIdstring

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

taxIdRegionstring

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

Example request

{
  "accountId": "ABC1234567890",
  "externalAccountId": "EXT-98765",
  "billToContact": {
    "email": "support@fastspring.com",
    "firstName": "John",
    "lastName": "Doe",
    "company": "FastSpring",
    "phoneNumber": "555-555-5555"
  },
  "billToAddress": {
    "addressLine1": "801 Garden Street",
    "addressLine2": "suite 201",
    "city": "Santa Barbara",
    "region": "CA",
    "postalCode": "93101"
  },
  "shipToContact": {
    "email": "support@fastspring.com",
    "firstName": "John",
    "lastName": "Doe",
    "company": "FastSpring",
    "phoneNumber": "555-555-5555"
  },
  "shipToAddress": {
    "addressLine1": "801 Garden Street",
    "addressLine2": "suite 201",
    "city": "Santa Barbara",
    "region": "CA",
    "postalCode": "93101"
  },
  "shipToType": "SAME_AS_BILL_TO",
  "accountTags": {
    "customerType": "VIP"
  },
  "taxId": "DE123456789",
  "taxIdRegion": "CA"
}

Response

Successfully updated the customer details.

accountIdstring

The unique identifier mapping the buyer to a FastSpring account record. Revealed only on authenticated requests.

externalAccountIdstring

The external ID mapping the buyer to a seller's internal platform. Revealed only on authenticated requests.

accountTagsobject

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

taxIdstring

The buyer's active VAT, GST, or CPF identification number.

taxIdRegionstring

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

Example response

{
  "accountId": "ABC1234567890",
  "externalAccountId": "EXT-98765",
  "savedPaymentMethod": {
    "paymentMethodType": "CARD",
    "display": "VISA - 4242"
  },
  "billToContact": {
    "email": "support@fastspring.com",
    "firstName": "John",
    "lastName": "Doe",
    "company": "FastSpring",
    "phoneNumber": "555-555-5555"
  },
  "billToAddress": {
    "addressLine1": "801 Garden Street",
    "addressLine2": "suite 201",
    "city": "Santa Barbara",
    "region": "CA",
    "postalCode": "93101"
  },
  "shipToContact": {
    "email": "support@fastspring.com",
    "firstName": "John",
    "lastName": "Doe",
    "company": "FastSpring",
    "phoneNumber": "555-555-5555"
  },
  "shipToAddress": {
    "addressLine1": "801 Garden Street",
    "addressLine2": "suite 201",
    "city": "Santa Barbara",
    "region": "CA",
    "postalCode": "93101"
  },
  "accountTags": {
    "customerType": "VIP"
  },
  "taxId": "DE123456789",
  "taxIdRegion": "CA"
}