Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 7.66 KB

customerportalbenefitgrantslistrequest.md

File metadata and controls

27 lines (22 loc) · 7.66 KB

CustomerPortalBenefitGrantsListRequest

Example Usage

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

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

Fields

Field Type Required Description
typeFilter operations.QueryParamBenefitTypeFilter ➖ Filter by benefit type.
benefitId operations.CustomerPortalBenefitGrantsListQueryParamBenefitIDFilter ➖ Filter by benefit ID.
organizationId operations.CustomerPortalBenefitGrantsListQueryParamOrganizationIDFilter ➖ Filter by organization ID.
checkoutId operations.QueryParamCheckoutIDFilter ➖ Filter by checkout ID.
orderId operations.QueryParamOrderIDFilter ➖ Filter by order ID.
subscriptionId operations.QueryParamSubscriptionIDFilter ➖ Filter by subscription 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.