Skip to content

Stripe: Retrieve a Checkout Session's line items

Stripe checkout.getCheckoutSessionsSessionLineItems: arguments, response, policy and SDK examples.

← Checkout operations · Get started

Operation stripe.getcheckoutsessionssessionlineitems

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

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"]["getCheckoutSessionsSessionLineItems"]>[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.getCheckoutSessionsSessionLineItems(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.get_checkout_sessions_session_line_items(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.sessionstringRequired within parentMaximum length: 5000
queryobjectOptionalAdditional keys: not allowed
query.ending_beforestringOptionalMaximum length: 5000
query.expandarrayOptional
query.expand[]stringEach itemMaximum length: 5000
query.limitintegerOptional
query.starting_afterstringOptionalMaximum length: 5000

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

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentDetails about each object.
data[]ModelEach itemExpand Retrieve a quote’s line items — response body — data item
has_morebooleanRequired within parentTrue if this list has another page of items after this one that can be fetched.
objectstringRequired within parentString representing the object’s type. Objects of the same type share the same value. Always has the value `list`.
Known values: list
urlstringRequired within parentThe URL where this list can be accessed.
Maximum length: 5000

Referenced models: Retrieve a quote’s line items — response body — data item

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

Retrieve a quote's line items — response body — data item
FieldTypePresenceDescription and constraints
$objectRootA line item.
adjustable_quantityJSONOptional
adjustable_quantity (anyOf 1)JSONAlternative
adjustable_quantity (anyOf 1) (anyOf 1)ModelAlternativeExpand Retrieve a quote's line items — response body — data item adjustable quantity value enabled, maximum, minimum
adjustable_quantity (anyOf 2)nullAlternative
amount_discountJSONRequired within parent
amount_discount (anyOf 1)integerAlternativeTotal discount amount applied. If no discounts were applied, defaults to 0.
amount_discount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_subtotalJSONRequired within parent
amount_subtotal (anyOf 1)integerAlternativeTotal before any discounts or taxes are applied.
amount_subtotal (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_taxJSONRequired within parent
amount_tax (anyOf 1)integerAlternativeTotal tax amount applied. If no tax was applied, defaults to 0.
amount_tax (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_totalJSONRequired within parent
amount_total (anyOf 1)integerAlternativeTotal after discounts and taxes.
amount_total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringRequired within parentThree-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
descriptionJSONOptional
description (anyOf 1)stringAlternativeAn arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
Maximum length: 5000
description (anyOf 2)nullAlternative
discountsarrayOptionalThe discounts applied to the line item.
discounts[]ModelEach itemExpand Retrieve a quote's line items — response body — data item discounts item
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
metadataJSONOptional
metadata (anyOf 1)objectAlternativeSet 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).*stringAdditional keysMaximum length: 500
metadata (anyOf 2)nullAlternative
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: item
priceJSONOptional
price (anyOf 1)JSONAlternativeThe price used to generate the line item.
price (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a price — response body
price (anyOf 2)nullAlternative
quantityJSONOptional
quantity (anyOf 1)JSONAlternative
quantity (anyOf 1) (anyOf 1)integerAlternativeThe quantity of products being purchased.
quantity (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity (anyOf 2)nullAlternative
taxesarrayOptionalThe taxes applied to the line item.
taxes[]ModelEach itemExpand 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

Retrieve a quote's line items — response body — data item adjustable quantity value enabled, maximum, minimum
FieldTypePresenceDescription and constraints
$objectRoot
enabledbooleanRequired within parent
maximumJSONOptional
maximum (anyOf 1)JSONAlternative
maximum (anyOf 1) (anyOf 1)integerAlternative
maximum (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maximum (anyOf 2)nullAlternative
minimumJSONOptional
minimum (anyOf 1)JSONAlternative
minimum (anyOf 1) (anyOf 1)integerAlternative
minimum (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minimum (anyOf 2)nullAlternative
Retrieve a quote's line items — response body — data item discounts item
FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeThe amount discounted.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
discountModelRequired within parentExpand Get Customers Customer Discount — response body

Referenced models: Get Customers Customer Discount — response body

Retrieve a quote's line items — response body — data item taxes item
FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeAmount of tax applied for this rate.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rateModelRequired within parentExpand Create a tax rate — response body
taxability_reasonJSONOptional
taxability_reason (anyOf 1)stringAlternativeThe reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
Known values: customer_exempt, not_collecting, not_subject_to_tax, not_supported, portion_product_exempt, portion_reduced_rated, portion_standard_rated, product_exempt, product_exempt_holiday, proportionally_rated, reduced_rated, reverse_charge, standard_rated, taxable_basis_reduced, zero_rated
taxability_reason (anyOf 2)nullAlternative
taxable_amountJSONOptional
taxable_amount (anyOf 1)JSONAlternative
taxable_amount (anyOf 1) (anyOf 1)integerAlternativeThe amount on which tax is calculated, in cents (or local equivalent).
taxable_amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
taxable_amount (anyOf 2)nullAlternative

Referenced models: Create a tax rate — response body

Create a price — response body — custom unit amount value maximum, minimum, preset
FieldTypePresenceDescription and constraints
$objectRoot
maximumJSONOptional
maximum (anyOf 1)JSONAlternative
maximum (anyOf 1) (anyOf 1)integerAlternativeThe maximum unit amount the customer can specify for this item.
maximum (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maximum (anyOf 2)nullAlternative
minimumJSONOptional
minimum (anyOf 1)JSONAlternative
minimum (anyOf 1) (anyOf 1)integerAlternativeThe minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
minimum (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minimum (anyOf 2)nullAlternative
presetJSONOptional
preset (anyOf 1)JSONAlternative
preset (anyOf 1) (anyOf 1)integerAlternativeThe starting unit amount which can be updated by the customer.
preset (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
preset (anyOf 2)nullAlternative
Delete a product — response body
FieldTypePresenceDescription and constraints
$objectRoot
deletedbooleanRequired within parentAlways true for a deleted object
Known values: True
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: product

SDK function policy ID: stripe.getcheckoutsessionssessionlineitems. Catalog operation: GetCheckoutSessionsSessionLineItems. 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.