POST /v1/checkout/sessions/{session}

Updates a Checkout Session object.

Related guide: Dynamically update Checkout

Servers

https://api.stripe.com/

Path parameters

Name	Type	Required	Description
`session`	String	Yes

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Request body fields

Name	Type	Required	Description
`collected_information`	Object	No	Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.
`collected_information.shipping_details`	Object	No
`collected_information.shipping_details.name`	String	Yes
`collected_information.shipping_details.address`	Object	Yes
`collected_information.shipping_details.address.line2`	String	No
`collected_information.shipping_details.address.line1`	String	Yes
`collected_information.shipping_details.address.postal_code`	String	No
`collected_information.shipping_details.address.country`	String	Yes
`collected_information.shipping_details.address.state`	String	No
`collected_information.shipping_details.address.city`	String	No
`shipping_options`		No	The shipping rate options to apply to this Session. Up to a maximum of 5.
`expand[]`	Array	No	Specifies which fields in the response should be expanded.
`metadata`		No	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.