The Tax Registration object

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring

    String representing the object’s type. Objects of the same type share the same value.

  • active_fromtimestamp

    Time at which the registration becomes active. Measured in seconds since the Unix epoch.

  • countrystring

    Two-letter country code (ISO 3166-1 alpha-2).

  • country_optionsobject

    Specific options for a registration in the specified country.

  • createdtimestamp

    Time at which the object was created. Measured in seconds since the Unix epoch.

  • expires_atnullable timestamp

    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.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • statusenum

    The status of the registration. This field is present for convenience and can be deduced from active_from and expires_at.

    Possible enum values
    active

    The Tax Registration is currently active.

    expired

    The Tax Registration is no longer active.

    scheduled

    The Tax Registration will become active in the future.

The Tax Registration object
{
"id": "taxreg_NkyGPRPytKq66j",
"object": "tax.registration",
"active_from": 1682036640,
"country": "US",
"country_options": {
"us": {
"state": "CA",
"type": "state_sales_tax"
}
},
"created": 1682006400,
"expires_at": null,
"livemode": false,
"status": "active",
"state": "CA",
"type": "standard"
}

Create a registration

Creates a new Tax Registration object.

Parameters

  • active_fromstring | timestampRequired

    Time at which the Tax Registration becomes active. It can be either now to indicate the current time, or a future timestamp measured in seconds since the Unix epoch.

  • countrystringRequired

    Two-letter country code (ISO 3166-1 alpha-2).

  • country_optionsobjectRequired

    Specific options for a registration in the specified country.

  • expires_attimestamp

    If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch.

Returns

A Tax Registration object.

POST /v1/tax/registrations
curl https://api.stripe.com/v1/tax/registrations \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d country=US \
-d "country_options[us][state]"=CA \
-d "country_options[us][type]"=state_sales_tax \
-d active_from=now
Response
{
"id": "taxreg_NkyGPRPytKq66j",
"object": "tax.registration",
"active_from": 1682036640,
"country": "US",
"country_options": {
"us": {
"state": "CA",
"type": "state_sales_tax"
}
},
"created": 1682006400,
"expires_at": null,
"livemode": false,
"status": "active",
"state": "CA",
"type": "standard"
}

Update a registration

Updates an existing Tax Registration object.

A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

Parameters

  • active_fromstring | timestamp

    Time at which the registration becomes active. It can be either now to indicate the current time, or a timestamp measured in seconds since the Unix epoch.

  • expires_atstring | timestamp

    If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either now to indicate the current time, or a timestamp measured in seconds since the Unix epoch.

Returns

A Tax Registration object.

POST /v1/tax/registrations/:id
curl https://api.stripe.com/v1/tax/registrations/taxreg_NkyGPRPytKq66j \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d expires_at=now
Response
{
"id": "taxreg_NkyGPRPytKq66j",
"object": "tax.registration",
"active_from": 1683036640,
"country": "US",
"country_options": {
"us": {
"state": "CA",
"type": "state_sales_tax"
}
},
"created": 1682006400,
"expires_at": 1684072000,
"livemode": false,
"status": "active",
"state": "CA",
"type": "standard"
}

Retrieve a registration

Returns a Tax Registration object.

Parameters

No parameters.

Returns

A Tax Registration object.

GET /v1/tax/registrations/:id
curl https://api.stripe.com/v1/tax/registrations/taxreg_NkyGPRPytKq66j \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
"id": "taxreg_NkyGPRPytKq66j",
"object": "tax.registration",
"active_from": 1682036640,
"country": "US",
"country_options": {
"us": {
"state": "CA",
"type": "state_sales_tax"
}
},
"created": 1682006400,
"expires_at": null,
"livemode": false,
"status": "active",
"state": "CA",
"type": "standard"
}

List registrations

Returns a list of Tax Registration objects.

Parameters

  • statusenum

    The status of the Tax Registration.

    Possible enum values
    active

    Return all active Tax Registrations.

    all

    Return all Tax Registrations (default).

    expired

    Return all expired Tax Registrations.

    scheduled

    Return all scheduled Tax Registrations.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

A list of Tax Registration objects.

GET /v1/tax/registrations
curl -G https://api.stripe.com/v1/tax/registrations \
-u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
-d limit=3
Response
{
"object": "list",
"url": "/v1/tax/registrations",
"has_more": false,
"data": [
{
"id": "taxreg_NkyGPRPytKq66j",
"object": "tax.registration",
"active_from": 1682036640,
"country": "US",
"country_options": {
"us": {
"state": "CA",
"type": "state_sales_tax"
}
},
"created": 1682006400,
"expires_at": null,
"livemode": false,
"status": "active",
"state": "CA",
"type": "standard"
}
{...}
{...}
],
}
Stripe Shell
Test mode
Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Log in to your Stripe account and press Control + Backtick (`) on your keyboard to start managing your Stripe resources in test mode. - View supported Stripe commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g., )
The Stripe Shell is best experienced on desktop.
$