ExtendedTenant¶

class ExtendedTenant[source]¶

The extended JSON representation of a tenant.

price: TenantPrice | None¶: The price of a tenant.

contract_start: date¶: This value determines when the contract of the tenant starts. As not all tenants start at the same date in the year, we use this to collect statistics.

hubspot_company_id: str | None¶: The ID of the HubSpot company this tenant is associated with.

id: str¶: The id of the tenant

name: str¶: The name of the tenant

sso_provider_id: str | None¶: Maybe the id of the SSO provider connected to this tenant.

abbreviated_name: str | None¶: The short name (or names) of the tenant. This is used to make searching for tenants by end users easier.

order_category: int¶: This value determines how the tenant should be ordered. Tenants should first be ordered from highest order_category to lowest, and then by name.

is_hidden: bool¶: This value states whether the tenant should be hidden from listing if the user is not allowed to see hidden tenants.

netloc: str¶: The netloc this tenant is hosted on.

logo_default_url: str¶: A url where you can download the default logo for this tenant. You don’t need to be logged in to use this url.

logo_dark_url: str¶: A url where you can download the dark logo for this tenant. You don’t need to be logged in to use this url.