Skip to content

Latest commit

 

History

History
81 lines (76 loc) · 10.5 KB

licensekeywithactivations.md

File metadata and controls

81 lines (76 loc) · 10.5 KB

LicenseKeyWithActivations

Example Usage

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

let value: LicenseKeyWithActivations = {
  id: "<value>",
  organizationId: "<value>",
  userId: "<value>",
  customerId: "<value>",
  user: {
    id: "<value>",
    email: "[email protected]",
    publicName: "<value>",
  },
  customer: {
    createdAt: new Date("2024-11-15T04:01:56.929Z"),
    modifiedAt: new Date("2024-10-18T12:27:31.429Z"),
    id: "<value>",
    metadata: {
      "key": "<value>",
    },
    externalId: "<id>",
    email: "[email protected]",
    emailVerified: false,
    name: "<value>",
    billingAddress: {
      country: "Niger",
    },
    taxId: [
      "tr_tin",
    ],
    organizationId: "<value>",
    avatarUrl: "https://impassioned-bandwidth.com/",
  },
  benefitId: "<value>",
  key: "<key>",
  displayKey: "<value>",
  status: "revoked",
  limitActivations: 517133,
  usage: 437523,
  limitUsage: 716963,
  validations: 265906,
  lastValidatedAt: new Date("2024-03-30T05:36:59.222Z"),
  expiresAt: new Date("2025-10-25T06:50:26.826Z"),
  activations: [
    {
      id: "<value>",
      licenseKeyId: "<value>",
      label: "<value>",
      meta: {},
      createdAt: new Date("2024-09-13T12:44:39.147Z"),
      modifiedAt: new Date("2025-01-16T20:25:36.336Z"),
    },
  ],
};

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
activations components.LicenseKeyActivationBase[] ✔️ N/A