benefitslistrequest.md

BenefitsListRequest

Example Usage

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

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

Fields

Field	Type	Required	Description
organizationId	operations.BenefitsListQueryParamOrganizationIDFilter	➖	Filter by organization ID.
typeFilter	operations.BenefitTypeFilter	➖	Filter by benefit type.
query	string	➖	Filter by description.
page	number	➖	Page number, defaults to 1.
limit	number	➖	Size of a page, defaults to 10. Maximum is 100.
sorting	components.BenefitSortProperty[]	➖	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.