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
nowto 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
nowto 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"}
Retrieve a registration
GET / v1 / tax / registrations /:id
Returns a Tax Registration object.
Parameters
No parameters.
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"}
List registrations
GET / v1 / tax / registrations
Returns a list of Tax Registration objects.
Parameters
- status enum The status of the Tax Registration. Possible enum values
activeReturn all active Tax Registrations.allReturn all Tax Registrations (default).expiredReturn all expired Tax Registrations.scheduledReturn all scheduled Tax Registrations.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
A list of Tax Registration objects.
Response
