Stripe: List registrations

← Tax operations · Get started

Operation stripe.gettaxregistrations

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

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.ending_before	string	Optional	Maximum length: 5000
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000
query.limit	integer	Optional
query.starting_after	string	Optional	Maximum length: 5000
query.status	string	Optional	One of: active, all, expired, scheduled

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
data[]	Model	Each item	Expand Create a registration — 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 Pattern: ^/v1/tax/registrations

Referenced models: Create a registration — response body

Schemas

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

Create a registration — response body

Field	Type	Presence	Description and constraints
$	object	Root	A 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_from	JSON	Required within parent
active_from (anyOf 1)	integer	Alternative	Time at which the registration becomes active. Measured in seconds since the Unix epoch. Format: unix-time
active_from (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
country	string	Required within parent	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Maximum length: 5000
country_options	Model	Required within parent	Expand Create a registration — response body — country options
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at	JSON	Optional
expires_at (anyOf 1)	JSON	Alternative
expires_at (anyOf 1) (anyOf 1)	integer	Alternative	If 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)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at (anyOf 2)	null	Alternative
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`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: tax.registration
status	string	Required within parent	The 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

Field	Type	Presence	Description and constraints
$	object	Root
province_standard	Model	Optional	Expand Create a registration — response body — country options ca province standard
type	string	Required within parent	Type 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

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	Type of registration in `country`. Known values: standard

Create a registration — response body — country options ae

Field	Type	Presence	Description and constraints
$	object	Root
standard	Model	Optional	Expand Create a registration — response body — country options ae standard
type	string	Required within parent	Type 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

Field	Type	Presence	Description and constraints
$	object	Root
standard	Model	Optional	Expand Create a registration — response body — country options at standard
type	string	Required within parent	Type 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

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	Type of registration in `country`. Known values: simplified

Create a registration — response body — country options es

Field	Type	Presence	Description and constraints
$	object	Root
standard	Model	Optional	Expand Create a registration — response body — country options at standard
type	string	Required within parent	Type 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

Field	Type	Presence	Description and constraints
$	object	Root
province	string	Required within parent	Two-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

Field	Type	Presence	Description and constraints
$	object	Root
place_of_supply_scheme	string	Required within parent	Place of supply scheme used in an Default standard registration. Known values: inbound_goods, standard

Create a registration — response body — country options at standard

Field	Type	Presence	Description and constraints
$	object	Root
place_of_supply_scheme	string	Required within parent	Place 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

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [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

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [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

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [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

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [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

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [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

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [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

Field	Type	Presence	Description and constraints
$	object	Root
jurisdiction	string	Required within parent	A [jurisdiction code](https://docs.stripe.com/tax/registering?type=luxury_tax#registration-types) representing the local jurisdiction. Maximum length: 5000

Policy, approvals and errors

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