customerslistrequest.md

CustomersListRequest

Example Usage

import { CustomersListRequest } from "@polar-sh/sdk/models/operations/customerslist.js";

let value: CustomersListRequest = {
  organizationId: [
    "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  ],
};

Fields

Field	Type	Required	Description
organizationId	operations.CustomersListQueryParamOrganizationIDFilter	➖	Filter by organization ID.
email	string	➖	Filter by exact email.
query	string	➖	Filter by name or email.
page	number	➖	Page number, defaults to 1.
limit	number	➖	Size of a page, defaults to 10. Maximum is 100.
sorting	components.CustomerSortProperty[]	➖	Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
metadata	Record<string, components.MetadataQuery>	➖	Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.