Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 8.11 KB

orderslistrequest.md

File metadata and controls

23 lines (18 loc) · 8.11 KB

OrdersListRequest

Example Usage

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

let value: OrdersListRequest = {};

Fields

Field Type Required Description
organizationId operations.OrdersListQueryParamOrganizationIDFilter Filter by organization ID.
productId operations.OrdersListQueryParamProductIDFilter Filter by product ID.
productPriceType operations.ProductPriceTypeFilter Filter by product price type. recurring will return orders corresponding to subscriptions creations or renewals. one_time will return orders corresponding to one-time purchases.
discountId operations.QueryParamDiscountIDFilter Filter by discount ID.
customerId operations.OrdersListQueryParamCustomerIDFilter Filter by customer ID.
checkoutId operations.CheckoutIDFilter Filter by checkout ID.
page number Page number, defaults to 1.
limit number Size of a page, defaults to 10. Maximum is 100.
sorting components.OrderSortProperty[] 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.