Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 8.79 KB

orderslistrequest.md

File metadata and controls

26 lines (21 loc) · 8.79 KB

OrdersListRequest

Example Usage

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

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

Fields

Field Type Required Description
organizationId operations.OrdersListQueryParamOrganizationIDFilter ➖ Filter by organization ID.
productId operations.OrdersListQueryParamProductIDFilter ➖ Filter by product ID.
productBillingType operations.ProductBillingTypeFilter ➖ Filter by product billing type. recurring will filter data corresponding to subscriptions creations or renewals. one_time will filter data corresponding to one-time purchases.
productPriceType operations.ProductPriceTypeFilter ➖ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
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.