Skip to content

Latest commit

 

History

History
37 lines (32 loc) · 5.35 KB

orderproduct.md

File metadata and controls

37 lines (32 loc) · 5.35 KB

OrderProduct

Example Usage

import { OrderProduct } from "@polar-sh/sdk/models/components/orderproduct.js";

let value: OrderProduct = {
  metadata: {
    "key": 100550,
  },
  createdAt: new Date("2023-06-01T03:16:51.095Z"),
  modifiedAt: new Date("2024-08-23T10:14:02.533Z"),
  id: "<value>",
  name: "<value>",
  description: "amongst parallel microblog though but",
  recurringInterval: "year",
  isRecurring: false,
  isArchived: false,
  organizationId: "<value>",
};

Fields

Field Type Required Description
metadata Record<string, components.OrderProductMetadata> ✔️ N/A
createdAt Date ✔️ Creation timestamp of the object.
modifiedAt Date ✔️ Last modification timestamp of the object.
id string ✔️ The ID of the product.
name string ✔️ The name of the product.
description string ✔️ The description of the product.
recurringInterval components.SubscriptionRecurringInterval ✔️ The recurring interval of the product. If None, the product is a one-time purchase.
isRecurring boolean ✔️ Whether the product is a subscription.
isArchived boolean ✔️ Whether the product is archived and no longer available.
organizationId string ✔️ The ID of the organization owning the product.