1. Organizations
  2. Model

Organizations

Model

Organization Model

object "organization"
The description of the model.

active boolean
if this organization is currently active.

billing Billing
Comprehensive billing information for the organization. See Billing Model for more details.

currency string
The three-letter ISO code for the currency. Currently, all accounts should be set to "usd".

created_at Integer
Time in epoch seconds when this resource was created.

id string
Unique identifier for this organization, prefixed with org_

logo_url string
The URL for the organization's logo, used in email communications and shipping labels where permissible.

metadata object
Custom key-value pairs for storing additional organization data.

profile Object
Contains essential information about the organization.

Show Details
address Address
The address for this organization.
dba_name string
The "Doing Business As" name for customer communications.
email string
The primary email address for the organization.
name string
The legal name for the organization.
phone string
The primary phone number for account-related communications.
website string
The official website of the organization.

roles object[]
Array of role objects.

Show Details
uuid string
Unique identifier for the role.
id string
Identifier for the role.
scopes string[]
Defines the permissions and access levels for the role.
hidden_ui_sections string[]
Array of UI sections that are hidden for this role.
name string
Name of the role.
notification_events string[]
Notification events associated with the role.

requirements object
Outlines any pending requirements for the organization's onboarding process.

Show Details
errors string[]
A list of errors that need to be addressed.
pending_verification string[]
Items currently undergoing verification.
required_now string[]
Urgent action items needed for successful onboarding.

social_media Object
URLs to the organization's social media profiles, used in customer communications.

Show Details
facebook string
instagram string
linkedin string
tiktok string
twitter string
youtube string

settings Settings
The Settings Model provides default values for various APIs, which can be overridden on a per-request basis.

Show Details
Object.address Address
The address for this organization
Object.dba_name string
Optional property for the preferred name to use in customer communications
Object.email string
The main email for the organization
Object.name string
The legal name for the organization
Object.phone string
The phone number of the org. We'll use this number to contact you if there are any issues with your account.
Object.website string
The website for the organization

updated_at integer
Time in epoch seconds when this resource was last updated.

updated_by string
The ID of the user or key who last updated the location.

enable_scoped_payment_methods boolean
For enterprise accounts, when this property is set to true, payment methods are scoped to a specific location.

tenants string[]
A list of organization ID's financially dependent on this organization, inheriting its pricing structure. To be replaced by tenant_ids.

tenant_ids string[]
A list of organization ID's financially dependent on this organization, inheriting its pricing structure.

wallet object
Represents an object with key properties related to a financial wallet.

Show Details
active boolean
Indicates whether the wallet is currently active and operational.
alert_threshold number
The balance level at which an alert is triggered for the wallet.
balance number
Current balance of the wallet.
credit_line number
Total credit line available for the wallet.
default boolean
Indicates if this is the default wallet for the account.
reload_threshold number
The minimum balance at which the wallet should be reloaded or replenished.
source string
Origin or type of the wallet (e.g., bank account, credit card).

_managing_organization object | null
The parent organization for tenant organizations. This is a full organization object representing the managing (parent) entity. Only present for tenant organizations.

_tenant_organizations Array.<Organization> | null
An array of child tenant organization objects. Only present for managing (parent) organizations.

checksum string
A hash value computed from the current organization configuration. This value gets updated whenever the organization updates.


Integration Notifications Settings

The settings.integration_notifications object on the organization controls when email notifications are sent for integration errors. These settings can be updated via the organization update endpoint.

settings.integration_notifications.outgoing object
Configuration for outgoing integration error notifications.

Show Details
failure_limit integer
Number of errors that must occur within the failure interval before a notification is sent. Set to 0 to disable notifications. Default: 0.
failure_interval string
The time window in which errors are counted. One of: mins_0015, mins_0030, mins_0060, mins_0240, mins_0480, mins_0720, mins_1440. Default: mins_1440 (24 hours).
last_failure_at string nullable
ISO 8601 timestamp of when the last error notification was sent. Used internally for cooldown logic to prevent duplicate notifications within the same interval. Read-only.

settings.integration_notifications.incoming object
Configuration for incoming webhook error notifications.

Show Details
failure_limit integer
Number of errors that must occur within the failure interval before a notification is sent. Set to 0 to disable notifications. Default: 0.
failure_interval string
The time window in which errors are counted. One of: mins_0015, mins_0030, mins_0060, mins_0240, mins_0480, mins_0720, mins_1440. Default: mins_1440 (24 hours).
last_failure_at string nullable
ISO 8601 timestamp of when the last error notification was sent. Used internally for cooldown logic to prevent duplicate notifications within the same interval. Read-only.

Previous <- Organizations Overview
Next Create & Update Organizations ->