Template objects reference

This is the complete set of data a theme template can read. Availability matters as much as shape: several of these exist only on certain pages or for signed-in visitors, and debug mode raises an error when you read something undefined.

Availability at a glance

Variable	Available
`option`, `config`, `version`, `license`, `theme`, `environment`, `nav`, `currency`, `locales`, `env`	Always
`locale`	When the resolved language has a theme catalog; otherwise `null`
`theme_locale`	Always, but deprecated. Use `locale.code`.
`user`, `workspace`	Only when a visitor is signed in
`plans`	Only on the landing page

{% if user is defined %}…{% endif %}
{{ plans|default([]) }}
{{ locale.code|default('en-US') }}

Globals

object

Every platform setting, as a nested object: option.site.name, option.brand.logo, option.policies.tos, option.features.chat.is_enabled, and so on. A setting that was never saved is undefined, so guard it.Two values are computed rather than stored:

option.site.url, built from the configured domain and whether the site is served over HTTPS.
option.color_scheme.accent and .accent_content, expanded into { hex, r, g, b, rgb }.

object

Application configuration. Most themes only need config.model.registry, which lists AI services and models for pricing or capability tables.

string

The application version, also used as the cache-busting query on theme assets.

string | null

The installation’s license text, or null.

string

The active theme’s package name, such as acme/aurora.

string

prod, dev, demo or install.

object

The navigation registry. Themes rarely need it; it’s what the app and admin sidebars are built from.

object

The raw environment. Read one key when you must, such as env.THEME_ASSETS_SERVER.

This contains database credentials and secret keys. Never print or serialize the whole object.

Currency

object

The platform billing currency.

Show Properties

string

required

ISO code, such as USD.

string

required

Localized name, such as US Dollar.

string | null

required

The symbol, or null when it’s the same as the code.

number

required

Decimal places, such as 2.

Locales

array

Every configured language.

Show Entry properties

string

required

Language code, such as de-DE.

string

required

English name, such as German.

boolean

required

Whether an administrator enabled it.

string

required

ltr or rtl.

string

required

An alias of code, kept for older themes.

object | null

The language resolved for this request, in the same shape as a locales entry. It’s null when the theme has no catalog for the resolved language, so always use locale.code|default('en-US').

string | null

Deprecated. The resolved language code as a plain string.

<html lang="{{ locale.code|default('en-US') }}" dir="{{ locale.dir|default('ltr') }}">

{% for item in locales %}
	{% if item.enabled %}
		<a href="/{{ item.code }}">{{ item.label }}</a>
	{% endif %}
{% endfor %}

User

object

The signed-in visitor. Undefined for guests.

Show Properties

string

required

UUID.

string

required

admin or user.

string

required

Email address.

string

required

First name.

string

required

Last name.

string | null

required

Phone number.

string

required

Preferred language code.

boolean

required

False for accounts created through a social login.

number | null

required

How many workspaces the user may own; null means unlimited.

string

required

Gravatar URL derived from the email address.

number

required

Unix timestamp.

number | null

required

Unix timestamp, or null.

string | null

required

Last known IP address.

object | null

required

See Country.

string | null

required

City.

boolean

required

Verification status.

string | null

required

The user’s API key, or null.

object

required

See Affiliate.

object

required

The current workspace. Note that owner and users are not included on this nested copy.

object

required

memories, history, disabled_tools, instructions, preferred_name and marketing.

array

required

Workspaces the user belongs to but doesn’t own. Present on the global user only.

array

required

Workspaces the user owns. Present on the global user only.

Workspace

object

The visitor’s current workspace. Undefined for guests.

Show Properties

string

required

UUID.

string

required

Workspace name.

string | null

required

The workspace’s own key, when it brings one.

string | null

required

As above.

object | null

required

See Address.

boolean

required

Whether a trial is still available.

boolean

required

Whether the free plan is still available.

number

required

Unix timestamp.

number | null

required

Unix timestamp, or null.

array

required

Pending invitations. See Workspace invitation.

number | null

required

Add-on credits; null means unlimited.

number | null

required

Add-on plus subscription credits.

object | null

required

See Subscription.

object | null

required

null unless the installation bills by session; otherwise { resets_at, used_percent }.

number

required

Present only in session billing mode.

object

required

The owning user. Present on the global workspace only.

array

required

Members. Present on the global workspace only.

Subscription

object

Available as workspace.subscription, or null when the workspace has none.

Show Properties

string

required

UUID.

number

required

Trial length in days.

number

required

Credits used in the current period.

string

required

Percentage with a % suffix, such as "45.00%".

number | null

required

Credits remaining; null means unlimited.

string

required

Percentage with a % suffix.

number

required

Unix timestamp.

number | null

required

Unix timestamp, or null.

number | null

required

When the user cancelled.

number | null

required

When access ends.

number | null

required

Next usage reset; null once cancelled.

number | null

required

Next payment date, following the plan’s billing cycle.

object

required

The plan snapshot. See Plan snapshot.

object | null

required

The order’s currency, or null when there’s no order.

string | null

required

Gateway key.

string | null

required

The provider’s reference.

Plan

array

Active plans, sorted by price ascending. Available on the landing page only.

Show Plan properties

string

required

UUID, used in the checkout link.

string

required

Plan name.

string | null

required

Short description.

string | null

required

An icon name, or raw SVG markup.

number

required

Minor units, such as 2900 for 29.00.

number | null

required

Discounted price when a coupon applies.

string

required

one-time, monthly, yearly or lifetime.

number | null

required

null means unlimited.

number | null

required

Member limit; null means unlimited.

boolean

required

Highlight this plan.

number

required

Ordering weight for comparison tables.

number

required

Unix timestamp.

number | null

required

Unix timestamp, or null.

array

required

Objects of { title, is_included }. A line entered with a leading - becomes is_included: false.

object

required

Capabilities. See Plan config.

object | null

required

The applied coupon.

number | null

required

Discount amount when a coupon applies.

object

required

The snapshot subscriptions are based on.

Plan snapshot

object

A frozen copy of a plan, available as subscription.plan. It carries id, title, description, icon, price, billing_cycle, credit_count, member_cap, created_at, updated_at, config and feature_list, with the same meanings as on a plan. It has no sale_price, coupon, discount or snapshot.

Plan config

object

What a plan grants. Available as plan.config and subscription.plan.config.

Show Properties

object

Chat capability settings.

object

Writer settings.

object

Image generation settings.

object

Video settings.

object

Transcription settings.

object

Voice-over settings.

object

Voice isolation settings.

object

Classification settings.

array | null

Allowed model keys; null means all.

object

Tool switches, keyed by capability.

array | null

Allowed assistants; null means all.

array | null

Allowed templates; null means all.

object

Per-plan settings added by plugins, keyed by extension.

Affiliate

object

Available as user.affiliate. Every user has one.

Show Properties

string

required

UUID.

string

required

Referral code.

number

required

Tracked clicks.

number

required

Referred signups.

number

required

Available balance, converted into the billing currency.

number

required

Pending balance, converted into the billing currency.

number

required

Withdrawn total, converted into the billing currency.

object

required

The currency those amounts are in.

string | null

required

Payout email.

string | null

required

Bank details.

string | null

required

Chosen payout method.

Address

object

Available as workspace.address, or null.

Show Properties

string | null

Country code.

string | null

State or region.

string | null

City.

string | null

Street address.

string | null

Second address line.

string | null

Postal code.

string | null

Phone number.

Country

object | null

Available as user.country.

Show Properties

string

required

Localized country name.

string

required

Two-letter code.

string

required

Three-letter code.

string

required

Flag image URL.

Workspace invitation

object

Entries of workspace.invitations.

Show Properties

string

required

UUID.

string

required

Invited address.

number

required

Unix timestamp.

number | null

required

Unix timestamp, or null.

Notes on types

Timestamps are Unix seconds, or null. Format them with Twig’s date filters.
Money is an integer in the currency’s minor units. Use <x-money> or format_currency.
Credits use null for unlimited, which is different from 0.
Percentages on a subscription are strings that already include %.

Get Started

Plugins

Extension Guides

Themes

Core Architecture

REST API

Template objects reference

Availability at a glance

Globals

Currency

Locales

User

Workspace

Subscription

Plan

Plan snapshot

Plan config

Affiliate

Address

Country

Workspace invitation

Notes on types

​Availability at a glance

​Globals

​Currency

​Locales

​User

​Workspace

​Subscription

​Plan

​Plan snapshot

​Plan config

​Affiliate

​Address

​Country

​Workspace invitation

​Notes on types

​Related

Availability at a glance

Globals

Currency

Locales

User

Workspace

Subscription

Plan

Plan snapshot

Plan config

Affiliate

Address

Country

Workspace invitation

Notes on types

Related