> ## Documentation Index > Fetch the complete documentation index at: https://docs.aikeedo.com/llms.txt > Use this file to discover all available pages before exploring further. # Template objects reference > Every variable and object available in an Aikeedo theme template, with its fields, types and availability. 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 | ```twig theme={null} {% if user is defined %}…{% endif %} {{ plans|default([]) }} {{ locale.code|default('en-US') }} ``` ## Globals 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 }`. Application configuration. Most themes only need `config.model.registry`, which lists AI services and models for pricing or capability tables. The application version, also used as the cache-busting query on theme assets. The installation's license text, or `null`. The active theme's package name, such as `acme/aurora`. `prod`, `dev`, `demo` or `install`. The navigation registry. Themes rarely need it; it's what the app and admin sidebars are built from. 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 The platform billing currency. ISO code, such as `USD`. Localized name, such as `US Dollar`. The symbol, or `null` when it's the same as the code. Decimal places, such as `2`. ## Locales Every configured language. Language code, such as `de-DE`. English name, such as `German`. Whether an administrator enabled it. `ltr` or `rtl`. An alias of `code`, kept for older themes. 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')`. Deprecated. The resolved language code as a plain string. ```twig theme={null} {% for item in locales %} {% if item.enabled %} {{ item.label }} {% endif %} {% endfor %} ``` ## User The signed-in visitor. Undefined for guests. UUID. `admin` or `user`. Email address. First name. Last name. Phone number. Preferred language code. False for accounts created through a social login. How many workspaces the user may own; `null` means unlimited. Gravatar URL derived from the email address. Unix timestamp. Unix timestamp, or `null`. Last known IP address. See [Country](#country). City. Verification status. The user's API key, or `null`. See [Affiliate](#affiliate). The current workspace. Note that `owner` and `users` are **not** included on this nested copy. `memories`, `history`, `disabled_tools`, `instructions`, `preferred_name` and `marketing`. Workspaces the user belongs to but doesn't own. Present on the global `user` only. Workspaces the user owns. Present on the global `user` only. ## Workspace The visitor's current workspace. Undefined for guests. UUID. Workspace name. The workspace's own key, when it brings one. As above. See [Address](#address). Whether a trial is still available. Whether the free plan is still available. Unix timestamp. Unix timestamp, or `null`. Pending invitations. See [Workspace invitation](#workspace-invitation). Add-on credits; `null` means unlimited. Add-on plus subscription credits. See [Subscription](#subscription). `null` unless the installation bills by session; otherwise `{ resets_at, used_percent }`. Present only in session billing mode. The owning user. Present on the global `workspace` only. Members. Present on the global `workspace` only. ## Subscription Available as `workspace.subscription`, or `null` when the workspace has none. UUID. Trial length in days. Credits used in the current period. Percentage **with a `%` suffix**, such as `"45.00%"`. Credits remaining; `null` means unlimited. Percentage with a `%` suffix. Unix timestamp. Unix timestamp, or `null`. When the user cancelled. When access ends. Next usage reset; `null` once cancelled. Next payment date, following the plan's billing cycle. The plan snapshot. See [Plan snapshot](#plan-snapshot). The order's currency, or `null` when there's no order. Gateway key. The provider's reference. ## Plan Active plans, sorted by price ascending. **Available on the landing page only.** UUID, used in the checkout link. Plan name. Short description. An icon name, or raw SVG markup. Minor units, such as `2900` for 29.00. Discounted price when a coupon applies. `one-time`, `monthly`, `yearly` or `lifetime`. `null` means unlimited. Member limit; `null` means unlimited. Highlight this plan. Ordering weight for comparison tables. Unix timestamp. Unix timestamp, or `null`. Objects of `{ title, is_included }`. A line entered with a leading `-` becomes `is_included: false`. Capabilities. See [Plan config](#plan-config). The applied coupon. Discount amount when a coupon applies. The snapshot subscriptions are based on. ## Plan snapshot 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 What a plan grants. Available as `plan.config` and `subscription.plan.config`. Chat capability settings. Writer settings. Image generation settings. Video settings. Transcription settings. Voice-over settings. Voice isolation settings. Classification settings. Allowed model keys; `null` means all. Tool switches, keyed by capability. Allowed assistants; `null` means all. Allowed templates; `null` means all. Per-plan settings added by plugins, keyed by extension. ## Affiliate Available as `user.affiliate`. Every user has one. UUID. Referral code. Tracked clicks. Referred signups. Available balance, converted into the billing currency. Pending balance, converted into the billing currency. Withdrawn total, converted into the billing currency. The currency those amounts are in. Payout email. Bank details. Chosen payout method. ## Address Available as `workspace.address`, or `null`. Country code. State or region. City. Street address. Second address line. Postal code. Phone number. ## Country Available as `user.country`. Localized country name. Two-letter code. Three-letter code. Flag image URL. ## Workspace invitation Entries of `workspace.invitations`. UUID. Invited address. Unix timestamp. 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 `` or `format_currency`. * **Credits** use `null` for unlimited, which is different from `0`. * **Percentages** on a subscription are strings that already include `%`. ## Related * [Twig reference](/development/themes/twig-reference) * [Pricing and plans](/development/themes/pricing-and-plans) * [Users and navigation](/development/themes/users-and-navigation)