organization.md

Organization

Example Usage

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

let value: Organization = {
  createdAt: new Date("2025-08-18T16:08:36.319Z"),
  modifiedAt: new Date("2023-06-29T18:21:41.585Z"),
  id: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  name: "<value>",
  slug: "<value>",
  avatarUrl: "https://medium-formula.org",
  email: "Waino.Paucek35@yahoo.com",
  website: "<value>",
  socials: [
    {
      platform: "youtube",
      url: "https://torn-bob.net",
    },
  ],
  detailsSubmittedAt: new Date("2024-10-03T20:10:35.957Z"),
  featureSettings: {},
  subscriptionSettings: {
    allowMultipleSubscriptions: false,
    allowCustomerUpdates: false,
    prorationBehavior: "prorate",
  },
};

Fields

Field	Type	Required	Description	Example
createdAt	Date	✔️	Creation timestamp of the object.
modifiedAt	Date	✔️	Last modification timestamp of the object.
id	string	✔️	The organization ID.	1dbfc517-0bbf-4301-9ba8-555ca42b9737
name	string	✔️	Organization name shown in checkout, customer portal, emails etc.
slug	string	✔️	Unique organization slug in checkout, customer portal and credit card statements.
avatarUrl	string	✔️	Avatar URL shown in checkout, customer portal, emails etc.
email	string	✔️	Public support email.
website	string	✔️	Official website of the organization.
socials	components.OrganizationSocialLink[]	✔️	Links to social profiles.
detailsSubmittedAt	Date	✔️	When the business details were submitted.
featureSettings	components.OrganizationFeatureSettings	✔️	Organization feature settings
subscriptionSettings	components.OrganizationSubscriptionSettings	✔️	N/A