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 valuefalse
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_
andfrom expires_
.at Possible enum valuesactive
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", "state": "CA", "type": "standard"}
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.
{ "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"}
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_
.
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.
{ "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"}
Returns a Tax Registration
object.
Parameters
No parameters.
Returns
A 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"}
Returns a list of Tax Registration
objects.
Parameters
- statusenum
The status of the Tax Registration.
Possible enum valuesactive
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.
{ "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" } {...} {...} ],}