Skip to content

checkoutslistrequest.md

Latest commit

 

History

History
25 lines (20 loc) · 7.58 KB

checkoutslistrequest.md

File metadata and controls

25 lines (20 loc) · 7.58 KB
Raw

CheckoutsListRequest

Example Usage

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

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

Fields

Field Type Required Description
organizationId operations.CheckoutsListQueryParamOrganizationIDFilter ➖ Filter by organization ID.
productId operations.CheckoutsListQueryParamProductIDFilter ➖ Filter by product ID.
customerId operations.CheckoutsListQueryParamCustomerIDFilter ➖ Filter by customer ID.
externalCustomerId operations.CheckoutsListQueryParamExternalCustomerIDFilter ➖ Filter by customer external ID.
status operations.CheckoutsListQueryParamStatusFilter ➖ Filter by checkout session status.
query string ➖ Filter by customer email.
page number ➖ Page number, defaults to 1.
limit number ➖ Size of a page, defaults to 10. Maximum is 100.
sorting components.CheckoutSortProperty[] ➖ 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.