The Tax Registration object

Attributes

id string Unique identifier for the object.
object string, value is "tax.registration" String representing the object’s type. Objects of the same type share the same value.
active _ from timestamp Time at which the registration becomes active. Measured in seconds since the Unix epoch.
country string Two-letter country code ( ISO 3166-1 alpha-2).
country _ options object Specific options for a registration in the specified country.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
expires _ at nullable 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.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
status enum 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.

{ "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"}

Create a registration

POST / v1 / tax / registrations

Creates a new Tax Registration object.

Parameters

active _ from string, value is "now" | timestamp Required 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.
country string Required Two-letter country code ( ISO 3166-1 alpha-2).
country _ options object Required Specific options for a registration in the specified country.
expires _ at timestamp 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.

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"}

Update a registration

POST / v1 / tax / registrations /:id

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 _ from string, value is "now" | 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 _ at string, value is "now" | 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.

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"}