customerportalorderslistrequest.md

CustomerPortalOrdersListRequest

Example Usage

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

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

Fields

Field	Type	Required	Description
organizationId	operations.CustomerPortalOrdersListQueryParamOrganizationIDFilter	➖	Filter by organization ID.
productId	operations.CustomerPortalOrdersListQueryParamProductIDFilter	➖	Filter by product ID.
productBillingType	operations.CustomerPortalOrdersListQueryParamProductBillingTypeFilter	➖	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.QueryParamProductPriceTypeFilter	➖	: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
subscriptionId	operations.CustomerPortalOrdersListQueryParamSubscriptionIDFilter	➖	Filter by subscription ID.
query	string	➖	Search by product or organization name.
page	number	➖	Page number, defaults to 1.
limit	number	➖	Size of a page, defaults to 10. Maximum is 100.
sorting	components.CustomerOrderSortProperty[]	➖	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.