FilterableRegionProps

The filters to apply on the retrieved regions.

An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.

An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.

qstringOptional

Find regions by name through this search term

idstring | string[] | OperatorMap<string | string[]>Optional

The IDs to filter the regions by.

namestring | OperatorMap<string>Optional

Filter regions by their name.

currency_codestring | OperatorMap<string>Optional

Filter regions by their currency code.

metadataRecord<string, unknown> | OperatorMap<Record<string, unknown>>Optional

Filter regions by their metadata.

created_atOperatorMap<string>Optional

Filter regions by their creation date.

updated_atOperatorMap<string>Optional

Filter regions by their update date.

Was this page helpful?