Skip to content

Latest commit

 

History

History
28 lines (25 loc) · 18.2 KB

organization.md

File metadata and controls

28 lines (25 loc) · 18.2 KB

Organization

Fields

Field Type Required Description Example
CreatedAt time.Time ✔️ Creation timestamp of the object.
ModifiedAt time.Time ✔️ 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 time.Time ✔️ When the business details were submitted.
FeatureSettings components.OrganizationFeatureSettings ✔️ Organization feature settings
SubscriptionSettings components.OrganizationSubscriptionSettings ✔️ N/A
Bio string ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
Company string ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
Blog string ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
Location string ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
TwitterUsername string ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
PledgeMinimumAmount int64 ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
PledgeBadgeShowAmount bool ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
DefaultUpfrontSplitToContributors int64 ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
ProfileSettings components.OrganizationProfileSettings ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Settings for the organization profile