Skip to content

Stripe: Retrieve a Transaction's line items

Stripe tax.getTaxTransactionsTransactionLineItems: arguments, response, policy and SDK examples.

← Tax operations · Get started

Operation stripe.gettaxtransactionstransactionlineitems

Provider route: GET /v1/tax/transactions/{transaction}/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["tax"]["getTaxTransactionsTransactionLineItems"]>[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.tax.getTaxTransactionsTransactionLineItems(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.tax.get_tax_transactions_transaction_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.transactionstringRequired within parentMaximum length: 5000
queryobjectOptionalAdditional keys: not allowed
query.ending_beforestringOptionalMaximum length: 500
query.expandarrayOptional
query.expand[]stringEach itemMaximum length: 5000
query.limitintegerOptional
query.starting_afterstringOptionalMaximum length: 500

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 Transaction’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
Pattern: ^/v1/tax/transactions/[^/]+/line_items

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

Retrieve a Transaction's line items — response body — data item
FieldTypePresenceDescription and constraints
$objectRootA Tax Transaction Line Item represents an individual item in a Tax Transaction.
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeThe line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount_taxJSONRequired within parent
amount_tax (anyOf 1)integerAlternativeThe amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
amount_tax (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
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: tax.transaction_line_item
productJSONOptional
product (anyOf 1)stringAlternativeThe ID of an existing [Product](https://docs.stripe.com/api/products/object).
Maximum length: 5000
product (anyOf 2)nullAlternative
quantityJSONRequired within parent
quantity (anyOf 1)integerAlternativeThe number of units of the item being purchased. For reversals, this is the quantity reversed.
quantity (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
referencestringRequired within parentA custom identifier for this line item in the transaction.
Maximum length: 5000
reversalJSONOptional
reversal (anyOf 1)JSONAlternativeIf `type=reversal`, contains information about what was reversed.
reversal (anyOf 1) (anyOf 1)ModelAlternativeExpand Retrieve a Transaction's line items — response body — data item reversal value original line item
reversal (anyOf 2)nullAlternative
tax_behaviorstringRequired within parentSpecifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
Known values: exclusive, inclusive
tax_codestringRequired within parentThe [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource.
Maximum length: 5000
typestringRequired within parentIf `reversal`, this line item reverses an earlier transaction.
Known values: reversal, transaction

Referenced models: Retrieve a Transaction's line items — response body — data item reversal value original line item

Retrieve a Transaction's line items — response body — data item reversal value original line item
FieldTypePresenceDescription and constraints
$objectRoot
original_line_itemstringRequired within parentThe `id` of the line item to reverse in the original transaction.
Maximum length: 5000

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