Stripe: Update a Checkout Session

← Checkout operations · Get started

Operation stripe.postcheckoutsessionssession

Provider route: POST /v1/checkout/sessions/{session}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["checkout"]["postCheckoutSessionsSession"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.checkout.postCheckoutSessionsSession(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.checkout.post_checkout_sessions_session(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.session	string	Required within parent	Maximum length: 5000
headers	object	Optional	Additional keys: not allowed
headers.Idempotency-Key	string	Optional	Minimum length: 1 Maximum length: 255
body	object	Optional	Additional keys: not allowed
body.collected_information	object	Optional	Information about the customer collected within the Checkout Session. Can only be set when updating `embedded_page` or `elements` sessions.
body.collected_information.shipping_details	object	Optional
body.collected_information.shipping_details.address	object	Required within parent
body.collected_information.shipping_details.address.city	string	Optional	Maximum length: 5000
body.collected_information.shipping_details.address.country	string	Required within parent	Maximum length: 5000
body.collected_information.shipping_details.address.line1	string	Required within parent	Maximum length: 5000
body.collected_information.shipping_details.address.line2	string	Optional	Maximum length: 5000
body.collected_information.shipping_details.address.postal_code	string	Optional	Maximum length: 5000
body.collected_information.shipping_details.address.state	string	Optional	Maximum length: 5000
body.collected_information.shipping_details.name	string	Required within parent	Maximum length: 255
body.expand	array	Optional	Specifies which fields in the response should be expanded.
body.expand[]	string	Each item	Maximum length: 5000
body.line_items	array	Optional	A list of items the customer is purchasing. When updating line items, you must retransmit the entire array of line items. To retain an existing line item, specify its `id`. To update an existing line item, specify its `id` along with the new values of the fields to update. To add a new line item, specify one of `price` or `price_data` and `quantity`. To remove an existing line item, omit the line item’s ID from the retransmitted array. To reorder a line item, specify it at the desired position in the retransmitted array.
body.line_items[]	object	Each item
body.line_items[].adjustable_quantity	object	Optional
body.line_items[].adjustable_quantity.enabled	boolean	Required within parent
body.line_items[].adjustable_quantity.maximum	integer	Optional
body.line_items[].adjustable_quantity.minimum	integer	Optional
body.line_items[].id	string	Optional	Maximum length: 5000
body.line_items[].metadata	JSON	Optional
body.line_items[].metadata (anyOf 1)	object	Alternative	Additional keys: see wildcard field
body.line_items[].metadata (anyOf 1).*	string	Additional keys
body.line_items[].metadata (anyOf 2)	string	Alternative	One of:
body.line_items[].price	string	Optional	Maximum length: 5000
body.line_items[].price_data	Model	Optional	Expand Create a payment link — request body — body line items item price data
body.line_items[].quantity	integer	Optional
body.line_items[].tax_rates	JSON	Optional
body.line_items[].tax_rates (anyOf 1)	array	Alternative
body.line_items[].tax_rates (anyOf 1)[]	string	Each item	Maximum length: 5000
body.line_items[].tax_rates (anyOf 2)	string	Alternative	One of:
body.metadata	JSON	Optional	Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`.
body.metadata (anyOf 1)	object	Alternative	Additional keys: see wildcard field
body.metadata (anyOf 1).*	string	Additional keys
body.metadata (anyOf 2)	string	Alternative	One of:
body.shipping_options	JSON	Optional	The shipping rate options to apply to this Session. Up to a maximum of 5.
body.shipping_options (anyOf 1)	array	Alternative
body.shipping_options (anyOf 1)[]	Model	Each item	Expand Create a Checkout Session — request body — body shipping options item
body.shipping_options (anyOf 2)	string	Alternative	One of:

Referenced models: Create a payment link — request body — body line items item price data, Create a Checkout Session — request body — body shipping options item

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create a Checkout Session — response body

Referenced models: Create a Checkout Session — response body

Schemas

797 more schemas are linked from the tables above, on the schema pages.

Create a payment link — request body — body line items item price data

Field	Type	Presence	Description and constraints
$	object	Root
currency	string	Required within parent	Format: currency
product	string	Optional	Maximum length: 5000
product_data	Model	Optional	Expand Update an invoice's line item — request body — body price data product data
recurring	object	Optional
recurring.interval	string	Required within parent	One of: day, month, week, year
recurring.interval_count	integer	Optional
tax_behavior	string	Optional	One of: exclusive, inclusive, unspecified
unit_amount	integer	Optional
unit_amount_decimal	string	Optional	Format: decimal

Referenced models: Update an invoice's line item — request body — body price data product data

Create a Checkout Session — request body — body shipping options item

Field	Type	Presence	Description and constraints
$	object	Root
shipping_rate	string	Optional	Maximum length: 5000
shipping_rate_data	Model	Optional	Expand Create an invoice — request body — body shipping cost shipping rate data

Referenced models: Create an invoice — request body — body shipping cost shipping rate data

Create a Checkout Session — response body — wallet options value link

Field	Type	Presence	Description and constraints
$	object	Root
link	Model	Optional	Expand Create a Checkout Session — response body — wallet options value link link

Referenced models: Create a Checkout Session — response body — wallet options value link link

Delete a customer — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Always true for a deleted object Known values: True
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: customer

Retrieve a quote's line items — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root	A line item.
adjustable_quantity	JSON	Optional
adjustable_quantity (anyOf 1)	JSON	Alternative
adjustable_quantity (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve a quote's line items — response body — data item adjustable quantity value enabled, maximum, minimum
adjustable_quantity (anyOf 2)	null	Alternative
amount_discount	JSON	Required within parent
amount_discount (anyOf 1)	integer	Alternative	Total discount amount applied. If no discounts were applied, defaults to 0.
amount_discount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_subtotal	JSON	Required within parent
amount_subtotal (anyOf 1)	integer	Alternative	Total before any discounts or taxes are applied.
amount_subtotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_tax	JSON	Required within parent
amount_tax (anyOf 1)	integer	Alternative	Total tax amount applied. If no tax was applied, defaults to 0.
amount_tax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_total	JSON	Required within parent
amount_total (anyOf 1)	integer	Alternative	Total after discounts and taxes.
amount_total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Required within parent	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency
description	JSON	Optional
description (anyOf 1)	string	Alternative	An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. Maximum length: 5000
description (anyOf 2)	null	Alternative
discounts	array	Optional	The discounts applied to the line item.
discounts[]	Model	Each item	Expand Retrieve a quote's line items — response body — data item discounts item
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
metadata	JSON	Optional
metadata (anyOf 1)	object	Alternative	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata (anyOf 1).*	string	Additional keys	Maximum length: 500
metadata (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: item
price	JSON	Optional
price (anyOf 1)	JSON	Alternative	The price used to generate the line item.
price (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a price — response body
price (anyOf 2)	null	Alternative
quantity	JSON	Optional
quantity (anyOf 1)	JSON	Alternative
quantity (anyOf 1) (anyOf 1)	integer	Alternative	The quantity of products being purchased.
quantity (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)	null	Alternative
taxes	array	Optional	The taxes applied to the line item.
taxes[]	Model	Each item	Expand Retrieve a quote's line items — response body — data item taxes item

Referenced models: Retrieve a quote's line items — response body — data item adjustable quantity value enabled, maximum, minimum, Retrieve a quote's line items — response body — data item discounts item, Retrieve a quote's line items — response body — data item taxes item, Create a price — response body

Cancel a refund — response body — presentment details

Field	Type	Presence	Description and constraints
$	object	Root
presentment_amount	JSON	Required within parent
presentment_amount (anyOf 1)	integer	Alternative	Amount intended to be collected by this payment, denominated in `presentment_currency`.
presentment_amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
presentment_currency	string	Required within parent	Currency presented to the customer during payment. Maximum length: 5000

Create a payment link — response body — custom text

Field	Type	Presence	Description and constraints
$	object	Root
after_submit	JSON	Optional
after_submit (anyOf 1)	JSON	Alternative	Custom text that should be displayed after the payment confirmation button.
after_submit (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — custom text submit value message
after_submit (anyOf 2)	null	Alternative
shipping_address	JSON	Optional
shipping_address (anyOf 1)	JSON	Alternative	Custom text that should be displayed alongside shipping address collection.
shipping_address (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — custom text submit value message
shipping_address (anyOf 2)	null	Alternative
submit	JSON	Optional
submit (anyOf 1)	JSON	Alternative	Custom text that should be displayed alongside the payment confirmation button.
submit (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — custom text submit value message
submit (anyOf 2)	null	Alternative
terms_of_service_acceptance	JSON	Optional
terms_of_service_acceptance (anyOf 1)	JSON	Alternative	Custom text that should be displayed in place of the default terms of service agreement text.
terms_of_service_acceptance (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a payment link — response body — custom text submit value message
terms_of_service_acceptance (anyOf 2)	null	Alternative

Referenced models: Create a payment link — response body — custom text submit value message

Policy, approvals and errors

SDK function policy ID: stripe.postcheckoutsessionssession. Catalog operation: PostCheckoutSessionsSession. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source