Skip to content

Stripe: Retrieve a Calculation's line items

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

← Tax operations · Get started

Operation stripe.gettaxcalculationscalculationlineitems

Provider route: GET /v1/tax/calculations/{calculation}/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"]["getTaxCalculationsCalculationLineItems"]>[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.getTaxCalculationsCalculationLineItems(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_calculations_calculation_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.calculationstringRequired 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 Calculation’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/calculations/[^/]+/line_items

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

Retrieve a Calculation's line items — response body — data item
FieldTypePresenceDescription and constraints
$objectRootA Tax Calculation Line Item represents a single item in a tax calculation.
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.calculation_line_item
performance_locationJSONOptional
performance_location (anyOf 1)stringAlternativeIndicates the line item represents a performance where the venue location might determine the tax, not the customer address. Leave empty if the tax code doesn't require a tax location. If you provide this value for tax codes with an `optional` location requirement, it overrides the customer address.
Maximum length: 5000
performance_location (anyOf 2)nullAlternative
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.
Maximum length: 5000
tax_behaviorstringRequired within parentSpecifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.
Known values: exclusive, inclusive
tax_breakdownJSONOptional
tax_breakdown (anyOf 1)arrayAlternativeDetailed account of taxes relevant to this line item.
tax_breakdown (anyOf 1)[]ModelEach itemExpand Retrieve a Calculation's line items — response body — data item tax breakdown array item
tax_breakdown (anyOf 2)nullAlternative
tax_codestringRequired within parentThe [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource.
Maximum length: 5000

Referenced models: Retrieve a Calculation's line items — response body — data item tax breakdown array item

Retrieve a Calculation's line items — response body — data item tax breakdown array item
FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)integerAlternativeThe amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
jurisdictionModelRequired within parentExpand Retrieve a Calculation's line items — response body — data item tax breakdown array item jurisdiction
sourcingstringRequired within parentIndicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address).
Known values: destination, origin, performance
tax_rate_detailsJSONOptional
tax_rate_details (anyOf 1)JSONAlternativeDetails regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.
tax_rate_details (anyOf 1) (anyOf 1)ModelAlternativeExpand Retrieve a Calculation's line items — response body — data item tax breakdown array item tax rate details value display name, percentage decimal, tax type
tax_rate_details (anyOf 2)nullAlternative
taxability_reasonstringRequired within parentThe 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
taxable_amountJSONRequired within parent
taxable_amount (anyOf 1)integerAlternativeThe amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
taxable_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a Calculation's line items — response body — data item tax breakdown array item jurisdiction, Retrieve a Calculation's line items — response body — data item tax breakdown array item tax rate details value display name, percentage decimal, tax type

Retrieve a Calculation's line items — response body — data item tax breakdown array item jurisdiction
FieldTypePresenceDescription and constraints
$objectRoot
countrystringRequired within parentTwo-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
Maximum length: 5000
display_namestringRequired within parentA human-readable name for the jurisdiction imposing the tax.
Maximum length: 5000
levelstringRequired within parentIndicates the level of the jurisdiction imposing the tax.
Known values: city, country, county, district, state
stateJSONOptional
state (anyOf 1)stringAlternative[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
Maximum length: 5000
state (anyOf 2)nullAlternative
Retrieve a Calculation's line items — response body — data item tax breakdown array item tax rate details value display name, percentage decimal, tax type
FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parentA localized display name for tax type, intended to be human-readable. For example, "Local Sales and Use Tax", "Value-added tax (VAT)", or "Umsatzsteuer (USt.)".
Maximum length: 5000
percentage_decimalstringRequired within parentThe tax rate percentage as a string. For example, 8.5% is represented as "8.5".
Maximum length: 5000
tax_typestringRequired within parentThe tax type, such as `vat` or `sales_tax`.
Known values: admissions_tax, amusement_tax, attendance_tax, communications_tax, digital_excise_tax, entertainment_tax, gross_receipts_tax, gst, hospitality_tax, hst, igst, jct, lease_tax, luxury_tax, mass_transit_parking_tax, parking_tax, pst, qst, recycling_fee, resort_tax, retail_delivery_fee, rst, sales_tax, service_tax, tourism_tax, utility_users_tax, vat

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