Skip to content

Latest commit

 

History

History
71 lines (66 loc) · 10.2 KB

validatedlicensekey.md

File metadata and controls

71 lines (66 loc) · 10.2 KB

ValidatedLicenseKey

Example Usage

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

let value: ValidatedLicenseKey = {
  id: "<value>",
  organizationId: "<value>",
  userId: "<value>",
  customerId: "<value>",
  user: {
    id: "<value>",
    email: "[email protected]",
    publicName: "<value>",
  },
  customer: {
    createdAt: new Date("2025-12-30T13:22:32.320Z"),
    modifiedAt: new Date("2025-11-02T00:33:03.085Z"),
    id: "<value>",
    metadata: {
      "key": false,
    },
    externalId: "<id>",
    email: "[email protected]",
    emailVerified: false,
    name: "<value>",
    billingAddress: {
      country: "Malta",
    },
    taxId: [
      "<id>",
    ],
    organizationId: "<value>",
    avatarUrl: "https://near-accompanist.org",
  },
  benefitId: "<value>",
  key: "<key>",
  displayKey: "<value>",
  status: "revoked",
  limitActivations: 686035,
  usage: 508721,
  limitUsage: 614111,
  validations: 980995,
  lastValidatedAt: new Date("2024-04-29T05:00:39.346Z"),
  expiresAt: new Date("2025-02-03T23:21:36.977Z"),
};

Fields

Field Type Required Description
id string ✔️ N/A
organizationId string ✔️ N/A
userId string ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
customerId string ✔️ N/A
user components.LicenseKeyUser ✔️ 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
activation components.LicenseKeyActivationBase ➖ N/A