Stripe: Retrieve a Calculation

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

Operation stripe.gettaxcalculationscalculation

Provider route: GET /v1/tax/calculations/{calculation}. 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["tax"]["getTaxCalculationsCalculation"]>[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.getTaxCalculationsCalculation(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(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.calculation`	string	Required within parent	Maximum length: 5000
`query`	object	Optional	Additional keys: not allowed
`query.expand`	array	Optional
`query.expand[]`	string	Each item	Maximum length: 5000

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 Calculation — response body

Referenced models: Create a Calculation — response body

Schemas

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

Create a Calculation — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A Tax Calculation allows you to calculate the tax to collect from your customer. Related guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom)
`amount_total`	JSON	Required within parent
`amount_total (anyOf 1)`	integer	Alternative	Total amount after taxes in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
`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). Maximum length: 5000
`customer`	JSON	Optional
`customer (anyOf 1)`	string	Alternative	The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource. Maximum length: 5000
`customer (anyOf 2)`	null	Alternative
`customer_details`	Model	Required within parent	Expand Create a Calculation — response body — customer details
`expires_at`	JSON	Optional
`expires_at (anyOf 1)`	JSON	Alternative
`expires_at (anyOf 1) (anyOf 1)`	integer	Alternative	Timestamp of date at which the tax calculation will expire. Format: unix-time
`expires_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`expires_at (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	Unique identifier for the calculation. Maximum length: 5000
`id (anyOf 2)`	null	Alternative
`line_items`	JSON	Optional
`line_items (anyOf 1)`	object	Alternative	The list of items the customer is purchasing.
`line_items (anyOf 1).data`	array	Required within parent	Details about each object.
`line_items (anyOf 1).data[]`	Model	Each item	Expand Retrieve a Calculation's line items — response body — data item
`line_items (anyOf 1).has_more`	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
`line_items (anyOf 1).object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list
`line_items (anyOf 1).url`	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/tax/calculations/[^/]+/line_items
`line_items (anyOf 2)`	null	Alternative
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: tax.calculation
`ship_from_details`	JSON	Optional
`ship_from_details (anyOf 1)`	JSON	Alternative	The details of the ship from location, such as the address.
`ship_from_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Create a Calculation — response body — ship from details value address
`ship_from_details (anyOf 2)`	null	Alternative
`shipping_cost`	JSON	Optional
`shipping_cost (anyOf 1)`	JSON	Alternative	The shipping cost details for the calculation.
`shipping_cost (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Create a Calculation — response body — shipping_cost / The shipping cost details for the calculation / tax_behavior: exclusive, inclusive
`shipping_cost (anyOf 2)`	null	Alternative
`tax_amount_exclusive`	JSON	Required within parent
`tax_amount_exclusive (anyOf 1)`	integer	Alternative	The amount of tax to be collected on top of the line item prices.
`tax_amount_exclusive (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`tax_amount_inclusive`	JSON	Required within parent
`tax_amount_inclusive (anyOf 1)`	integer	Alternative	The amount of tax already included in the line item prices.
`tax_amount_inclusive (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`tax_breakdown`	array	Required within parent	Breakdown of individual tax amounts that add up to the total.
`tax_breakdown[]`	Model	Each item	Expand Create a Calculation — response body — tax breakdown item
`tax_date`	JSON	Required within parent
`tax_date (anyOf 1)`	integer	Alternative	The calculation uses the tax rules and rates that are in effect at this timestamp. You can use a date up to 31 days in the past or up to 31 days in the future. If you use a future date, Stripe doesn't guarantee that the expected tax rules and rate being used match the actual rules and rate that will be in effect on that date. We deploy tax changes before their effective date, but not within a fixed window. Format: unix-time
`tax_date (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a Calculation's line items — response body — data item, Create a Calculation — response body — customer details, Create a Calculation — response body — ship from details value address, Create a Calculation — response body — tax breakdown item, Create a Calculation — response body — shipping_cost / The shipping cost details for the calculation / tax_behavior: exclusive, inclusive

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

Field	Type	Presence	Description and constraints
`$`	object	Root	A Tax Calculation Line Item represents a single item in a tax calculation.
`amount`	JSON	Required within parent
`amount (anyOf 1)`	integer	Alternative	The 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)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`amount_tax`	JSON	Required within parent
`amount_tax (anyOf 1)`	integer	Alternative	The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#minor-units).
`amount_tax (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`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: tax.calculation_line_item
`performance_location`	JSON	Optional
`performance_location (anyOf 1)`	string	Alternative	Indicates 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)`	null	Alternative
`product`	JSON	Optional
`product (anyOf 1)`	string	Alternative	The ID of an existing [Product](https://docs.stripe.com/api/products/object). Maximum length: 5000
`product (anyOf 2)`	null	Alternative
`quantity`	JSON	Required within parent
`quantity (anyOf 1)`	integer	Alternative	The number of units of the item being purchased. For reversals, this is the quantity reversed.
`quantity (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`reference`	string	Required within parent	A custom identifier for this line item. Maximum length: 5000
`tax_behavior`	string	Required within parent	Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. Known values: exclusive, inclusive
`tax_breakdown`	JSON	Optional
`tax_breakdown (anyOf 1)`	array	Alternative	Detailed account of taxes relevant to this line item.
`tax_breakdown (anyOf 1)[]`	Model	Each item	Expand Retrieve a Calculation's line items — response body — data item tax breakdown array item
`tax_breakdown (anyOf 2)`	null	Alternative
`tax_code`	string	Required within parent	The [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

Policy, approvals and errors

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