Stripe: List all tax codes
Stripe taxCodes.getTaxCodes: arguments, response, policy and SDK examples.
← Tax codes operations · Get started
Operation stripe.gettaxcodes
Provider route: GET /v1/tax_codes. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["taxCodes"]["getTaxCodes"]>[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.taxCodes.getTaxCodes(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_codes.get_tax_codes(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.ending_before | string | Optional | |
query.expand | array | Optional | |
query.expand[] | string | Each item | Maximum length: 5000 |
query.limit | integer | Optional | |
query.starting_after | string | Optional |
Response
Section titled “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 |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Details about each object. |
data[] | Model | Each item | Expand Retrieve a tax code — response body |
has_more | boolean | Required within parent | True if this list has another page of items after this one that can be fetched. |
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 |
url | string | Required within parent | The URL where this list can be accessed. Maximum length: 5000 |
Referenced models: Retrieve a tax code — response body
Schemas
Section titled “Schemas”Retrieve a tax code — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | [Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes. |
description | string | Required within parent | A detailed description of which types of products the tax code represents. Maximum length: 5000 |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
name | string | Required within parent | A short name for the tax code. 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: tax_code |
requirements | JSON | Optional | |
requirements (anyOf 1) | JSON | Alternative | An object that describes more information about the tax location required for this tax code. Some tax codes require a [performance location](/tax/location-sales#required-versus-optional-performance-locations) to calculate tax correctly. |
requirements (anyOf 1) (anyOf 1) | Model | Alternative | Expand Retrieve a tax code — response body — requirements / value / performance_location: optional, required |
requirements (anyOf 2) | null | Alternative |
Referenced models: Retrieve a tax code — response body — requirements / value / performance_location: optional, required
Retrieve a tax code — response body — requirements / value / performance_location: optional, required
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
performance_location | string | Required within parent | Describes whether a performance location is required for a successful tax calculation with a tax code. Known values: optional, required |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: stripe.gettaxcodes. Catalog operation: GetTaxCodes. 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"}