Skip to content

checkoutorganization.md

Latest commit

 

History

History
31 lines (26 loc) · 4.51 KB

checkoutorganization.md

File metadata and controls

31 lines (26 loc) · 4.51 KB
Raw

CheckoutOrganization

Example Usage

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

let value: CheckoutOrganization = {
  createdAt: new Date("2024-12-15T13:26:37.014Z"),
  modifiedAt: new Date("2025-02-13T18:17:21.202Z"),
  id: "<value>",
  name: "<value>",
  slug: "<value>",
  avatarUrl: "https://unsightly-hunt.org",
  prorationBehavior: "next_period",
  allowCustomerUpdates: false,
};

Fields

Field Type Required Description
createdAt Date ✔️ Creation timestamp of the object.
modifiedAt Date ✔️ Last modification timestamp of the object.
id string ✔️ The ID of the object.
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.
prorationBehavior components.SubscriptionProrationBehavior ✔️ N/A
allowCustomerUpdates boolean ✔️ Whether customers can update their subscriptions from the customer portal.