GET
/v1/tax/registrationsList tax registrations
Lists Tax Registration objects for the merchant. Use status to filter registrations and ending_before or starting_after with limit to paginate the collection.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
ending_beforestringoptional
An object ID cursor that returns registrations before the specified position.
expandarray<string>optional
Fields to expand in the response. Each expansion name can be up to 5000 characters.
limitintegeroptional
Maximum number of registrations to return. Must be between 1 and 100. Defaults to 10 when omitted.
starting_afterstringoptional
An object ID cursor that returns registrations after the specified position.
statusstringoptional
Filters registrations by status: active, all, expired, or scheduled.
200Returns a list object containing Tax Registration objects, pagination metadata, the `list` object type, and the collection URL.
dataarray<TaxRegistration>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultReturned when the API reports an error. The response contains an `error` object with an error type and may include a message, code, parameter, or related resource.
errorobjectrequired
Error handling
status must be one of: active, all, expired, or scheduled. limit must be between 1 and 100 and defaults to 10 when omitted; use ending_before or starting_after as object ID cursors for pagination.