Skip to content

Stripe: Retrieve a registration

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

← Tax operations · Get started

Operation stripe.gettaxregistrationsid

Provider route: GET /v1/tax/registrations/{id}. 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"]["getTaxRegistrationsId"]>[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.getTaxRegistrationsId(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_registrations_id(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.idstringRequired within parentMaximum length: 5000
queryobjectOptionalAdditional keys: not allowed
query.expandarrayOptional
query.expand[]stringEach itemMaximum length: 5000

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Create a registration — response body

Referenced models: Create a registration — response body

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

Create a registration — response body
FieldTypePresenceDescription and constraints
$objectRootA Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://docs.stripe.com/tax).

Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://docs.stripe.com/tax/registering).

Related guide: [Using the Registrations API](https://docs.stripe.com/tax/registrations-api)
active_fromJSONRequired within parent
active_from (anyOf 1)integerAlternativeTime at which the registration becomes active. Measured in seconds since the Unix epoch.
Format: unix-time
active_from (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
countrystringRequired within parentTwo-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
Maximum length: 5000
country_optionsModelRequired within parentExpand Create a registration — response body — country options
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_atJSONOptional
expires_at (anyOf 1)JSONAlternative
expires_at (anyOf 1) (anyOf 1)integerAlternativeIf set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.
Format: unix-time
expires_at (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at (anyOf 2)nullAlternative
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`.
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: tax.registration
statusstringRequired within parentThe status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`.
Known values: active, expired, scheduled

Referenced models: Create a registration — response body — country options

Create a registration — response body — country options ca
FieldTypePresenceDescription and constraints
$objectRoot
province_standardModelOptionalExpand Create a registration — response body — country options ca province standard
typestringRequired within parentType of registration in Canada.
Known values: province_standard, simplified, standard

Referenced models: Create a registration — response body — country options ca province standard

Create a registration — response body — country options al
FieldTypePresenceDescription and constraints
$objectRoot
typestringRequired within parentType of registration in `country`.
Known values: standard
Create a registration — response body — country options ae
FieldTypePresenceDescription and constraints
$objectRoot
standardModelOptionalExpand Create a registration — response body — country options ae standard
typestringRequired within parentType of registration in `country`.
Known values: standard

Referenced models: Create a registration — response body — country options ae standard

Create a registration — response body — country options at
FieldTypePresenceDescription and constraints
$objectRoot
standardModelOptionalExpand Create a registration — response body — country options at standard
typestringRequired within parentType of registration in an EU country.
Known values: ioss, oss_non_union, oss_union, standard

Referenced models: Create a registration — response body — country options at standard

Create a registration — response body — country options am
FieldTypePresenceDescription and constraints
$objectRoot
typestringRequired within parentType of registration in `country`.
Known values: simplified
Create a registration — response body — country options es
FieldTypePresenceDescription and constraints
$objectRoot
standardModelOptionalExpand Create a registration — response body — country options at standard
typestringRequired within parentType of registration in ES.
Known values: ioss, oss_non_union, oss_union, standard

Referenced models: Create a registration — response body — country options at standard

Create a registration — response body — country options ca province standard
FieldTypePresenceDescription and constraints
$objectRoot
provincestringRequired within parentTwo-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
Maximum length: 5000
Create a registration — response body — country options ae standard
FieldTypePresenceDescription and constraints
$objectRoot
place_of_supply_schemestringRequired within parentPlace of supply scheme used in an Default standard registration.
Known values: inbound_goods, standard
Create a registration — response body — country options at standard
FieldTypePresenceDescription and constraints
$objectRoot
place_of_supply_schemestringRequired within parentPlace of supply scheme used in an EU standard registration.
Known values: inbound_goods, small_seller, standard
Create a registration — response body — country options us admissions tax
FieldTypePresenceDescription and constraints
$objectRoot
jurisdictionstringRequired within parentA [jurisdiction code](https://docs.stripe.com/tax/registering?type=admissions_tax#registration-types) representing the local jurisdiction.
Maximum length: 5000
Create a registration — response body — country options us attendance tax
FieldTypePresenceDescription and constraints
$objectRoot
jurisdictionstringRequired within parentA [jurisdiction code](https://docs.stripe.com/tax/registering?type=attendance_tax#registration-types) representing the local jurisdiction.
Maximum length: 5000
Create a registration — response body — country options us entertainment tax
FieldTypePresenceDescription and constraints
$objectRoot
jurisdictionstringRequired within parentA [jurisdiction code](https://docs.stripe.com/tax/registering?type=entertainment_tax#registration-types) representing the local jurisdiction.
Maximum length: 5000
Create a registration — response body — country options us gross receipts tax
FieldTypePresenceDescription and constraints
$objectRoot
jurisdictionstringRequired within parentA [jurisdiction code](https://docs.stripe.com/tax/registering?type=gross_receipts_tax#registration-types) representing the local jurisdiction.
Maximum length: 5000
Create a registration — response body — country options us hospitality tax
FieldTypePresenceDescription and constraints
$objectRoot
jurisdictionstringRequired within parentA [jurisdiction code](https://docs.stripe.com/tax/registering?type=hospitality_tax#registration-types) representing the local jurisdiction.
Maximum length: 5000
Create a registration — response body — country options us local lease tax
FieldTypePresenceDescription and constraints
$objectRoot
jurisdictionstringRequired within parentA [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.
Maximum length: 5000
Create a registration — response body — country options us luxury tax
FieldTypePresenceDescription and constraints
$objectRoot
jurisdictionstringRequired within parentA [jurisdiction code](https://docs.stripe.com/tax/registering?type=luxury_tax#registration-types) representing the local jurisdiction.
Maximum length: 5000

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