Skip to content

Latest commit

 

History

History
157 lines (152 loc) · 6.17 KB

listresourcecustomersubscription.md

File metadata and controls

157 lines (152 loc) · 6.17 KB

ListResourceCustomerSubscription

Example Usage

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

let value: ListResourceCustomerSubscription = {
  items: [
    {
      createdAt: new Date("2024-03-11T02:59:33.614Z"),
      modifiedAt: new Date("2024-03-29T23:14:03.744Z"),
      id: "<value>",
      amount: 451500,
      currency: "Surinam Dollar",
      recurringInterval: "year",
      status: "incomplete_expired",
      currentPeriodStart: new Date("2024-08-10T18:13:26.660Z"),
      currentPeriodEnd: new Date("2023-04-12T06:47:40.524Z"),
      cancelAtPeriodEnd: false,
      canceledAt: new Date("2024-12-23T10:43:11.589Z"),
      startedAt: new Date("2025-06-14T17:06:06.978Z"),
      endsAt: new Date("2023-12-26T14:12:43.086Z"),
      endedAt: new Date("2023-02-12T19:10:30.424Z"),
      customerId: "<value>",
      productId: "<value>",
      discountId: "<value>",
      checkoutId: "<value>",
      customerCancellationReason: "missing_features",
      customerCancellationComment: "<value>",
      product: {
        createdAt: new Date("2024-08-26T10:45:27.151Z"),
        modifiedAt: new Date("2023-04-22T21:32:32.069Z"),
        id: "<value>",
        name: "<value>",
        description:
          "structure in low runway enfold suburban phony lest unknown insignificant",
        recurringInterval: "month",
        isRecurring: false,
        isArchived: false,
        organizationId: "<value>",
        prices: [
          {
            createdAt: new Date("2025-05-08T05:59:03.649Z"),
            modifiedAt: new Date("2025-06-05T00:32:47.556Z"),
            id: "<value>",
            isArchived: false,
            productId: "<value>",
            recurringInterval: "year",
            priceCurrency: "<value>",
            priceAmount: 250192,
          },
        ],
        benefits: [
          {
            id: "<value>",
            createdAt: new Date("2024-07-04T14:44:38.499Z"),
            modifiedAt: new Date("2025-06-20T00:53:11.661Z"),
            type: "discord",
            description:
              "boo coil anti unknown brr pleased fortunately mid impressionable",
            selectable: false,
            deletable: false,
            organizationId: "<value>",
          },
        ],
        medias: [
          {
            id: "<value>",
            organizationId: "<value>",
            name: "<value>",
            path: "/usr/sbin",
            mimeType: "<value>",
            size: 593429,
            storageVersion: "<value>",
            checksumEtag: "<value>",
            checksumSha256Base64: "<value>",
            checksumSha256Hex: "<value>",
            lastModifiedAt: new Date("2025-11-26T11:28:59.050Z"),
            version: "<value>",
            isUploaded: false,
            createdAt: new Date("2025-09-01T11:43:31.742Z"),
            sizeReadable: "<value>",
            publicUrl: "https://exhausted-import.net",
          },
        ],
        organization: {
          createdAt: new Date("2023-06-05T14:22:16.192Z"),
          modifiedAt: new Date("2024-02-12T00:01:30.244Z"),
          id: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
          name: "<value>",
          slug: "<value>",
          avatarUrl: "https://small-fraudster.info/",
          email: "[email protected]",
          website: "<value>",
          socials: [
            {
              platform: "x",
              url: "https://comfortable-bar.name",
            },
          ],
          detailsSubmittedAt: new Date("2023-09-27T02:24:48.308Z"),
          featureSettings: {},
          subscriptionSettings: {
            allowMultipleSubscriptions: false,
            allowCustomerUpdates: false,
            prorationBehavior: "invoice",
          },
        },
      },
      prices: [
        {
          createdAt: new Date("2025-09-11T17:51:40.735Z"),
          modifiedAt: new Date("2025-04-18T01:23:11.576Z"),
          id: "<value>",
          isArchived: false,
          productId: "<value>",
          type: "one_time",
          recurringInterval: "month",
          priceCurrency: "<value>",
          minimumAmount: 5730,
          maximumAmount: 626389,
          presetAmount: 241367,
        },
      ],
      meters: [
        {
          createdAt: new Date("2025-03-22T15:54:14.387Z"),
          modifiedAt: new Date("2024-09-05T08:53:23.453Z"),
          id: "<value>",
          consumedUnits: 25,
          creditedUnits: 100,
          amount: 0,
          meterId: "d498a884-e2cd-4d3e-8002-f536468a8b22",
          meter: {
            createdAt: new Date("2025-01-13T01:23:29.478Z"),
            modifiedAt: new Date("2024-02-29T13:35:40.295Z"),
            id: "<value>",
            name: "<value>",
          },
        },
      ],
    },
  ],
  pagination: {
    totalCount: 660386,
    maxPage: 57171,
  },
};

Fields

Field Type Required Description
items components.CustomerSubscription[] ✔️ N/A
pagination components.Pagination ✔️ N/A