Organization
July 20, 2026 ยท View on GitHub
Fields
| Field | Type | Required | Description |
|---|---|---|---|
created_at | date | :heavy_check_mark: | Creation timestamp of the object. |
modified_at | date | :heavy_check_mark: | Last modification timestamp of the object. |
id | str | :heavy_check_mark: | The ID of the object. |
name | str | :heavy_check_mark: | Organization name shown in checkout, customer portal, emails etc. |
slug | str | :heavy_check_mark: | Unique organization slug in checkout, customer portal and credit card statements. |
avatar_url | Nullable[str] | :heavy_check_mark: | Avatar URL shown in checkout, customer portal, emails etc. |
proration_behavior | models.SubscriptionProrationBehavior | :heavy_check_mark: | N/A |
allow_customer_updates | bool | :heavy_check_mark: | Whether customers can update their subscriptions from the customer portal. |
email | Nullable[str] | :heavy_check_mark: | Public support email. |
website | Nullable[str] | :heavy_check_mark: | Official website of the organization. |
socials | List[models.OrganizationSocialLink] | :heavy_check_mark: | Links to social profiles. |
status | models.OrganizationStatus | :heavy_check_mark: | N/A |
details_submitted_at | date | :heavy_check_mark: | When the business details were submitted for review. |
sso_enforced | bool | :heavy_check_mark: | Whether members must access this organization through its SSO connection. |
default_presentment_currency | str | :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_behavior | models.TaxBehaviorOption | :heavy_check_mark: | N/A |
feature_settings | Nullable[models.OrganizationFeatureSettings] | :heavy_check_mark: | Organization feature settings |
subscription_settings | models.OrganizationSubscriptionSettings | :heavy_check_mark: | N/A |
customer_email_settings | models.OrganizationCustomerEmailSettings | :heavy_check_mark: | N/A |
customer_portal_settings | models.OrganizationCustomerPortalSettings | :heavy_check_mark: | N/A |
country | OptionalNullable[models.CountryAlpha2] | :heavy_minus_sign: | Two-letter country code (ISO 3166-1 alpha-2). |
account_id | Nullable[str] | :heavy_check_mark: | ID of the transactions account. |
payout_account_id | Nullable[str] | :heavy_check_mark: | ID of the payout account. |
capabilities | models.OrganizationCapabilities | :heavy_check_mark: | N/A |