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.
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.
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 %.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Aikeedo Docs","description":"Self-hosted software with customizable features to launch your AI SaaS business quickly and generate revenue fast.","colors":{"primary":"#24282c","light":"#07C983","dark":"#24282c"},"logo":{"light":"https://mintcdn.com/aikeedo/AhiAA6H0ZT4BonAW/logo/light.svg?fit=max\u0026auto=format\u0026n=AhiAA6H0ZT4BonAW\u0026q=85\u0026s=fc9332778893ff8eda4b5ce14142b391","dark":"https://mintcdn.com/aikeedo/AhiAA6H0ZT4BonAW/logo/dark.svg?fit=max\u0026auto=format\u0026n=AhiAA6H0ZT4BonAW\u0026q=85\u0026s=6c14d9ba24e13514459c53f3b5d1c321"},"favicon":"https://mintcdn.com/aikeedo/vTLcl7xb6rBrq85h/favicon.ico?fit=max\u0026auto=format\u0026n=vTLcl7xb6rBrq85h\u0026q=85\u0026s=5d27267681fd6d9a3947a07360b817e5","navbar":{"links":[{"href":"https://aikeedo.com/support/?utm_source=docs\u0026utm_medium=nav","label":"Support"}],"primary":{"type":"button","label":"Buy now","href":"https://aikeedo.com?utm_source=docs\u0026utm_medium=header"}},"footer":{"socials":{"website":"https://aikeedo.com?utm_source=docs\u0026utm_medium=footer","x":"https://x.com/heyaikeedo","github":"https://github.com/heyaikeedo","linkedin":"https://www.linkedin.com/company/heyaikeedo","youtube":"https://www.youtube.com/@heyaikeedo","instagram":"https://www.instagram.com/heyaikeedo","facebook":"https://www.facebook.com/heyaikeedo"}},"seo":{"indexing":"all"},"icons":{"library":"tabler"},"integrations":{"gtm":{"tagId":"GTM-WJJWH53N"}},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Affiliates","icon":"coin","href":"https://aikeedo.com/affiliates/?utm_source=docs\u0026utm_medium=nav"},{"anchor":"Changelog","icon":"chart-area-line","href":"https://aikeedo.com/changelog/?utm_source=docs\u0026utm_medium=nav"},{"anchor":"Feature Requests","icon":"star","href":"https://feedback.aikeedo.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"aikeedo","hasAudioNarration":false,"actualSubdomain":"aikeedo","customDomains":["docs.aikeedo.com"],"gitSource":{"type":"github","owner":"heyaikeedo","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{},"buildId":"6af8b35025f0e2ea6db66231","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Docs","count":97},{"language":"default","tag":"Development","count":84},{"language":"default","tag":"Integrations","count":49},{"language":"default","tag":"Plugins","count":23},{"language":"default","tag":"Core Architecture","count":21},{"language":"default","tag":"Themes","count":19},{"language":"default","tag":"Payment Gateways","count":17},{"language":"default","tag":"Advanced","count":16},{"language":"default","tag":"Extension Guides","count":16},{"language":"default","tag":"Building Blocks","count":15}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"development/themes/template-objects","slug":"/development/themes/template-objects","pageMetadata":{"title":"Template objects reference","sidebarTitle":"Template objects","description":"Every variable and object available in an Aikeedo theme template, with its fields, types and availability.","href":"/development/themes/template-objects"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Every variable and object available in an Aikeedo theme template, with its fields, types and availability.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ResponseField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`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.`}),`\n`,_jsx(Heading,{level:`2`,id:`availability-at-a-glance`,children:`Availability at a glance`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Variable`}),_jsx(_components.th,{children:`Available`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`option`}),`, `,_jsx(_components.code,{children:`config`}),`, `,_jsx(_components.code,{children:`version`}),`, `,_jsx(_components.code,{children:`license`}),`, `,_jsx(_components.code,{children:`theme`}),`, `,_jsx(_components.code,{children:`environment`}),`, `,_jsx(_components.code,{children:`nav`}),`, `,_jsx(_components.code,{children:`currency`}),`, `,_jsx(_components.code,{children:`locales`}),`, `,_jsx(_components.code,{children:`env`})]}),_jsx(_components.td,{children:`Always`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`locale`})}),_jsxs(_components.td,{children:[`When the resolved language has a theme catalog; otherwise `,_jsx(_components.code,{children:`null`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`theme_locale`})}),_jsxs(_components.td,{children:[`Always, but deprecated. Use `,_jsx(_components.code,{children:`locale.code`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`user`}),`, `,_jsx(_components.code,{children:`workspace`})]}),_jsx(_components.td,{children:`Only when a visitor is signed in`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`plans`})}),_jsx(_components.td,{children:`Only on the landing page`})]})]})]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`twig`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`twig`,children:_jsxs(_components.code,{language:`twig`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{% `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` user`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` is`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:` defined`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` %}…{% `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`endif`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` %}`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{{ `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`plans`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`|`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`default`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`([]) }}`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{{ `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`locale`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`code`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`|`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`default`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'en-US'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) }}`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`globals`,children:`Globals`}),`\n`,_jsxs(ResponseField,{name:`option`,type:`object`,id:`param-option`,children:[_jsxs(_components.p,{children:[`Every platform setting, as a nested object: `,_jsx(_components.code,{children:`option.site.name`}),`, `,_jsx(_components.code,{children:`option.brand.logo`}),`, `,_jsx(_components.code,{children:`option.policies.tos`}),`, `,_jsx(_components.code,{children:`option.features.chat.is_enabled`}),`, and so on. A setting that was never saved is undefined, so guard it.`]}),_jsx(_components.p,{children:`Two values are computed rather than stored:`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`option.site.url`}),`, built from the configured domain and whether the site is served over HTTPS.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`option.color_scheme.accent`}),` and `,_jsx(_components.code,{children:`.accent_content`}),`, expanded into `,_jsx(_components.code,{children:`{ hex, r, g, b, rgb }`}),`.`]}),`\n`]})]}),`\n`,_jsx(ResponseField,{name:`config`,type:`object`,id:`param-config`,children:_jsxs(_components.p,{children:[`Application configuration. Most themes only need `,_jsx(_components.code,{children:`config.model.registry`}),`, which lists AI services and models for pricing or capability tables.`]})}),`\n`,_jsx(ResponseField,{name:`version`,type:`string`,id:`param-version`,children:_jsx(_components.p,{children:`The application version, also used as the cache-busting query on theme assets.`})}),`\n`,_jsx(ResponseField,{name:`license`,type:`string | null`,id:`param-license`,children:_jsxs(_components.p,{children:[`The installation’s license text, or `,_jsx(_components.code,{children:`null`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`theme`,type:`string`,id:`param-theme`,children:_jsxs(_components.p,{children:[`The active theme’s package name, such as `,_jsx(_components.code,{children:`acme/aurora`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`environment`,type:`string`,id:`param-environment`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`prod`}),`, `,_jsx(_components.code,{children:`dev`}),`, `,_jsx(_components.code,{children:`demo`}),` or `,_jsx(_components.code,{children:`install`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`nav`,type:`object`,id:`param-nav`,children:_jsx(_components.p,{children:`The navigation registry. Themes rarely need it; it’s what the app and admin sidebars are built from.`})}),`\n`,_jsxs(ResponseField,{name:`env`,type:`object`,id:`param-env`,children:[_jsxs(_components.p,{children:[`The raw environment. Read one key when you must, such as `,_jsx(_components.code,{children:`env.THEME_ASSETS_SERVER`}),`.`]}),_jsx(Warning,{children:_jsx(_components.p,{children:`This contains database credentials and secret keys. Never print or serialize the whole object.`})})]}),`\n`,_jsx(Heading,{level:`2`,id:`currency`,children:`Currency`}),`\n`,_jsxs(ResponseField,{name:`currency`,type:`object`,id:`param-currency`,children:[_jsx(_components.p,{children:`The platform billing currency.`}),_jsxs(Expandable,{title:`Properties`,children:[_jsxs(ResponseField,{name:`code`,type:`string`,required:true,id:`param-code`,children:[`ISO code, such as `,_jsx(_components.code,{children:`USD`}),`.`]}),_jsxs(ResponseField,{name:`name`,type:`string`,required:true,id:`param-name`,children:[`Localized name, such as `,_jsx(_components.code,{children:`US Dollar`}),`.`]}),_jsxs(ResponseField,{name:`symbol`,type:`string | null`,required:true,id:`param-symbol`,children:[`The symbol, or `,_jsx(_components.code,{children:`null`}),` when it’s the same as the code.`]}),_jsxs(ResponseField,{name:`fraction_digits`,type:`number`,required:true,id:`param-fraction-digits`,children:[`Decimal places, such as `,_jsx(_components.code,{children:`2`}),`.`]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`locales`,children:`Locales`}),`\n`,_jsxs(ResponseField,{name:`locales`,type:`array`,id:`param-locales`,children:[_jsx(_components.p,{children:`Every configured language.`}),_jsxs(Expandable,{title:`Entry properties`,children:[_jsxs(ResponseField,{name:`code`,type:`string`,required:true,id:`param-code-1`,children:[`Language code, such as `,_jsx(_components.code,{children:`de-DE`}),`.`]}),_jsxs(ResponseField,{name:`label`,type:`string`,required:true,id:`param-label`,children:[`English name, such as `,_jsx(_components.code,{children:`German`}),`.`]}),_jsx(ResponseField,{name:`enabled`,type:`boolean`,required:true,id:`param-enabled`,children:`Whether an administrator enabled it.`}),_jsxs(ResponseField,{name:`dir`,type:`string`,required:true,id:`param-dir`,children:[_jsx(_components.code,{children:`ltr`}),` or `,_jsx(_components.code,{children:`rtl`}),`.`]}),_jsxs(ResponseField,{name:`name`,type:`string`,required:true,id:`param-name-1`,children:[`An alias of `,_jsx(_components.code,{children:`code`}),`, kept for older themes.`]})]})]}),`\n`,_jsx(ResponseField,{name:`locale`,type:`object | null`,id:`param-locale`,children:_jsxs(_components.p,{children:[`The language resolved for this request, in the same shape as a `,_jsx(_components.code,{children:`locales`}),` entry. It’s `,_jsx(_components.code,{children:`null`}),` when the theme has no catalog for the resolved language, so always use `,_jsx(_components.code,{children:`locale.code|default('en-US')`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`theme_locale`,type:`string | null`,id:`param-theme-locale`,children:_jsx(_components.p,{children:`Deprecated. The resolved language code as a plain string.`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`twig`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`twig`,children:_jsxs(_components.code,{language:`twig`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`html`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` lang`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"{{ `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`locale`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`code`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`|`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`default`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`('en-US') }}\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` dir`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"{{ `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`locale`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`dir`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`|`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`default`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`('ltr') }}\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`>`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{% `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`for`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` item`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` locales`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` %}`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\t{% `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` item`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`enabled`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` %}`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`\t\t\u003c`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`a`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` href`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/{{ `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`item`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`code`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }}\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`>`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{{ `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`item`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`label`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }}`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`\u003c/`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`a`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`>`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`\t{% `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`endif`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` %}`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{% `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`endfor`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` %}`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`user`,children:`User`}),`\n`,_jsxs(ResponseField,{name:`user`,type:`object`,id:`param-user`,children:[_jsx(_components.p,{children:`The signed-in visitor. Undefined for guests.`}),_jsxs(Expandable,{title:`Properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id`,children:`UUID.`}),_jsxs(ResponseField,{name:`role`,type:`string`,required:true,id:`param-role`,children:[_jsx(_components.code,{children:`admin`}),` or `,_jsx(_components.code,{children:`user`}),`.`]}),_jsx(ResponseField,{name:`email`,type:`string`,required:true,id:`param-email`,children:`Email address.`}),_jsx(ResponseField,{name:`first_name`,type:`string`,required:true,id:`param-first-name`,children:`First name.`}),_jsx(ResponseField,{name:`last_name`,type:`string`,required:true,id:`param-last-name`,children:`Last name.`}),_jsx(ResponseField,{name:`phone_number`,type:`string | null`,required:true,id:`param-phone-number`,children:`Phone number.`}),_jsx(ResponseField,{name:`language`,type:`string`,required:true,id:`param-language`,children:`Preferred language code.`}),_jsx(ResponseField,{name:`has_password`,type:`boolean`,required:true,id:`param-has-password`,children:`False for accounts created through a social login.`}),_jsxs(ResponseField,{name:`workspace_cap`,type:`number | null`,required:true,id:`param-workspace-cap`,children:[`How many workspaces the user may own; `,_jsx(_components.code,{children:`null`}),` means unlimited.`]}),_jsx(ResponseField,{name:`avatar`,type:`string`,required:true,id:`param-avatar`,children:`Gravatar URL derived from the email address.`}),_jsx(ResponseField,{name:`created_at`,type:`number`,required:true,id:`param-created-at`,children:`Unix timestamp.`}),_jsxs(ResponseField,{name:`updated_at`,type:`number | null`,required:true,id:`param-updated-at`,children:[`Unix timestamp, or `,_jsx(_components.code,{children:`null`}),`.`]}),_jsx(ResponseField,{name:`ip`,type:`string | null`,required:true,id:`param-ip`,children:`Last known IP address.`}),_jsxs(ResponseField,{name:`country`,type:`object | null`,required:true,id:`param-country`,children:[`See `,_jsx(_components.a,{href:`#country`,children:`Country`}),`.`]}),_jsx(ResponseField,{name:`city_name`,type:`string | null`,required:true,id:`param-city-name`,children:`City.`}),_jsx(ResponseField,{name:`is_email_verified`,type:`boolean`,required:true,id:`param-is-email-verified`,children:`Verification status.`}),_jsxs(ResponseField,{name:`api_key`,type:`string | null`,required:true,id:`param-api-key`,children:[`The user’s API key, or `,_jsx(_components.code,{children:`null`}),`.`]}),_jsxs(ResponseField,{name:`affiliate`,type:`object`,required:true,id:`param-affiliate`,children:[`See `,_jsx(_components.a,{href:`#affiliate`,children:`Affiliate`}),`.`]}),_jsxs(ResponseField,{name:`workspace`,type:`object`,required:true,id:`param-workspace`,children:[`The current workspace. Note that `,_jsx(_components.code,{children:`owner`}),` and `,_jsx(_components.code,{children:`users`}),` are `,_jsx(_components.strong,{children:`not`}),` included on this nested copy.`]}),_jsxs(ResponseField,{name:`preferences`,type:`object`,required:true,id:`param-preferences`,children:[_jsx(_components.code,{children:`memories`}),`, `,_jsx(_components.code,{children:`history`}),`, `,_jsx(_components.code,{children:`disabled_tools`}),`, `,_jsx(_components.code,{children:`instructions`}),`, `,_jsx(_components.code,{children:`preferred_name`}),` and `,_jsx(_components.code,{children:`marketing`}),`.`]}),_jsxs(ResponseField,{name:`workspaces`,type:`array`,required:true,id:`param-workspaces`,children:[`Workspaces the user belongs to but doesn’t own. Present on the global `,_jsx(_components.code,{children:`user`}),` only.`]}),_jsxs(ResponseField,{name:`owned_workspaces`,type:`array`,required:true,id:`param-owned-workspaces`,children:[`Workspaces the user owns. Present on the global `,_jsx(_components.code,{children:`user`}),` only.`]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`workspace`,children:`Workspace`}),`\n`,_jsxs(ResponseField,{name:`workspace`,type:`object`,id:`param-workspace-1`,children:[_jsx(_components.p,{children:`The visitor’s current workspace. Undefined for guests.`}),_jsxs(Expandable,{title:`Properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id-1`,children:`UUID.`}),_jsx(ResponseField,{name:`name`,type:`string`,required:true,id:`param-name-2`,children:`Workspace name.`}),_jsx(ResponseField,{name:`openai_api_key`,type:`string | null`,required:true,id:`param-openai-api-key`,children:`The workspace’s own key, when it brings one.`}),_jsx(ResponseField,{name:`anthropic_api_key`,type:`string | null`,required:true,id:`param-anthropic-api-key`,children:`As above.`}),_jsxs(ResponseField,{name:`address`,type:`object | null`,required:true,id:`param-address`,children:[`See `,_jsx(_components.a,{href:`#address`,children:`Address`}),`.`]}),_jsx(ResponseField,{name:`is_eligible_for_trial`,type:`boolean`,required:true,id:`param-is-eligible-for-trial`,children:`Whether a trial is still available.`}),_jsx(ResponseField,{name:`is_eligible_for_free_plan`,type:`boolean`,required:true,id:`param-is-eligible-for-free-plan`,children:`Whether the free plan is still available.`}),_jsx(ResponseField,{name:`created_at`,type:`number`,required:true,id:`param-created-at-1`,children:`Unix timestamp.`}),_jsxs(ResponseField,{name:`updated_at`,type:`number | null`,required:true,id:`param-updated-at-1`,children:[`Unix timestamp, or `,_jsx(_components.code,{children:`null`}),`.`]}),_jsxs(ResponseField,{name:`invitations`,type:`array`,required:true,id:`param-invitations`,children:[`Pending invitations. See `,_jsx(_components.a,{href:`#workspace-invitation`,children:`Workspace invitation`}),`.`]}),_jsxs(ResponseField,{name:`credit_count`,type:`number | null`,required:true,id:`param-credit-count`,children:[`Add-on credits; `,_jsx(_components.code,{children:`null`}),` means unlimited.`]}),_jsx(ResponseField,{name:`total_credit_count`,type:`number | null`,required:true,id:`param-total-credit-count`,children:`Add-on plus subscription credits.`}),_jsxs(ResponseField,{name:`subscription`,type:`object | null`,required:true,id:`param-subscription`,children:[`See `,_jsx(_components.a,{href:`#subscription`,children:`Subscription`}),`.`]}),_jsxs(ResponseField,{name:`usage_session`,type:`object | null`,required:true,id:`param-usage-session`,children:[_jsx(_components.code,{children:`null`}),` unless the installation bills by session; otherwise `,_jsx(_components.code,{children:`{ resets_at, used_percent }`}),`.`]}),_jsx(ResponseField,{name:`credit_balance`,type:`number`,required:true,id:`param-credit-balance`,children:`Present only in session billing mode.`}),_jsxs(ResponseField,{name:`owner`,type:`object`,required:true,id:`param-owner`,children:[`The owning user. Present on the global `,_jsx(_components.code,{children:`workspace`}),` only.`]}),_jsxs(ResponseField,{name:`users`,type:`array`,required:true,id:`param-users`,children:[`Members. Present on the global `,_jsx(_components.code,{children:`workspace`}),` only.`]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`subscription`,children:`Subscription`}),`\n`,_jsxs(ResponseField,{name:`subscription`,type:`object`,id:`param-subscription-1`,children:[_jsxs(_components.p,{children:[`Available as `,_jsx(_components.code,{children:`workspace.subscription`}),`, or `,_jsx(_components.code,{children:`null`}),` when the workspace has none.`]}),_jsxs(Expandable,{title:`Properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id-2`,children:`UUID.`}),_jsx(ResponseField,{name:`trial_period_days`,type:`number`,required:true,id:`param-trial-period-days`,children:`Trial length in days.`}),_jsx(ResponseField,{name:`usage_count`,type:`number`,required:true,id:`param-usage-count`,children:`Credits used in the current period.`}),_jsxs(ResponseField,{name:`usage_percentage`,type:`string`,required:true,id:`param-usage-percentage`,children:[`Percentage `,_jsxs(_components.strong,{children:[`with a `,_jsx(_components.code,{children:`%`}),` suffix`]}),`, such as `,_jsx(_components.code,{children:`\"45.00%\"`}),`.`]}),_jsxs(ResponseField,{name:`credit_count`,type:`number | null`,required:true,id:`param-credit-count-1`,children:[`Credits remaining; `,_jsx(_components.code,{children:`null`}),` means unlimited.`]}),_jsxs(ResponseField,{name:`credit_percentage`,type:`string`,required:true,id:`param-credit-percentage`,children:[`Percentage with a `,_jsx(_components.code,{children:`%`}),` suffix.`]}),_jsx(ResponseField,{name:`created_at`,type:`number`,required:true,id:`param-created-at-2`,children:`Unix timestamp.`}),_jsxs(ResponseField,{name:`updated_at`,type:`number | null`,required:true,id:`param-updated-at-2`,children:[`Unix timestamp, or `,_jsx(_components.code,{children:`null`}),`.`]}),_jsx(ResponseField,{name:`canceled_at`,type:`number | null`,required:true,id:`param-canceled-at`,children:`When the user cancelled.`}),_jsx(ResponseField,{name:`cancel_at`,type:`number | null`,required:true,id:`param-cancel-at`,children:`When access ends.`}),_jsxs(ResponseField,{name:`renew_at`,type:`number | null`,required:true,id:`param-renew-at`,children:[`Next usage reset; `,_jsx(_components.code,{children:`null`}),` once cancelled.`]}),_jsx(ResponseField,{name:`next_billing_at`,type:`number | null`,required:true,id:`param-next-billing-at`,children:`Next payment date, following the plan’s billing cycle.`}),_jsxs(ResponseField,{name:`plan`,type:`object`,required:true,id:`param-plan`,children:[`The plan snapshot. See `,_jsx(_components.a,{href:`#plan-snapshot`,children:`Plan snapshot`}),`.`]}),_jsxs(ResponseField,{name:`currency`,type:`object | null`,required:true,id:`param-currency-1`,children:[`The order’s currency, or `,_jsx(_components.code,{children:`null`}),` when there’s no order.`]}),_jsx(ResponseField,{name:`payment_gateway`,type:`string | null`,required:true,id:`param-payment-gateway`,children:`Gateway key.`}),_jsx(ResponseField,{name:`external_id`,type:`string | null`,required:true,id:`param-external-id`,children:`The provider’s reference.`})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`plan`,children:`Plan`}),`\n`,_jsxs(ResponseField,{name:`plans`,type:`array`,id:`param-plans`,children:[_jsxs(_components.p,{children:[`Active plans, sorted by price ascending. `,_jsx(_components.strong,{children:`Available on the landing page only.`})]}),_jsxs(Expandable,{title:`Plan properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id-3`,children:`UUID, used in the checkout link.`}),_jsx(ResponseField,{name:`title`,type:`string`,required:true,id:`param-title`,children:`Plan name.`}),_jsx(ResponseField,{name:`description`,type:`string | null`,required:true,id:`param-description`,children:`Short description.`}),_jsx(ResponseField,{name:`icon`,type:`string | null`,required:true,id:`param-icon`,children:`An icon name, or raw SVG markup.`}),_jsxs(ResponseField,{name:`price`,type:`number`,required:true,id:`param-price`,children:[`Minor units, such as `,_jsx(_components.code,{children:`2900`}),` for 29.00.`]}),_jsx(ResponseField,{name:`sale_price`,type:`number | null`,required:true,id:`param-sale-price`,children:`Discounted price when a coupon applies.`}),_jsxs(ResponseField,{name:`billing_cycle`,type:`string`,required:true,id:`param-billing-cycle`,children:[_jsx(_components.code,{children:`one-time`}),`, `,_jsx(_components.code,{children:`monthly`}),`, `,_jsx(_components.code,{children:`yearly`}),` or `,_jsx(_components.code,{children:`lifetime`}),`.`]}),_jsxs(ResponseField,{name:`credit_count`,type:`number | null`,required:true,id:`param-credit-count-2`,children:[_jsx(_components.code,{children:`null`}),` means unlimited.`]}),_jsxs(ResponseField,{name:`member_cap`,type:`number | null`,required:true,id:`param-member-cap`,children:[`Member limit; `,_jsx(_components.code,{children:`null`}),` means unlimited.`]}),_jsx(ResponseField,{name:`is_featured`,type:`boolean`,required:true,id:`param-is-featured`,children:`Highlight this plan.`}),_jsx(ResponseField,{name:`superiority`,type:`number`,required:true,id:`param-superiority`,children:`Ordering weight for comparison tables.`}),_jsx(ResponseField,{name:`created_at`,type:`number`,required:true,id:`param-created-at-3`,children:`Unix timestamp.`}),_jsxs(ResponseField,{name:`updated_at`,type:`number | null`,required:true,id:`param-updated-at-3`,children:[`Unix timestamp, or `,_jsx(_components.code,{children:`null`}),`.`]}),_jsxs(ResponseField,{name:`feature_list`,type:`array`,required:true,id:`param-feature-list`,children:[`Objects of `,_jsx(_components.code,{children:`{ title, is_included }`}),`. A line entered with a leading `,_jsx(_components.code,{children:`-`}),` becomes `,_jsx(_components.code,{children:`is_included: false`}),`.`]}),_jsxs(ResponseField,{name:`config`,type:`object`,required:true,id:`param-config-1`,children:[`Capabilities. See `,_jsx(_components.a,{href:`#plan-config`,children:`Plan config`}),`.`]}),_jsx(ResponseField,{name:`coupon`,type:`object | null`,required:true,id:`param-coupon`,children:`The applied coupon.`}),_jsx(ResponseField,{name:`discount`,type:`number | null`,required:true,id:`param-discount`,children:`Discount amount when a coupon applies.`}),_jsx(ResponseField,{name:`snapshot`,type:`object`,required:true,id:`param-snapshot`,children:`The snapshot subscriptions are based on.`})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`plan-snapshot`,children:`Plan snapshot`}),`\n`,_jsx(ResponseField,{name:`plan_snapshot`,type:`object`,id:`param-plan-snapshot`,children:_jsxs(_components.p,{children:[`A frozen copy of a plan, available as `,_jsx(_components.code,{children:`subscription.plan`}),`. It carries `,_jsx(_components.code,{children:`id`}),`, `,_jsx(_components.code,{children:`title`}),`, `,_jsx(_components.code,{children:`description`}),`, `,_jsx(_components.code,{children:`icon`}),`, `,_jsx(_components.code,{children:`price`}),`, `,_jsx(_components.code,{children:`billing_cycle`}),`, `,_jsx(_components.code,{children:`credit_count`}),`, `,_jsx(_components.code,{children:`member_cap`}),`, `,_jsx(_components.code,{children:`created_at`}),`, `,_jsx(_components.code,{children:`updated_at`}),`, `,_jsx(_components.code,{children:`config`}),` and `,_jsx(_components.code,{children:`feature_list`}),`, with the same meanings as on a plan. It has no `,_jsx(_components.code,{children:`sale_price`}),`, `,_jsx(_components.code,{children:`coupon`}),`, `,_jsx(_components.code,{children:`discount`}),` or `,_jsx(_components.code,{children:`snapshot`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`plan-config`,children:`Plan config`}),`\n`,_jsxs(ResponseField,{name:`config`,type:`object`,id:`param-config-2`,children:[_jsxs(_components.p,{children:[`What a plan grants. Available as `,_jsx(_components.code,{children:`plan.config`}),` and `,_jsx(_components.code,{children:`subscription.plan.config`}),`.`]}),_jsxs(Expandable,{title:`Properties`,children:[_jsx(ResponseField,{name:`chat`,type:`object`,id:`param-chat`,children:`Chat capability settings.`}),_jsx(ResponseField,{name:`writer`,type:`object`,id:`param-writer`,children:`Writer settings.`}),_jsx(ResponseField,{name:`imagine`,type:`object`,id:`param-imagine`,children:`Image generation settings.`}),_jsx(ResponseField,{name:`video`,type:`object`,id:`param-video`,children:`Video settings.`}),_jsx(ResponseField,{name:`transcriber`,type:`object`,id:`param-transcriber`,children:`Transcription settings.`}),_jsx(ResponseField,{name:`voiceover`,type:`object`,id:`param-voiceover`,children:`Voice-over settings.`}),_jsx(ResponseField,{name:`voice_isolator`,type:`object`,id:`param-voice-isolator`,children:`Voice isolation settings.`}),_jsx(ResponseField,{name:`classifier`,type:`object`,id:`param-classifier`,children:`Classification settings.`}),_jsxs(ResponseField,{name:`models`,type:`array | null`,id:`param-models`,children:[`Allowed model keys; `,_jsx(_components.code,{children:`null`}),` means all.`]}),_jsx(ResponseField,{name:`tools`,type:`object`,id:`param-tools`,children:`Tool switches, keyed by capability.`}),_jsxs(ResponseField,{name:`assistants`,type:`array | null`,id:`param-assistants`,children:[`Allowed assistants; `,_jsx(_components.code,{children:`null`}),` means all.`]}),_jsxs(ResponseField,{name:`presets`,type:`array | null`,id:`param-presets`,children:[`Allowed templates; `,_jsx(_components.code,{children:`null`}),` means all.`]}),_jsx(ResponseField,{name:`extensions`,type:`object`,id:`param-extensions`,children:`Per-plan settings added by plugins, keyed by extension.`})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`affiliate`,children:`Affiliate`}),`\n`,_jsxs(ResponseField,{name:`affiliate`,type:`object`,id:`param-affiliate-1`,children:[_jsxs(_components.p,{children:[`Available as `,_jsx(_components.code,{children:`user.affiliate`}),`. Every user has one.`]}),_jsxs(Expandable,{title:`Properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id-4`,children:`UUID.`}),_jsx(ResponseField,{name:`code`,type:`string`,required:true,id:`param-code-2`,children:`Referral code.`}),_jsx(ResponseField,{name:`clicks`,type:`number`,required:true,id:`param-clicks`,children:`Tracked clicks.`}),_jsx(ResponseField,{name:`referrals`,type:`number`,required:true,id:`param-referrals`,children:`Referred signups.`}),_jsx(ResponseField,{name:`balance`,type:`number`,required:true,id:`param-balance`,children:`Available balance, converted into the billing currency.`}),_jsx(ResponseField,{name:`pending`,type:`number`,required:true,id:`param-pending`,children:`Pending balance, converted into the billing currency.`}),_jsx(ResponseField,{name:`withdrawn`,type:`number`,required:true,id:`param-withdrawn`,children:`Withdrawn total, converted into the billing currency.`}),_jsx(ResponseField,{name:`currency`,type:`object`,required:true,id:`param-currency-2`,children:`The currency those amounts are in.`}),_jsx(ResponseField,{name:`paypal_email`,type:`string | null`,required:true,id:`param-paypal-email`,children:`Payout email.`}),_jsx(ResponseField,{name:`bank_requisites`,type:`string | null`,required:true,id:`param-bank-requisites`,children:`Bank details.`}),_jsx(ResponseField,{name:`payout_method`,type:`string | null`,required:true,id:`param-payout-method`,children:`Chosen payout method.`})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`address`,children:`Address`}),`\n`,_jsxs(ResponseField,{name:`address`,type:`object`,id:`param-address-1`,children:[_jsxs(_components.p,{children:[`Available as `,_jsx(_components.code,{children:`workspace.address`}),`, or `,_jsx(_components.code,{children:`null`}),`.`]}),_jsxs(Expandable,{title:`Properties`,children:[_jsx(ResponseField,{name:`country`,type:`string | null`,id:`param-country-1`,children:`Country code.`}),_jsx(ResponseField,{name:`state`,type:`string | null`,id:`param-state`,children:`State or region.`}),_jsx(ResponseField,{name:`city`,type:`string | null`,id:`param-city`,children:`City.`}),_jsx(ResponseField,{name:`line1`,type:`string | null`,id:`param-line1`,children:`Street address.`}),_jsx(ResponseField,{name:`line2`,type:`string | null`,id:`param-line2`,children:`Second address line.`}),_jsx(ResponseField,{name:`zip`,type:`string | null`,id:`param-zip`,children:`Postal code.`}),_jsx(ResponseField,{name:`phone_number`,type:`string | null`,id:`param-phone-number-1`,children:`Phone number.`})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`country`,children:`Country`}),`\n`,_jsxs(ResponseField,{name:`country`,type:`object | null`,id:`param-country-2`,children:[_jsxs(_components.p,{children:[`Available as `,_jsx(_components.code,{children:`user.country`}),`.`]}),_jsxs(Expandable,{title:`Properties`,children:[_jsx(ResponseField,{name:`name`,type:`string`,required:true,id:`param-name-3`,children:`Localized country name.`}),_jsx(ResponseField,{name:`alpha2`,type:`string`,required:true,id:`param-alpha2`,children:`Two-letter code.`}),_jsx(ResponseField,{name:`alpha3`,type:`string`,required:true,id:`param-alpha3`,children:`Three-letter code.`}),_jsx(ResponseField,{name:`flag_url`,type:`string`,required:true,id:`param-flag-url`,children:`Flag image URL.`})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`workspace-invitation`,children:`Workspace invitation`}),`\n`,_jsxs(ResponseField,{name:`workspace_invitation`,type:`object`,id:`param-workspace-invitation`,children:[_jsxs(_components.p,{children:[`Entries of `,_jsx(_components.code,{children:`workspace.invitations`}),`.`]}),_jsxs(Expandable,{title:`Properties`,children:[_jsx(ResponseField,{name:`id`,type:`string`,required:true,id:`param-id-5`,children:`UUID.`}),_jsx(ResponseField,{name:`email`,type:`string`,required:true,id:`param-email-1`,children:`Invited address.`}),_jsx(ResponseField,{name:`created_at`,type:`number`,required:true,id:`param-created-at-4`,children:`Unix timestamp.`}),_jsxs(ResponseField,{name:`updated_at`,type:`number | null`,required:true,id:`param-updated-at-4`,children:[`Unix timestamp, or `,_jsx(_components.code,{children:`null`}),`.`]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`notes-on-types`,children:`Notes on types`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Timestamps`}),` are Unix seconds, or `,_jsx(_components.code,{children:`null`}),`. Format them with Twig’s date filters.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Money`}),` is an integer in the currency’s minor units. Use `,_jsx(_components.code,{children:`\u003cx-money>`}),` or `,_jsx(_components.code,{children:`format_currency`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Credits`}),` use `,_jsx(_components.code,{children:`null`}),` for unlimited, which is different from `,_jsx(_components.code,{children:`0`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Percentages`}),` on a subscription are strings that already include `,_jsx(_components.code,{children:`%`}),`.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`related`,children:`Related`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/development/themes/twig-reference`,children:`Twig reference`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/development/themes/pricing-and-plans`,children:`Pricing and plans`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/development/themes/users-and-navigation`,children:`Users and navigation`})}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Template objects reference","sidebarTitle":"Template objects","description":"Every variable and object available in an Aikeedo theme template, with its fields, types and availability.","href":"/development/themes/template-objects"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Availability at a glance","slug":"availability-at-a-glance","depth":2,"children":[]},{"title":"Globals","slug":"globals","depth":2,"children":[]},{"title":"Currency","slug":"currency","depth":2,"children":[]},{"title":"Locales","slug":"locales","depth":2,"children":[]},{"title":"User","slug":"user","depth":2,"children":[]},{"title":"Workspace","slug":"workspace","depth":2,"children":[]},{"title":"Subscription","slug":"subscription","depth":2,"children":[]},{"title":"Plan","slug":"plan","depth":2,"children":[]},{"title":"Plan snapshot","slug":"plan-snapshot","depth":2,"children":[]},{"title":"Plan config","slug":"plan-config","depth":2,"children":[]},{"title":"Affiliate","slug":"affiliate","depth":2,"children":[]},{"title":"Address","slug":"address","depth":2,"children":[]},{"title":"Country","slug":"country","depth":2,"children":[]},{"title":"Workspace invitation","slug":"workspace-invitation","depth":2,"children":[]},{"title":"Notes on types","slug":"notes-on-types","depth":2,"children":[]},{"title":"Related","slug":"related","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"aikeedo","siteName":"Aikeedo Docs","title":"Template objects reference - Aikeedo Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-17T19:23:10.679Z","originalFileLocation":"development/themes/template-objects.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Every variable and object available in an Aikeedo theme template, with its fields, types and availability.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Aikeedo Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/aikeedo/qXdfuDxaHkWXOEhU/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/aikeedo/qXdfuDxaHkWXOEhU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/aikeedo/qXdfuDxaHkWXOEhU/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/aikeedo/qXdfuDxaHkWXOEhU/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/aikeedo/qXdfuDxaHkWXOEhU/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/aikeedo/qXdfuDxaHkWXOEhU/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/aikeedo/qXdfuDxaHkWXOEhU/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/aikeedo/qXdfuDxaHkWXOEhU/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/aikeedo/qXdfuDxaHkWXOEhU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Template objects reference - Aikeedo Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Every variable and object available in an Aikeedo theme template, with its fields, types and availability.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Aikeedo Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.aikeedo.com/development/themes/template-objects\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://aikeedo.mintlify.site/_mintlify/api/og/v2?division=Reference\u0026amp;title=Template+objects+reference\u0026amp;description=Every+variable+and+object+available+in+an+Aikeedo+theme+template%2C+with+its+fields%2C+types+and+availability.\u0026amp;theme=e2b75c77f1bb492b8721f76f\u0026amp;signature=454b8ed7c2a04af09fc3288e4e62397670f057e4524ab7421a4d42204fa700d4\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Template objects reference - Aikeedo Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Every variable and object available in an Aikeedo theme template, with its fields, types and availability.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://aikeedo.mintlify.site/_mintlify/api/og/v2?division=Reference\u0026amp;title=Template+objects+reference\u0026amp;description=Every+variable+and+object+available+in+an+Aikeedo+theme+template%2C+with+its+fields%2C+types+and+availability.\u0026amp;theme=e2b75c77f1bb492b8721f76f\u0026amp;signature=454b8ed7c2a04af09fc3288e4e62397670f057e4524ab7421a4d42204fa700d4\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/aikeedo/qXdfuDxaHkWXOEhU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Aikeedo Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#24282c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.aikeedo.com/development/themes/template-objects\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/development/themes/template-objects.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.aikeedo.com/#organization\",\"name\":\"Aikeedo Docs\",\"url\":\"https://docs.aikeedo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/aikeedo/AhiAA6H0ZT4BonAW/logo/light.svg?fit=max\u0026auto=format\u0026n=AhiAA6H0ZT4BonAW\u0026q=85\u0026s=fc9332778893ff8eda4b5ce14142b391\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.aikeedo.com#website\",\"name\":\"Aikeedo Docs\",\"url\":\"https://docs.aikeedo.com\",\"publisher\":{\"@id\":\"https://docs.aikeedo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.aikeedo.com/development/themes/template-objects#webpage\",\"url\":\"https://docs.aikeedo.com/development/themes/template-objects\",\"name\":\"Template objects reference\",\"description\":\"Every variable and object available in an Aikeedo theme template, with its fields, types and availability.\",\"dateModified\":\"2026-09-17T19:23:10.679Z\",\"isPartOf\":{\"@id\":\"https://docs.aikeedo.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.aikeedo.com/development/themes/template-objects#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.aikeedo.com/development/themes/template-objects#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Themes\",\"item\":\"https://docs.aikeedo.com/development/themes/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Reference\",\"item\":\"https://docs.aikeedo.com/development/themes/twig-reference\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Template objects reference\",\"item\":\"https://docs.aikeedo.com/development/themes/template-objects\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.aikeedo.com/development/themes/template-objects#article\",\"headline\":\"Template objects reference\",\"name\":\"Template objects reference\",\"description\":\"Every variable and object available in an Aikeedo theme template, with its fields, types and availability.\",\"url\":\"https://docs.aikeedo.com/development/themes/template-objects\",\"mainEntityOfPage\":{\"@id\":\"https://docs.aikeedo.com/development/themes/template-objects#webpage\"},\"dateModified\":\"2026-09-17T19:23:10.679Z\",\"publisher\":{\"@id\":\"https://docs.aikeedo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.aikeedo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Aikeedo Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Aikeedo Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/development/themes/template-objects.md","siteName":"Aikeedo Docs","nav":{"global":{"anchors":[{"anchor":"Affiliates","icon":"coin","href":"https://aikeedo.com/affiliates/?utm_source=docs\u0026utm_medium=nav"},{"anchor":"Changelog","icon":"chart-area-line","href":"https://aikeedo.com/changelog/?utm_source=docs\u0026utm_medium=nav"},{"anchor":"Feature Requests","icon":"star","href":"https://feedback.aikeedo.com/"}]},"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/overview/introduction"}]},{"tab":"Development","groups":[{"group":"Get Started","pages":[{"title":"Aikeedo developer documentation","sidebarTitle":"Introduction","href":"/development/introduction"},{"title":"Local development environment","sidebarTitle":"Local development","href":"/development/local-development"},{"title":"Extending Aikeedo","sidebarTitle":"Extending Aikeedo","href":"/development/extending-aikeedo"},{"title":"Coding standards and quality tools","sidebarTitle":"Coding standards","href":"/development/coding-standards"},{"title":"Get your add-on listed","sidebarTitle":"Get listed","href":"/development/community-add-ons"}]},{"group":"Plugins","pages":[{"title":"Aikeedo plugins","sidebarTitle":"Overview","href":"/development/plugins/overview"},{"title":"Build your first plugin","sidebarTitle":"Quickstart","href":"/development/plugins/quickstart"},{"title":"Plugin manifest reference","sidebarTitle":"Manifest","href":"/development/plugins/manifest"},{"title":"Plugin lifecycle and hooks","sidebarTitle":"Lifecycle and hooks","href":"/development/plugins/lifecycle-and-hooks"},{"group":"Building Blocks","pages":[{"title":"Dependency injection and core services","sidebarTitle":"Dependency injection","href":"/development/plugins/dependency-injection-and-services"},{"title":"Routes and request handlers","sidebarTitle":"Routes and handlers","href":"/development/plugins/routes-and-request-handlers"},{"title":"Admin settings pages","sidebarTitle":"Admin settings pages","href":"/development/plugins/admin-settings-pages"},{"title":"App pages and workspace APIs","sidebarTitle":"App pages and APIs","href":"/development/plugins/app-pages-and-apis"},{"title":"Frontend integration","sidebarTitle":"Frontend integration","href":"/development/plugins/frontend-integration"},{"title":"Navigation","sidebarTitle":"Navigation","href":"/development/plugins/navigation"},{"title":"Events and scheduled work","sidebarTitle":"Events and cron","href":"/development/plugins/events-and-cron"},{"title":"Data and persistence","sidebarTitle":"Data and persistence","href":"/development/plugins/data-and-persistence"},{"title":"Files and storage","sidebarTitle":"Files and storage","href":"/development/plugins/files-and-storage"},{"title":"Using AI models and credits","sidebarTitle":"AI models and credits","href":"/development/plugins/ai-models-and-credits"},{"title":"Streaming responses","sidebarTitle":"Streaming responses","href":"/development/plugins/streaming-responses"},{"title":"Public pages and endpoints","sidebarTitle":"Public endpoints","href":"/development/plugins/public-endpoints-and-embeds"},{"title":"Public assets","sidebarTitle":"Public assets","href":"/development/plugins/public-assets"},{"title":"Plugin localization","sidebarTitle":"Localization","href":"/development/plugins/localization"},{"title":"Custom extension points","sidebarTitle":"Custom extension points","href":"/development/plugins/custom-extension-points"}]},{"group":"Ship \u0026 Maintain","pages":[{"title":"Packaging and distribution","sidebarTitle":"Packaging","href":"/development/plugins/packaging-and-distribution"},{"title":"Debugging plugins","sidebarTitle":"Debugging","href":"/development/plugins/debugging"},{"title":"Upgrading plugins to Aikeedo 5.0","sidebarTitle":"Upgrading to v5","href":"/development/plugins/upgrading-to-v5"}]}]},{"group":"Extension Guides","pages":[{"group":"Payment Gateways","pages":[{"title":"Payment gateways","sidebarTitle":"Overview","href":"/development/plugins/guides/payments/overview"},{"title":"Build a payment gateway","sidebarTitle":"Build a gateway","href":"/development/plugins/guides/payments/building-a-gateway"},{"title":"Checkout flows","sidebarTitle":"Checkout flows","href":"/development/plugins/guides/payments/checkout-flows"},{"title":"Subscriptions and renewals","sidebarTitle":"Subscriptions","href":"/development/plugins/guides/payments/subscriptions-and-renewals"},{"title":"Payment webhooks","sidebarTitle":"Webhooks","href":"/development/plugins/guides/payments/webhooks"}]},{"title":"Build a tax engine","sidebarTitle":"Tax engines","href":"/development/plugins/guides/tax-engine"},{"title":"Build an invoicing engine","sidebarTitle":"Invoicing engines","href":"/development/plugins/guides/invoicing-engine"},{"title":"Build a storage adapter","sidebarTitle":"Storage adapters","href":"/development/plugins/guides/storage-adapter"},{"title":"Build a vector store","sidebarTitle":"Vector stores","href":"/development/plugins/guides/vector-store"},{"title":"Add an AI provider","sidebarTitle":"AI providers","href":"/development/plugins/guides/ai-provider"},{"title":"Add an AI tool","sidebarTitle":"AI tools","href":"/development/plugins/guides/ai-tool"},{"title":"Build a currency rate provider","sidebarTitle":"Currency rate providers","href":"/development/plugins/guides/currency-rate-provider"},{"title":"Add per-plan settings","sidebarTitle":"Plan config extensions","href":"/development/plugins/guides/plan-config-extension"},{"title":"Build an event-driven integration","sidebarTitle":"Event-driven integrations","href":"/development/plugins/guides/event-driven-integration"},{"title":"Add an import adapter","sidebarTitle":"Import adapters","href":"/development/plugins/guides/import-adapter"},{"title":"Build an embeddable widget","sidebarTitle":"Embeddable widgets","href":"/development/plugins/guides/embeddable-widget"}]},{"group":"Themes","pages":[{"title":"Aikeedo themes","sidebarTitle":"Overview","href":"/development/themes/overview"},{"title":"Build your first theme","sidebarTitle":"Quickstart","href":"/development/themes/quickstart"},{"title":"The minimum theme","sidebarTitle":"Minimum theme","href":"/development/themes/minimum-theme"},{"title":"Theme structure","sidebarTitle":"Structure","href":"/development/themes/structure"},{"title":"Theme manifest","sidebarTitle":"Manifest","href":"/development/themes/manifest"},{"title":"Build pipeline and assets","sidebarTitle":"Build and assets","href":"/development/themes/build-and-assets"},{"group":"Templates","pages":[{"title":"Templates and layouts","sidebarTitle":"Templates and layouts","href":"/development/themes/templates-and-layouts"},{"title":"Pricing and plans","sidebarTitle":"Pricing and plans","href":"/development/themes/pricing-and-plans"},{"title":"Users and navigation","sidebarTitle":"Users and navigation","href":"/development/themes/users-and-navigation"},{"title":"Dark mode and colors","sidebarTitle":"Dark mode and colors","href":"/development/themes/dark-mode-and-colors"},{"title":"Script tags and analytics","sidebarTitle":"Script tags","href":"/development/themes/script-tags-and-analytics"},{"title":"JavaScript and components","sidebarTitle":"JavaScript","href":"/development/themes/javascript-components"},{"title":"Custom pages","sidebarTitle":"Custom pages","href":"/development/themes/custom-pages"},{"title":"Theme localization","sidebarTitle":"Localization","href":"/development/themes/localization"}]},{"group":"Reference","pages":[{"title":"Twig reference","sidebarTitle":"Twig reference","description":"Every Twig function, filter, test and global available in an Aikeedo theme template.","href":"/development/themes/twig-reference"},{"title":"Template objects reference","sidebarTitle":"Template objects","href":"/development/themes/template-objects"}]},{"group":"Ship \u0026 Maintain","pages":[{"title":"Customizing an existing theme","sidebarTitle":"Customizing themes","description":"Adapt the default or a marketplace Aikeedo theme without losing your changes when the platform updates.","href":"/development/themes/customizing-existing-themes"},{"title":"Packaging and publishing","sidebarTitle":"Packaging","href":"/development/themes/packaging-and-publishing"},{"title":"Theme troubleshooting","sidebarTitle":"Troubleshooting","href":"/development/themes/troubleshooting"}]}]},{"group":"Core Architecture","pages":[{"group":"Foundations","pages":[{"title":"Core architecture","sidebarTitle":"Overview","href":"/development/core/overview"},{"title":"Directory structure","sidebarTitle":"Directory structure","href":"/development/core/directory-structure"},{"title":"Bootstrap and request lifecycle","sidebarTitle":"Bootstrap and lifecycle","href":"/development/core/bootstrap-and-lifecycle"},{"title":"Modules and layers","sidebarTitle":"Modules and layers","href":"/development/core/modules-and-layers"},{"title":"Dependency injection","sidebarTitle":"Dependency injection","href":"/development/core/dependency-injection"},{"title":"Configuration","sidebarTitle":"Configuration","href":"/development/core/configuration"},{"title":"Command bus","sidebarTitle":"Command bus","href":"/development/core/command-bus"},{"title":"Events","sidebarTitle":"Events","href":"/development/core/events"}]},{"group":"HTTP Layer","pages":[{"title":"Routing and middleware","sidebarTitle":"Routing and middleware","href":"/development/core/routing-and-middleware"},{"title":"Authentication and authorization","sidebarTitle":"Auth","href":"/development/core/authentication-and-authorization"},{"title":"Views and frontend","sidebarTitle":"Views and frontend","href":"/development/core/views-and-frontend"}]},{"group":"Subsystems","pages":[{"title":"Database and migrations","sidebarTitle":"Database","href":"/development/core/database-and-migrations"},{"title":"AI subsystem","sidebarTitle":"AI subsystem","href":"/development/core/ai-subsystem"},{"title":"Billing subsystem","sidebarTitle":"Billing","href":"/development/core/billing-subsystem"},{"title":"Storage and files","sidebarTitle":"Storage and files","href":"/development/core/storage-and-files"},{"title":"Background jobs and cron","sidebarTitle":"Cron and jobs","href":"/development/core/background-jobs-and-cron"},{"title":"Email","sidebarTitle":"Email","href":"/development/core/email"},{"title":"Localization internals","sidebarTitle":"Localization","href":"/development/core/localization-internals"},{"title":"Caching and logging","sidebarTitle":"Caching and logging","href":"/development/core/caching-and-logging"}]},{"group":"Tooling","pages":[{"title":"Console commands","sidebarTitle":"Console commands","href":"/development/core/console-commands"},{"title":"Testing and code quality","sidebarTitle":"Testing and quality","href":"/development/core/testing-and-quality"}]}]},{"group":"REST API","pages":[{"title":"REST API overview","sidebarTitle":"Overview","href":"/development/api/overview"}]}]}]},"basePath":"","title":"Template objects reference - Aikeedo Docs","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":[],"chunks":[]}