Skip to content

subscriptionslistrequest.md

Latest commit

 

History

History
31 lines (26 loc) · 11.6 KB

subscriptionslistrequest.md

File metadata and controls

31 lines (26 loc) · 11.6 KB
Raw

SubscriptionsListRequest

Example Usage

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

let value: SubscriptionsListRequest = {
  organizationId: null,
};

Fields

Field Type Required Description
organizationId operations.OrganizationIDFilter ➖ Filter by organization ID.
productId operations.ProductIDFilter ➖ Filter by product ID.
customerId operations.CustomerIDFilter ➖ Filter by customer ID.
externalCustomerId operations.ExternalCustomerIDFilter ➖ Filter by customer external ID.
discountId operations.DiscountIDFilter ➖ Filter by discount ID.
active boolean ➖ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Filter by active or inactive subscription.
status operations.StatusFilter ➖ Filter by subscription status.
cancelAtPeriodEnd boolean ➖ Filter by subscriptions that are set to cancel at period end.
customerCancellationReason operations.CustomerCancellationReasonFilter ➖ Filter by customer cancellation reason.
canceledAtAfter Date ➖ Filter by cancellation date (after or equal to).
canceledAtBefore Date ➖ Filter by cancellation date (before or equal to).
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.
metadata Record<string, components.MetadataQuery> ➖ Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.