customerportalbenefitgrantslistrequest.md

CustomerPortalBenefitGrantsListRequest

Example Usage

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

let value: CustomerPortalBenefitGrantsListRequest = {};

Fields

Field	Type	Required	Description
query	string	➖	Filter by benefit description.
typeFilter	operations.QueryParamBenefitTypeFilter	➖	Filter by benefit type.
benefitId	operations.CustomerPortalBenefitGrantsListQueryParamBenefitIDFilter	➖	Filter by benefit ID.
checkoutId	operations.QueryParamCheckoutIDFilter	➖	Filter by checkout ID.
orderId	operations.CustomerPortalBenefitGrantsListQueryParamOrderIDFilter	➖	Filter by order ID.
subscriptionId	operations.CustomerPortalBenefitGrantsListQueryParamSubscriptionIDFilter	➖	Filter by subscription ID.
memberId	operations.QueryParamMemberIDFilter	➖	Filter by member ID.
page	number	➖	Page number, defaults to 1.
limit	number	➖	Size of a page, defaults to 10. Maximum is 100.
sorting	components.CustomerBenefitGrantSortProperty[]	➖	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.