AdminGetTaxRatesParams

Parameters used to filter and configure the pagination of the retrieved tax rates.

Properties

region_idstring | string[]

Filter tax rates by the IDs of their associates region.

namestring

Name to filter tax rates by.

codestring

Code to filter tax rates by.

ratenumber | NumericalComparisonOperator

Number filters to filter tax rates' rate field.

offsetnumber

The number of items to skip when retrieving a list.

Default: 0

limitnumber

Limit the number of items returned in the list.

Default: 50

expandstring[]

Comma-separated relations that should be expanded in the returned data.

fieldsstring[]

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

orderstring

updated_atDateComparisonOperator

Date filters to apply on the tax rates' update_at date.

created_atDateComparisonOperator

Date filters to apply on the customer tax rates' created_at date.

deleted_atDateComparisonOperator

Date filters to apply on the tax rates' deleted_at date.

qstring

Term used to search tax rates by name.