Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 7.57 KB

productslistrequest.md

File metadata and controls

25 lines (20 loc) · 7.57 KB

ProductsListRequest

Example Usage

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

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

Fields

Field Type Required Description
id operations.QueryParamProductIDFilter ➖ Filter by product ID.
organizationId operations.ProductsListQueryParamOrganizationIDFilter ➖ Filter by organization ID.
query string ➖ Filter by product name.
isArchived boolean ➖ Filter on archived products.
isRecurring boolean ➖ Filter on recurring products. If true, only subscriptions tiers are returned. If false, only one-time purchase products are returned.
benefitId operations.BenefitIDFilter ➖ Filter products granting specific benefit.
page number ➖ Page number, defaults to 1.
limit number ➖ Size of a page, defaults to 10. Maximum is 100.
sorting components.ProductSortProperty[] ➖ 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.