Skip to content

Latest commit

 

History

History
16 lines (13 loc) · 7.36 KB

productslistrequest.md

File metadata and controls

16 lines (13 loc) · 7.36 KB

ProductsListRequest

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 *bool Filter on archived products.
IsRecurring *bool 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 *int64 Page number, defaults to 1.
Limit *int64 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.