Skip to main content
PUT
checkout_sid_json_order_shipping_address_put

Headers

If-Unmodified-Since
string

Optional header. The put request is discarded and a 412 is returned if the header does not match the updated_at property of the session.

Path Parameters

session_id
string<checkout-id>
required

The session ID

Body

application/json

Address

first_name
string
Example:

"John"

last_name
string
Example:

"Doe"

address_line
string

Gaustadalleen 21

address_line_2
string

PB 123

co_address
string
Example:

"Land Lord"

business_name
string

Name of the company

postal_code
string

The zip code / postal code of the address.

Example:

"0349"

postal_place
string

The name of the postal code

Example:

"Oslo"

country
string<iso3166-alpha2>

Country of the location

Example:

"NO"

phone_number
string

mobile number of a person / company, ITU/E.123 format with international prefix (+PPNNNNNNNNN...)

Pattern: ^\+?\d{5,15}$
email
string

The email address of a person or an organization

latitude
number
longitude
number
comment
string

Comment about the address

organization_number
string

The organization number of the customer.

organization_type
string

Type indicating what kind of organization it is.

customer_reference
string

The customer's reference

cost_center
string

For companies that needs to specify a cost center.

Response

checkout session

url
object
required
order
object
required
configuration
object
required
id
string

An ID that uniquely identifies the resource

created_at
string<date-time>

The date-time when the resource was created

customer
object
expires_at
string<date-time>
checkboxes
object[]

Configuration for checkboxes that should be part of the checkout

Maximum array length: 2
express
object

Present only for Express Checkout sessions.

An Express Checkout session is a session where the end user will submit a shipping address and then select a shipping option before the before a payment method is selected and the payment is initiated.

Endpoints used in the Express Checkout flow.

  1. Set shipping address
  2. Set shipping option
metadata
object

metadata about the session

operations
object[]

Set of operation available, which operation available will depend on the current state of the session.

Example:
version
string

String that represents the state of the session.

Example:

"22596363b3de40b06f981fb85d82312e8c0ed511"

data_visibility
enum<string>
Available options:
full,
masked
Last modified on July 14, 2026