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