Skip to content

Latest commit

 

History

History
64 lines (59 loc) · 7.15 KB

licensekeyread.md

File metadata and controls

64 lines (59 loc) · 7.15 KB

LicenseKeyRead

Example Usage

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

let value: LicenseKeyRead = {
  id: "<value>",
  organizationId: "<value>",
  customerId: "<value>",
  customer: {
    id: "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    createdAt: new Date("2023-01-03T22:46:45.258Z"),
    modifiedAt: new Date("2025-02-23T00:36:32.100Z"),
    metadata: {
      "key": "<value>",
    },
    externalId: "usr_1337",
    email: "[email protected]",
    emailVerified: true,
    name: "John Doe",
    billingAddress: {
      country: "FR",
    },
    taxId: [
      "911144442",
      "us_ein",
    ],
    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    deletedAt: new Date("2025-10-31T14:54:05.686Z"),
    avatarUrl: "https://www.gravatar.com/avatar/xxx?d=blank",
  },
  benefitId: "<value>",
  key: "<key>",
  displayKey: "<value>",
  status: "granted",
  limitActivations: 856930,
  usage: 993604,
  limitUsage: 533519,
  validations: 120252,
  lastValidatedAt: new Date("2025-12-19T22:26:18.159Z"),
  expiresAt: new Date("2024-09-23T16:59:27.865Z"),
};

Fields

Field Type Required Description
id string ✔️ N/A
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