Skip to content

Latest commit

 

History

History
55 lines (50 loc) · 9.34 KB

organization.md

File metadata and controls

55 lines (50 loc) · 9.34 KB

Organization

Example Usage

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

let value: Organization = {
  createdAt: new Date("2023-10-15T17:45:40.614Z"),
  modifiedAt: new Date("2023-11-21T08:44:57.483Z"),
  id: "<value>",
  name: "<value>",
  slug: "<value>",
  avatarUrl: "https://first-kit.biz",
  bio: "<value>",
  company: "Fay Group",
  blog: "<value>",
  location: "<value>",
  email: "[email protected]",
  twitterUsername: "<value>",
  pledgeMinimumAmount: 279972,
  pledgeBadgeShowAmount: false,
  defaultUpfrontSplitToContributors: 565242,
  profileSettings: {},
  featureSettings: {},
  subscriptionSettings: {
    allowMultipleSubscriptions: false,
    allowCustomerUpdates: false,
    prorationBehavior: "prorate",
  },
};

Fields

Field Type Required Description
createdAt Date ✔️ Creation timestamp of the object.
modifiedAt Date ✔️ Last modification timestamp of the object.
id string ✔️ The organization ID.
name string ✔️ N/A
slug string ✔️ N/A
avatarUrl string ✔️ N/A
bio string ✔️ N/A
company string ✔️ N/A
blog string ✔️ N/A
location string ✔️ N/A
email string ✔️ N/A
twitterUsername string ✔️ N/A
pledgeMinimumAmount number ✔️ N/A
pledgeBadgeShowAmount boolean ✔️ N/A
defaultUpfrontSplitToContributors number ✔️ N/A
profileSettings components.OrganizationProfileSettings ✔️ Settings for the organization profile
featureSettings components.OrganizationFeatureSettings ✔️ Settings for the organization features
subscriptionSettings components.OrganizationSubscriptionSettings ✔️ N/A