GET
/v1/tax/settingsRetrieve tax settings
Retrieves the Tax Settings for a merchant. Use expand when you need selected fields expanded in the returned configuration, including the defaults and current status details.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
expandarray<string>optional
Fields to expand in the response. Each expansion name can be up to 5000 characters.
200Returns a Tax Settings object containing default tax configuration, status, status details, live-mode information, and any configured head-office details.
defaultsobjectrequired
head_officeobjectoptional
The place where your business is located.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
statusstringrequired
The status of the Tax `Settings`.
status_detailsobjectrequired
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
Each expand value can be up to 5000 characters. The request body has no defined fields, so provide configuration through the supported query parameter.