subscriptionslistrequest.md

SubscriptionsListRequest

Example Usage

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

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

Fields

Field	Type	Required	Description
organizationId	operations.SubscriptionsListQueryParamOrganizationIDFilter	➖	Filter by organization ID.
productId	operations.ProductIDFilter	➖	Filter by product ID.
customerId	operations.CustomerIDFilter	➖	Filter by customer ID.
discountId	operations.DiscountIDFilter	➖	Filter by discount ID.
active	boolean	➖	Filter by active or inactive subscription.
page	number	➖	Page number, defaults to 1.
limit	number	➖	Size of a page, defaults to 10. Maximum is 100.
sorting	components.SubscriptionSortProperty[]	➖	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.