Skip to content

licensekeyread.md

Latest commit

 

History

History
69 lines (64 loc) · 8.02 KB

licensekeyread.md

File metadata and controls

69 lines (64 loc) · 8.02 KB
Raw

LicenseKeyRead

Example Usage

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

let value: LicenseKeyRead = {
  id: "<value>",
  createdAt: new Date("2024-01-03T22:46:45.258Z"),
  modifiedAt: new Date("2024-05-31T06:40:27.766Z"),
  organizationId: "<value>",
  customerId: "<value>",
  customer: {
    id: "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    createdAt: new Date("2026-05-26T00:47:20.880Z"),
    modifiedAt: new Date("2025-02-25T21:20:13.315Z"),
    metadata: {
      "key": 1857.67,
    },
    externalId: "usr_1337",
    email: "customer@example.com",
    emailVerified: true,
    type: "team",
    name: "John Doe",
    billingAddress: {
      country: "US",
    },
    taxId: [
      "911144442",
      "us_ein",
    ],
    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    deletedAt: new Date("2025-02-19T00:49:10.274Z"),
    avatarUrl: "https://www.gravatar.com/avatar/xxx?d=404",
  },
  benefitId: "<value>",
  key: "<key>",
  displayKey: "<value>",
  status: "disabled",
  limitActivations: 943998,
  usage: 58668,
  limitUsage: 993604,
  validations: 533519,
  lastValidatedAt: new Date("2026-12-19T22:26:18.159Z"),
  expiresAt: new Date("2026-10-26T06:39:38.603Z"),
};

Fields

Field Type Required Description
id string ✔️ The ID of the object.
createdAt Date ✔️ Creation timestamp of the object.
modifiedAt Date ✔️ Last modification timestamp of the object.
organizationId string ✔️ N/A
customerId string ✔️ N/A
customer components.LicenseKeyCustomer ✔️ N/A
benefitId string ✔️ The benefit ID.
key string ✔️ N/A
displayKey string ✔️ N/A
status components.LicenseKeyStatus ✔️ N/A
limitActivations number ✔️ N/A
usage number ✔️ N/A
limitUsage number ✔️ N/A
validations number ✔️ N/A
lastValidatedAt Date ✔️ N/A
expiresAt Date ✔️ N/A