Stripe: Update settings

← Tax operations · Get started

Operation stripe.posttaxsettings

Provider route: POST /v1/tax/settings. 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"]["postTaxSettings"]>[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.postTaxSettings(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.post_tax_settings(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
headers	object	Optional	Additional keys: not allowed
headers.Idempotency-Key	string	Optional	Minimum length: 1 Maximum length: 255
body	object	Optional	Additional keys: not allowed
body.defaults	object	Optional	Default configuration to be used on Stripe Tax calculations.
body.defaults.tax_behavior	string	Optional	One of: exclusive, inclusive, inferred_by_currency
body.defaults.tax_code	string	Optional
body.expand	array	Optional	Specifies which fields in the response should be expanded.
body.expand[]	string	Each item	Maximum length: 5000
body.head_office	object	Optional	The place where your business is located.
body.head_office.address	object	Required within parent
body.head_office.address.city	string	Optional	Maximum length: 5000
body.head_office.address.country	string	Optional	Maximum length: 5000
body.head_office.address.line1	string	Optional	Maximum length: 5000
body.head_office.address.line2	string	Optional	Maximum length: 5000
body.head_office.address.postal_code	string	Optional	Maximum length: 5000
body.head_office.address.state	string	Optional	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 Update settings — response body

Referenced models: Update settings — response body

Schemas

Update settings — response body

Field	Type	Presence	Description and constraints
$	object	Root	You can use Tax `Settings` to manage configurations used by Stripe Tax calculations. Related guide: [Using the Settings API](https://docs.stripe.com/tax/settings-api)
defaults	Model	Required within parent	Expand Update settings — response body — defaults
head_office	JSON	Optional
head_office (anyOf 1)	JSON	Alternative	The place where your business is located.
head_office (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — billing
head_office (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.settings
status	string	Required within parent	Whether these settings have the information Stripe Tax needs to calculate tax. It doesn't reflect whether your integration is ready to collect tax. Known values: active, pending
status_details	Model	Required within parent	Expand Update settings — response body — status details

Referenced models: Create a cardholder — response body — billing, Update settings — response body — defaults, Update settings — response body — status details

Create a cardholder — response body — billing

Field	Type	Presence	Description and constraints
$	object	Root
address	Model	Required within parent	Expand Create a Location — response body — address

Referenced models: Create a Location — response body — address

Update settings — response body — defaults

Field	Type	Presence	Description and constraints
$	object	Root
provider	string	Required within parent	The tax calculation provider this account uses. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps). Known values: anrok, avalara, sphere, stripe
tax_behavior	JSON	Optional
tax_behavior (anyOf 1)	string	Alternative	Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior. Known values: exclusive, inclusive, inferred_by_currency
tax_behavior (anyOf 2)	null	Alternative
tax_code	JSON	Optional
tax_code (anyOf 1)	string	Alternative	Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices. Maximum length: 5000
tax_code (anyOf 2)	null	Alternative

Update settings — response body — status details

Field	Type	Presence	Description and constraints
$	object	Root
active	Model	Optional	Expand Create a Payment Method — response body — zip
pending	Model	Optional	Expand Update settings — response body — status details pending

Referenced models: Create a Payment Method — response body — zip, Update settings — response body — status details pending

Create a Location — response body — address

Field	Type	Presence	Description and constraints
$	object	Root
city	JSON	Optional
city (anyOf 1)	string	Alternative	City, district, suburb, town, or village. Maximum length: 5000
city (anyOf 2)	null	Alternative
country	JSON	Optional
country (anyOf 1)	string	Alternative	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000
country (anyOf 2)	null	Alternative
line1	JSON	Optional
line1 (anyOf 1)	string	Alternative	Address line 1, such as the street, PO Box, or company name. Maximum length: 5000
line1 (anyOf 2)	null	Alternative
line2	JSON	Optional
line2 (anyOf 1)	string	Alternative	Address line 2, such as the apartment, suite, unit, or building. Maximum length: 5000
line2 (anyOf 2)	null	Alternative
postal_code	JSON	Optional
postal_code (anyOf 1)	string	Alternative	ZIP or postal code. Maximum length: 5000
postal_code (anyOf 2)	null	Alternative
state	JSON	Optional
state (anyOf 1)	string	Alternative	State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). Maximum length: 5000
state (anyOf 2)	null	Alternative

Create a Payment Method — response body — zip

Field	Type	Presence	Description and constraints
$	object	Root

Update settings — response body — status details pending

Field	Type	Presence	Description and constraints
$	object	Root
missing_fields	JSON	Optional
missing_fields (anyOf 1)	array	Alternative	The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call.
missing_fields (anyOf 1)[]	string	Each item	Maximum length: 5000
missing_fields (anyOf 2)	null	Alternative

Policy, approvals and errors

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