Skip to main content
Skip to main content

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.
idstring | string[] | OperatorMap<string | string[]>
The IDs to filter the regions by.
namestring | OperatorMap<string>
Filter regions by their name.
currency_codestring | OperatorMap<string>
Filter regions by their currency code.
metadataRecord<string, unknown> | OperatorMap<Record<string, unknown>>
Filter regions by their metadata.
created_atOperatorMap<string>
Filter regions by their creation date.
updated_atOperatorMap<string>
Filter regions by their update date.
Was this section helpful?