Organization

July 20, 2026 ยท View on GitHub

Fields

FieldTypeRequiredDescription
created_atdate:heavy_check_mark:Creation timestamp of the object.
modified_atdate:heavy_check_mark:Last modification timestamp of the object.
idstr:heavy_check_mark:The ID of the object.
namestr:heavy_check_mark:Organization name shown in checkout, customer portal, emails etc.
slugstr:heavy_check_mark:Unique organization slug in checkout, customer portal and credit card statements.
avatar_urlNullable[str]:heavy_check_mark:Avatar URL shown in checkout, customer portal, emails etc.
proration_behaviormodels.SubscriptionProrationBehavior:heavy_check_mark:N/A
allow_customer_updatesbool:heavy_check_mark:Whether customers can update their subscriptions from the customer portal.
emailNullable[str]:heavy_check_mark:Public support email.
websiteNullable[str]:heavy_check_mark:Official website of the organization.
socialsList[models.OrganizationSocialLink]:heavy_check_mark:Links to social profiles.
statusmodels.OrganizationStatus:heavy_check_mark:N/A
details_submitted_atdate:heavy_check_mark:When the business details were submitted for review.
sso_enforcedbool:heavy_check_mark:Whether members must access this organization through its SSO connection.
default_presentment_currencystr:heavy_check_mark:Default presentment currency. Used as fallback in checkout and customer portal, if the customer's local currency is not available.
default_tax_behaviormodels.TaxBehaviorOption:heavy_check_mark:N/A
feature_settingsNullable[models.OrganizationFeatureSettings]:heavy_check_mark:Organization feature settings
subscription_settingsmodels.OrganizationSubscriptionSettings:heavy_check_mark:N/A
customer_email_settingsmodels.OrganizationCustomerEmailSettings:heavy_check_mark:N/A
customer_portal_settingsmodels.OrganizationCustomerPortalSettings:heavy_check_mark:N/A
countryOptionalNullable[models.CountryAlpha2]:heavy_minus_sign:Two-letter country code (ISO 3166-1 alpha-2).
account_idNullable[str]:heavy_check_mark:ID of the transactions account.
payout_account_idNullable[str]:heavy_check_mark:ID of the payout account.
capabilitiesmodels.OrganizationCapabilities:heavy_check_mark:N/A