Skip to content

Latest commit

 

History

History
72 lines (67 loc) · 9.85 KB

licensekeyread.md

File metadata and controls

72 lines (67 loc) · 9.85 KB

LicenseKeyRead

Example Usage

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

let value: LicenseKeyRead = {
  id: "<value>",
  organizationId: "<value>",
  userId: "<value>",
  customerId: "<value>",
  user: {
    id: "<value>",
    email: "[email protected]",
    publicName: "<value>",
  },
  customer: {
    id: "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
    createdAt: new Date("2023-12-27T02:58:25.134Z"),
    modifiedAt: new Date("2023-03-18T19:18:13.816Z"),
    metadata: {
      "key": "<value>",
    },
    externalId: "usr_1337",
    email: "[email protected]",
    emailVerified: true,
    name: "John Doe",
    billingAddress: {
      country: "US",
    },
    taxId: [
      "911144442",
      "us_ein",
    ],
    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
    deletedAt: new Date("2023-09-06T13:05:11.308Z"),
    avatarUrl: "https://www.gravatar.com/avatar/xxx?d=blank",
  },
  benefitId: "<value>",
  key: "<key>",
  displayKey: "<value>",
  status: "revoked",
  limitActivations: 380715,
  usage: 337047,
  limitUsage: 881238,
  validations: 202737,
  lastValidatedAt: new Date("2023-06-29T08:44:46.296Z"),
  expiresAt: new Date("2023-03-25T07:10:48.505Z"),
};

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