[{"data":1,"prerenderedAt":2257},["ShallowReactive",2],{"navigation_docs":3,"-modules-commerce-subscriptions":587,"-modules-commerce-subscriptions-surround":2252},[4,50,155,441,504],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":49},"Get Started","i-lucide-rocket","\u002Fget-started","1.get-started",[10,15,20,25,30,35,40,45],{"title":11,"path":12,"stem":13,"icon":14},"Introduction","\u002Fget-started\u002Fintroduction","1.get-started\u002F1.introduction","i-lucide-house",{"title":16,"path":17,"stem":18,"icon":19},"Installation","\u002Fget-started\u002Finstallation","1.get-started\u002F2.installation","i-lucide-download",{"title":21,"path":22,"stem":23,"icon":24},"Project structure","\u002Fget-started\u002Fproject-structure","1.get-started\u002F3.project-structure","i-lucide-folder-tree",{"title":26,"path":27,"stem":28,"icon":29},"Configuration","\u002Fget-started\u002Fconfiguration","1.get-started\u002F4.configuration","i-lucide-settings",{"title":31,"path":32,"stem":33,"icon":34},"Authentication","\u002Fget-started\u002Fauthentication","1.get-started\u002F5.authentication","i-lucide-lock",{"title":36,"path":37,"stem":38,"icon":39},"Adding modules","\u002Fget-started\u002Fadding-modules","1.get-started\u002F6.adding-modules","i-lucide-puzzle",{"title":41,"path":42,"stem":43,"icon":44},"Database","\u002Fget-started\u002Fdatabase","1.get-started\u002F7.database","i-lucide-database",{"title":46,"path":47,"stem":48,"icon":6},"Deployment","\u002Fget-started\u002Fdeployment","1.get-started\u002F8.deployment",false,{"title":51,"icon":52,"path":53,"stem":54,"children":55,"page":49},"Guide","i-lucide-book-open","\u002Fguide","2.guide",[56,90,115,125],{"title":57,"icon":49,"path":58,"stem":59,"children":60,"page":49},"Concepts","\u002Fguide\u002Fconcepts","2.guide\u002F1.concepts",[61,66,71,76,80,85],{"title":62,"path":63,"stem":64,"icon":65},"Architecture","\u002Fguide\u002Fconcepts\u002Farchitecture","2.guide\u002F1.concepts\u002F1.architecture","i-lucide-blocks",{"title":67,"path":68,"stem":69,"icon":70},"Access control","\u002Fguide\u002Fconcepts\u002Fauth-and-scopes","2.guide\u002F1.concepts\u002F2.auth-and-scopes","i-lucide-shield-check",{"title":72,"path":73,"stem":74,"icon":75},"Extension points","\u002Fguide\u002Fconcepts\u002Fextension-points","2.guide\u002F1.concepts\u002F3.extension-points","i-lucide-plug",{"title":77,"path":78,"stem":79,"icon":44},"Database extensions","\u002Fguide\u002Fconcepts\u002Fdatabase-extensions","2.guide\u002F1.concepts\u002F4.database-extensions",{"title":81,"path":82,"stem":83,"icon":84},"Identity","\u002Fguide\u002Fconcepts\u002Fidentity","2.guide\u002F1.concepts\u002F5.identity","i-lucide-fingerprint",{"title":86,"path":87,"stem":88,"icon":89},"Glossary","\u002Fguide\u002Fconcepts\u002Fglossary","2.guide\u002F1.concepts\u002F6.glossary","i-lucide-book-a",{"title":91,"icon":49,"path":92,"stem":93,"children":94,"page":49},"UX patterns","\u002Fguide\u002Fux-patterns","2.guide\u002F2.ux-patterns",[95,100,105,110],{"title":96,"path":97,"stem":98,"icon":99},"Layouts and navigation","\u002Fguide\u002Fux-patterns\u002Flayouts-and-navigation","2.guide\u002F2.ux-patterns\u002F1.layouts-and-navigation","i-lucide-layout-template",{"title":101,"path":102,"stem":103,"icon":104},"Pages","\u002Fguide\u002Fux-patterns\u002Fpages","2.guide\u002F2.ux-patterns\u002F2.pages","i-lucide-table",{"title":106,"path":107,"stem":108,"icon":109},"Forms and actions","\u002Fguide\u002Fux-patterns\u002Fforms-and-actions","2.guide\u002F2.ux-patterns\u002F3.forms-and-actions","i-lucide-square-pen",{"title":111,"path":112,"stem":113,"icon":114},"Text and formatting","\u002Fguide\u002Fux-patterns\u002Ftext-and-formatting","2.guide\u002F2.ux-patterns\u002F4.text-and-formatting","i-lucide-type",{"title":116,"icon":49,"path":117,"stem":118,"children":119,"page":49},"Best practices","\u002Fguide\u002Fbest-practices","2.guide\u002F3.best-practices",[120],{"title":121,"path":122,"stem":123,"icon":124},"HTTP routes","\u002Fguide\u002Fbest-practices\u002Fhttp-routes","2.guide\u002F3.best-practices\u002F1.http-routes","i-lucide-route",{"title":126,"icon":49,"path":127,"stem":128,"children":129,"page":49},"Going further","\u002Fguide\u002Fgoing-further","2.guide\u002F4.going-further",[130,135,140,145,150],{"title":131,"path":132,"stem":133,"icon":134},"Use your own OAuth server","\u002Fguide\u002Fgoing-further\u002Fown-oauth-server","2.guide\u002F4.going-further\u002F1.own-oauth-server","i-lucide-key-round",{"title":136,"path":137,"stem":138,"icon":139},"Create an OAuth application","\u002Fguide\u002Fgoing-further\u002Foauth-application","2.guide\u002F4.going-further\u002F2.oauth-application","i-lucide-app-window",{"title":141,"path":142,"stem":143,"icon":144},"Signing keys","\u002Fguide\u002Fgoing-further\u002Fsigning-keys","2.guide\u002F4.going-further\u002F3.signing-keys","i-lucide-key-square",{"title":146,"path":147,"stem":148,"icon":149},"Stripe setup","\u002Fguide\u002Fgoing-further\u002Fstripe-setup","2.guide\u002F4.going-further\u002F4.stripe-setup","i-lucide-credit-card",{"title":151,"path":152,"stem":153,"icon":154},"Migrate to the permission model","\u002Fguide\u002Fgoing-further\u002Fmigrate-access-control","2.guide\u002F4.going-further\u002F5.migrate-access-control","i-lucide-arrow-right-left",{"title":156,"icon":157,"path":158,"stem":159,"children":160},"Modules","i-lucide-boxes","\u002Fmodules","3.modules",[161,163,244,273,320,375],{"title":156,"path":158,"stem":162},"3.modules\u002Findex",{"title":81,"icon":49,"path":164,"stem":165,"children":166,"page":49},"\u002Fmodules\u002Fidentity","3.modules\u002F1.identity",[167,190,194,198,220,224,240],{"title":168,"path":169,"stem":170,"children":171},"Auth","\u002Fmodules\u002Fidentity\u002Fauth","3.modules\u002F1.identity\u002F1.auth\u002Findex",[172,174,178,182,186],{"title":173,"path":169,"stem":170},"Overview",{"title":175,"path":176,"stem":177},"Server API","\u002Fmodules\u002Fidentity\u002Fauth\u002Fserver","3.modules\u002F1.identity\u002F1.auth\u002F2.server",{"title":179,"path":180,"stem":181},"Reference","\u002Fmodules\u002Fidentity\u002Fauth\u002Freference","3.modules\u002F1.identity\u002F1.auth\u002F3.reference",{"title":183,"path":184,"stem":185},"Client mode","\u002Fmodules\u002Fidentity\u002Fauth\u002Fclient-mode","3.modules\u002F1.identity\u002F1.auth\u002F4.client-mode",{"title":187,"path":188,"stem":189},"OAuth providers","\u002Fmodules\u002Fidentity\u002Fauth\u002Foauth-providers","3.modules\u002F1.identity\u002F1.auth\u002F5.oauth-providers",{"title":191,"path":192,"stem":193},"Users","\u002Fmodules\u002Fidentity\u002Fusers","3.modules\u002F1.identity\u002F2.users",{"title":195,"path":196,"stem":197},"Account","\u002Fmodules\u002Fidentity\u002Faccount","3.modules\u002F1.identity\u002F3.account",{"title":199,"path":200,"stem":201,"children":202},"Authorization","\u002Fmodules\u002Fidentity\u002Fauthorization","3.modules\u002F1.identity\u002F4.authorization\u002Findex",[203,204,208,212,216],{"title":173,"path":200,"stem":201},{"title":205,"path":206,"stem":207},"Roles and requirements","\u002Fmodules\u002Fidentity\u002Fauthorization\u002Froles-and-requirements","3.modules\u002F1.identity\u002F4.authorization\u002F2.roles-and-requirements",{"title":209,"path":210,"stem":211},"Policies","\u002Fmodules\u002Fidentity\u002Fauthorization\u002Fpolicies","3.modules\u002F1.identity\u002F4.authorization\u002F3.policies",{"title":213,"path":214,"stem":215},"Client","\u002Fmodules\u002Fidentity\u002Fauthorization\u002Fclient","3.modules\u002F1.identity\u002F4.authorization\u002F4.client",{"title":217,"path":218,"stem":219},"Admin","\u002Fmodules\u002Fidentity\u002Fauthorization\u002Fadmin","3.modules\u002F1.identity\u002F4.authorization\u002F5.admin",{"title":221,"path":222,"stem":223},"Preferences","\u002Fmodules\u002Fidentity\u002Fpreferences","3.modules\u002F1.identity\u002F5.preferences",{"title":225,"path":226,"stem":227,"children":228},"OAuth Server","\u002Fmodules\u002Fidentity\u002Foauth-server","3.modules\u002F1.identity\u002F6.oauth-server\u002Findex",[229,230,233,237],{"title":173,"path":226,"stem":227},{"title":175,"path":231,"stem":232},"\u002Fmodules\u002Fidentity\u002Foauth-server\u002Fserver","3.modules\u002F1.identity\u002F6.oauth-server\u002F2.server",{"title":234,"path":235,"stem":236},"Hooks","\u002Fmodules\u002Fidentity\u002Foauth-server\u002Fhooks","3.modules\u002F1.identity\u002F6.oauth-server\u002F3.hooks",{"title":179,"path":238,"stem":239},"\u002Fmodules\u002Fidentity\u002Foauth-server\u002Froutes-and-clients","3.modules\u002F1.identity\u002F6.oauth-server\u002F4.routes-and-clients",{"title":241,"path":242,"stem":243},"OAuth Resource","\u002Fmodules\u002Fidentity\u002Foauth-resource","3.modules\u002F1.identity\u002F8.oauth-resource",{"title":245,"icon":49,"path":246,"stem":247,"children":248,"page":49},"Commerce","\u002Fmodules\u002Fcommerce","3.modules\u002F2.commerce",[249,253,257],{"title":250,"path":251,"stem":252},"Stripe","\u002Fmodules\u002Fcommerce\u002Fstripe","3.modules\u002F2.commerce\u002F1.stripe",{"title":254,"path":255,"stem":256},"Payments","\u002Fmodules\u002Fcommerce\u002Fpayments","3.modules\u002F2.commerce\u002F2.payments",{"title":258,"path":259,"stem":260,"children":261},"Subscriptions","\u002Fmodules\u002Fcommerce\u002Fsubscriptions","3.modules\u002F2.commerce\u002F3.subscriptions\u002Findex",[262,263,266,270],{"title":173,"path":259,"stem":260},{"title":175,"path":264,"stem":265},"\u002Fmodules\u002Fcommerce\u002Fsubscriptions\u002Fserver","3.modules\u002F2.commerce\u002F3.subscriptions\u002F2.server",{"title":267,"path":268,"stem":269},"App","\u002Fmodules\u002Fcommerce\u002Fsubscriptions\u002Fapp","3.modules\u002F2.commerce\u002F3.subscriptions\u002F3.app",{"title":179,"path":271,"stem":272},"\u002Fmodules\u002Fcommerce\u002Fsubscriptions\u002Freference","3.modules\u002F2.commerce\u002F3.subscriptions\u002F4.reference",{"title":274,"icon":49,"path":275,"stem":276,"children":277,"page":49},"Features","\u002Fmodules\u002Ffeatures","3.modules\u002F3.features",[278,293,312,316],{"title":279,"path":280,"stem":281,"children":282},"Events","\u002Fmodules\u002Ffeatures\u002Fevents","3.modules\u002F3.features\u002F1.events\u002Findex",[283,284,287,290],{"title":173,"path":280,"stem":281},{"title":175,"path":285,"stem":286},"\u002Fmodules\u002Ffeatures\u002Fevents\u002Fserver","3.modules\u002F3.features\u002F1.events\u002F2.server",{"title":267,"path":288,"stem":289},"\u002Fmodules\u002Ffeatures\u002Fevents\u002Fapp","3.modules\u002F3.features\u002F1.events\u002F3.app",{"title":179,"path":291,"stem":292},"\u002Fmodules\u002Ffeatures\u002Fevents\u002Freference","3.modules\u002F3.features\u002F1.events\u002F4.reference",{"title":294,"path":295,"stem":296,"children":297},"Forms","\u002Fmodules\u002Ffeatures\u002Fforms","3.modules\u002F3.features\u002F2.forms\u002Findex",[298,299,303,306,309],{"title":173,"path":295,"stem":296},{"title":300,"path":301,"stem":302},"Definition","\u002Fmodules\u002Ffeatures\u002Fforms\u002Fdefinition","3.modules\u002F3.features\u002F2.forms\u002F2.definition",{"title":175,"path":304,"stem":305},"\u002Fmodules\u002Ffeatures\u002Fforms\u002Fserver","3.modules\u002F3.features\u002F2.forms\u002F3.server",{"title":267,"path":307,"stem":308},"\u002Fmodules\u002Ffeatures\u002Fforms\u002Fapp","3.modules\u002F3.features\u002F2.forms\u002F4.app",{"title":179,"path":310,"stem":311},"\u002Fmodules\u002Ffeatures\u002Fforms\u002Freference","3.modules\u002F3.features\u002F2.forms\u002F5.reference",{"title":313,"path":314,"stem":315},"Cookie Consent","\u002Fmodules\u002Ffeatures\u002Fcookie-consent","3.modules\u002F3.features\u002F3.cookie-consent",{"title":317,"path":318,"stem":319},"MCP","\u002Fmodules\u002Ffeatures\u002Fmcp","3.modules\u002F3.features\u002F4.mcp",{"title":321,"icon":49,"path":322,"stem":323,"children":324,"page":49},"Interface","\u002Fmodules\u002Finterface","3.modules\u002F4.interface",[325,350,353,357,361],{"title":326,"path":327,"stem":328,"children":329},"UI","\u002Fmodules\u002Finterface\u002Fui","3.modules\u002F4.interface\u002F1.ui\u002Findex",[330,331,335,339,343,347],{"title":173,"path":327,"stem":328},{"title":332,"path":333,"stem":334},"Page components","\u002Fmodules\u002Finterface\u002Fui\u002Fpage-components","3.modules\u002F4.interface\u002F1.ui\u002F2.page-components",{"title":336,"path":337,"stem":338},"App shell","\u002Fmodules\u002Finterface\u002Fui\u002Fapp-shell","3.modules\u002F4.interface\u002F1.ui\u002F3.app-shell",{"title":340,"path":341,"stem":342},"Form inputs","\u002Fmodules\u002Finterface\u002Fui\u002Fform-inputs","3.modules\u002F4.interface\u002F1.ui\u002F4.form-inputs",{"title":344,"path":345,"stem":346},"Composables and helpers","\u002Fmodules\u002Finterface\u002Fui\u002Fcomposables","3.modules\u002F4.interface\u002F1.ui\u002F5.composables",{"title":179,"path":348,"stem":349},"\u002Fmodules\u002Finterface\u002Fui\u002Freference","3.modules\u002F4.interface\u002F1.ui\u002F6.reference",{"title":217,"path":351,"stem":352},"\u002Fmodules\u002Finterface\u002Fadmin","3.modules\u002F4.interface\u002F2.admin",{"title":354,"path":355,"stem":356},"Menu","\u002Fmodules\u002Finterface\u002Fmenu","3.modules\u002F4.interface\u002F3.menu",{"title":358,"path":359,"stem":360},"Widget","\u002Fmodules\u002Finterface\u002Fwidget","3.modules\u002F4.interface\u002F4.widget",{"title":362,"path":363,"stem":364,"children":365},"Mobile","\u002Fmodules\u002Finterface\u002Fmobile","3.modules\u002F4.interface\u002F5.mobile\u002Findex",[366,367,371],{"title":173,"path":363,"stem":364},{"title":368,"path":369,"stem":370},"CLI and devices","\u002Fmodules\u002Finterface\u002Fmobile\u002Fcli-and-devices","3.modules\u002F4.interface\u002F5.mobile\u002F2.cli-and-devices",{"title":372,"path":373,"stem":374},"Splash screen","\u002Fmodules\u002Finterface\u002Fmobile\u002Fsplash-screen","3.modules\u002F4.interface\u002F5.mobile\u002F3.splash-screen",{"title":376,"icon":49,"path":377,"stem":378,"children":379,"page":49},"Platform","\u002Fmodules\u002Fplatform","3.modules\u002F5.platform",[380,402,406,423],{"title":381,"path":382,"stem":383,"children":384},"Module Kit","\u002Fmodules\u002Fplatform\u002Fmodule-kit","3.modules\u002F5.platform\u002F1.module-kit\u002Findex",[385,386,390,394,398],{"title":173,"path":382,"stem":383},{"title":387,"path":388,"stem":389},"Server toolkit","\u002Fmodules\u002Fplatform\u002Fmodule-kit\u002Fserver-toolkit","3.modules\u002F5.platform\u002F1.module-kit\u002F2.server-toolkit",{"title":391,"path":392,"stem":393},"Registries and menus","\u002Fmodules\u002Fplatform\u002Fmodule-kit\u002Fregistries-and-menus","3.modules\u002F5.platform\u002F1.module-kit\u002F3.registries-and-menus",{"title":395,"path":396,"stem":397},"Translations","\u002Fmodules\u002Fplatform\u002Fmodule-kit\u002Fi18n","3.modules\u002F5.platform\u002F1.module-kit\u002F4.i18n",{"title":399,"path":400,"stem":401},"Database helpers","\u002Fmodules\u002Fplatform\u002Fmodule-kit\u002Fdatabase","3.modules\u002F5.platform\u002F1.module-kit\u002F5.database",{"title":403,"path":404,"stem":405},"Notify","\u002Fmodules\u002Fplatform\u002Fnotify","3.modules\u002F5.platform\u002F2.notify",{"title":407,"path":408,"stem":409,"children":410},"Email Templates","\u002Fmodules\u002Fplatform\u002Femail-templates","3.modules\u002F5.platform\u002F3.email-templates\u002Findex",[411,412,416,419],{"title":173,"path":408,"stem":409},{"title":413,"path":414,"stem":415},"Email components","\u002Fmodules\u002Fplatform\u002Femail-templates\u002Fcomponents","3.modules\u002F5.platform\u002F3.email-templates\u002F2.components",{"title":175,"path":417,"stem":418},"\u002Fmodules\u002Fplatform\u002Femail-templates\u002Fserver","3.modules\u002F5.platform\u002F3.email-templates\u002F3.server",{"title":420,"path":421,"stem":422},"Module emails","\u002Fmodules\u002Fplatform\u002Femail-templates\u002Fmodule-emails","3.modules\u002F5.platform\u002F3.email-templates\u002F4.module-emails",{"title":424,"path":425,"stem":426,"children":427},"Base Layer","\u002Fmodules\u002Fplatform\u002Fbase-layer","3.modules\u002F5.platform\u002F4.base-layer\u002Findex",[428,429,433,437],{"title":173,"path":425,"stem":426},{"title":430,"path":431,"stem":432},"Content collections","\u002Fmodules\u002Fplatform\u002Fbase-layer\u002Fcontent-collections","3.modules\u002F5.platform\u002F4.base-layer\u002F2.content-collections",{"title":434,"path":435,"stem":436},"Layouts and routing","\u002Fmodules\u002Fplatform\u002Fbase-layer\u002Flayouts-and-routing","3.modules\u002F5.platform\u002F4.base-layer\u002F3.layouts-and-routing",{"title":438,"path":439,"stem":440},"Composables and utils","\u002Fmodules\u002Fplatform\u002Fbase-layer\u002Fcomposables-and-utils","3.modules\u002F5.platform\u002F4.base-layer\u002F4.composables-and-utils",{"title":442,"icon":443,"path":444,"stem":445,"children":446,"page":49},"Examples","i-lucide-code-xml","\u002Fexamples","4.examples",[447,466,476],{"title":448,"icon":49,"path":449,"stem":450,"children":451,"page":49},"Starters","\u002Fexamples\u002Fstarters","4.examples\u002F1.starters",[452,456,461],{"title":453,"path":454,"stem":455,"icon":6},"Workspace starter","\u002Fexamples\u002Fstarters\u002Fworkspace","4.examples\u002F1.starters\u002F1.workspace",{"title":457,"path":458,"stem":459,"icon":460},"Mobile starter","\u002Fexamples\u002Fstarters\u002Fmobile","4.examples\u002F1.starters\u002F2.mobile","i-lucide-smartphone",{"title":462,"path":463,"stem":464,"icon":465},"Standalone mobile starter","\u002Fexamples\u002Fstarters\u002Fmobile-standalone","4.examples\u002F1.starters\u002F3.mobile-standalone","i-lucide-tablet-smartphone",{"title":467,"icon":49,"path":468,"stem":469,"children":470,"page":49},"Apps","\u002Fexamples\u002Fapps","4.examples\u002F2.apps",[471],{"title":472,"path":473,"stem":474,"icon":475},"Frigear website app","\u002Fexamples\u002Fapps\u002Ffrigear-nu-website","4.examples\u002F2.apps\u002F1.frigear-nu-website","i-lucide-layout-dashboard",{"title":477,"icon":49,"path":478,"stem":479,"children":480,"page":49},"Tasks","\u002Fexamples\u002Ftasks","4.examples\u002F3.tasks",[481,485,489,494,499],{"title":482,"path":483,"stem":484,"icon":70},"Protect a route","\u002Fexamples\u002Ftasks\u002Fprotect-a-route","4.examples\u002F3.tasks\u002F1.protect-a-route",{"title":486,"path":487,"stem":488,"icon":475},"Add an admin page","\u002Fexamples\u002Ftasks\u002Fadd-an-admin-page","4.examples\u002F3.tasks\u002F2.add-an-admin-page",{"title":490,"path":491,"stem":492,"icon":493},"Sell event tickets","\u002Fexamples\u002Ftasks\u002Fsell-event-tickets","4.examples\u002F3.tasks\u002F3.sell-event-tickets","i-lucide-ticket",{"title":495,"path":496,"stem":497,"icon":498},"Build a form","\u002Fexamples\u002Ftasks\u002Fbuild-a-form","4.examples\u002F3.tasks\u002F4.build-a-form","i-lucide-clipboard-list",{"title":500,"path":501,"stem":502,"icon":503},"Send an email","\u002Fexamples\u002Ftasks\u002Fsend-an-email","4.examples\u002F3.tasks\u002F5.send-an-email","i-lucide-mail",{"title":505,"icon":506,"path":507,"stem":508,"children":509,"page":49},"Contribute","i-lucide-git-pull-request","\u002Fcontribute","5.contribute",[510,513,518,544,549,552,556,571],{"title":173,"path":511,"stem":512,"icon":506},"\u002Fcontribute\u002Foverview","5.contribute\u002F1.overview",{"title":514,"path":515,"stem":516,"icon":517},"Local development","\u002Fcontribute\u002Flocal-development","5.contribute\u002F2.local-development","i-lucide-terminal",{"title":519,"icon":49,"path":520,"stem":521,"children":522,"page":49},"Writing a module","\u002Fcontribute\u002Fwriting-a-module","5.contribute\u002F3.writing-a-module",[523,527,532,536,541],{"title":524,"path":525,"stem":526,"icon":39},"Scaffold a module","\u002Fcontribute\u002Fwriting-a-module\u002Fscaffold","5.contribute\u002F3.writing-a-module\u002F1.scaffold",{"title":528,"path":529,"stem":530,"icon":531},"Setup checklist","\u002Fcontribute\u002Fwriting-a-module\u002Fsetup-checklist","5.contribute\u002F3.writing-a-module\u002F2.setup-checklist","i-lucide-list-checks",{"title":533,"path":534,"stem":535,"icon":44},"Database tables","\u002Fcontribute\u002Fwriting-a-module\u002Fdatabase-tables","5.contribute\u002F3.writing-a-module\u002F3.database-tables",{"title":537,"path":538,"stem":539,"icon":540},"Testing","\u002Fcontribute\u002Fwriting-a-module\u002Ftesting","5.contribute\u002F3.writing-a-module\u002F4.testing","i-lucide-flask-conical",{"title":67,"path":542,"stem":543,"icon":70},"\u002Fcontribute\u002Fwriting-a-module\u002Faccess-control","5.contribute\u002F3.writing-a-module\u002F5.access-control",{"title":545,"path":546,"stem":547,"icon":548},"Publishing","\u002Fcontribute\u002Fpublishing","5.contribute\u002F4.publishing","i-lucide-package-check",{"title":448,"path":550,"stem":551,"icon":6},"\u002Fcontribute\u002Fstarters","5.contribute\u002F5.starters",{"title":553,"path":554,"stem":555,"icon":52},"Documentation","\u002Fcontribute\u002Fdocumentation","5.contribute\u002F6.documentation",{"title":557,"icon":49,"path":558,"stem":559,"children":560,"page":49},"Tooling","\u002Fcontribute\u002Ftooling","5.contribute\u002F7.tooling",[561,566],{"title":562,"path":563,"stem":564,"icon":565},"CLI","\u002Fcontribute\u002Ftooling\u002Fcli","5.contribute\u002F7.tooling\u002F1.cli","i-lucide-square-terminal",{"title":567,"path":568,"stem":569,"icon":570},"ESLint config","\u002Fcontribute\u002Ftooling\u002Feslint-config","5.contribute\u002F7.tooling\u002F2.eslint-config","i-lucide-spell-check",{"title":572,"icon":49,"path":573,"stem":574,"children":575},"Decisions","\u002Fcontribute\u002Fdecisions","5.contribute\u002F8.decisions\u002Findex",[576,578,583],{"title":572,"path":573,"stem":574,"icon":577},"i-lucide-scale",{"title":579,"path":580,"stem":581,"icon":582},"Session lifetimes per OAuth client","\u002Fcontribute\u002Fdecisions\u002Foauth-token-lifetimes","5.contribute\u002F8.decisions\u002F1.oauth-token-lifetimes","i-lucide-timer",{"title":584,"path":585,"stem":586,"icon":70},"One permission model","\u002Fcontribute\u002Fdecisions\u002Fpermission-model","5.contribute\u002F8.decisions\u002F2.permission-model",{"id":588,"title":258,"body":589,"description":2245,"extension":2246,"links":2247,"meta":2248,"navigation":2249,"path":259,"seo":2250,"stem":260,"__hash__":2251},"docs\u002F3.modules\u002F2.commerce\u002F3.subscriptions\u002Findex.md",{"type":590,"value":591,"toc":2229},"minimark",[592,600,621,626,693,697,749,753,1431,1454,1458,1464,1720,1734,1755,1770,1780,1784,1793,1796,1801,1852,1901,2145,2152,2156,2208,2212,2225],[593,594,595,596,599],"p",{},"Subscriptions lets your app sell recurring plans, such as a yearly membership, through Stripe. You declare the plans in\nconfig. The module handles checkout, upgrades, downgrades and the Stripe billing portal. Your code then asks one\nquestion: does this user hold plan X? For a one-time charge, use ",[597,598,254],"a",{"href":255},".",[593,601,602,603,607,608,611,612,615,616,620],{},"The package is ",[604,605,606],"code",{},"@frigear-nu\u002Fsubscriptions",". Stripe owns the products and prices. A plan is not a role: access follows\nwhat the user pays for, and \"membership\" is only the name the pages use. To give a ",[597,609,610],{"href":206},"role","\nto paying users only, put the ",[604,613,614],{},"subscription"," requirement on it (see ",[597,617,619],{"href":618},"#permissions","Permissions",").",[622,623,625],"h2",{"id":624},"what-you-get","What you get",[627,628,629,640,656,673],"ul",{},[630,631,632,635,636,639],"li",{},[633,634,101],"strong",{}," (opt-in): a membership page at ",[604,637,638],{},"\u002Faccount\u002Fmembership",", and a success and a cancel page after checkout.",[630,641,642,645,646,648,649,651,652,655],{},[633,643,644],{},"Admin area"," (with ",[597,647,217],{"href":351}," and ",[597,650,358],{"href":359},"): a Membership tab\nwhere ",[597,653,654],{"href":87},"staff"," grant a free membership or send a payment link.",[630,657,658,661,662,665,666,668,669,672],{},[633,659,660],{},"Server routes"," (on by default): plans with live prices, the user's subscription, checkout and the billing portal.\nStaff routes need ",[604,663,664],{},"users:read"," from ",[597,667,191],{"href":192},", and ",[604,670,671],{},"subscriptions:manage"," to change anything.",[630,674,675,677,678,681,682,685,686,688,689,692],{},[633,676,344],{}," (on by default): ",[604,679,680],{},"useSubscription()",", ",[604,683,684],{},"usePlans()"," and a ",[604,687,614],{}," route middleware\nin the app, and ",[604,690,691],{},"hasActiveSubscription"," on the server.",[694,695],"module-runtime",{":client":696,":server":696},"true",[698,699,700,721,734],"note",{},[593,701,702,705,706,681,709,711,712,681,714,681,716,718,719,599],{},[633,703,704],{},"Installed for you:"," ",[604,707,708],{},"@frigear-nu\u002Fmodule-kit",[597,710,168],{"href":169},", Users,\n",[597,713,250],{"href":251},[597,715,403],{"href":404},[597,717,317],{"href":318}," and\n",[597,720,326],{"href":327},[593,722,723,705,726,729,730,733],{},[633,724,725],{},"You add:",[604,727,728],{},"@nuxthub\u002Fcore"," with key-value storage (KV) on, and ",[604,731,732],{},"@nuxt\u002Fui"," for the pages and components.",[593,735,736,705,739,741,742,744,745,748],{},[633,737,738],{},"Optional:",[597,740,354],{"href":355}," for the account menu item, Admin and Widget for the admin tab and card,\nPayments to store invoices as payments, ",[597,743,407],{"href":408}," for the payment link\nemail, and ",[604,746,747],{},"@nuxtjs\u002Fi18n"," for translated labels.",[622,750,752],{"id":751},"quick-setup","Quick setup",[754,755,756,761,792,796,1174,1182,1186,1192,1200,1204,1215,1227,1231,1234],"steps",{},[757,758,760],"h3",{"id":759},"install-subscriptions","Install Subscriptions",[762,763,768],"pre",{"className":764,"code":765,"language":766,"meta":767,"style":767},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","pnpm add @frigear-nu\u002Fsubscriptions @nuxthub\u002Fcore @nuxt\u002Fui\n","bash","",[604,769,770],{"__ignoreMap":767},[771,772,775,779,783,786,789],"span",{"class":773,"line":774},"line",1,[771,776,778],{"class":777},"sBMFI","pnpm",[771,780,782],{"class":781},"sfazB"," add",[771,784,785],{"class":781}," @frigear-nu\u002Fsubscriptions",[771,787,788],{"class":781}," @nuxthub\u002Fcore",[771,790,791],{"class":781}," @nuxt\u002Fui\n",[757,793,795],{"id":794},"declare-your-plans-in-nuxtconfigts","Declare your plans in nuxt.config.ts",[762,797,802],{"className":798,"code":799,"filename":800,"language":801,"meta":767,"style":767},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","export default defineNuxtConfig({\n  modules: [\n    '@nuxthub\u002Fcore',\n    '@nuxt\u002Fui',\n    '@frigear-nu\u002Fmenu', \u002F\u002F optional\n    '@frigear-nu\u002Fsubscriptions', \u002F\u002F installs Users and Stripe for you\n  ],\n  hub: { db: { dialect: 'sqlite', driver: 'libsql' }, kv: true },\n  subscriptions: {\n    plans: {\n      member: { label: 'Member', rank: 1, prices: [{ lookupKey: 'member_yearly' }] },\n      patron: { label: 'Patron', rank: 2, prices: [{ lookupKey: 'patron_yearly' }] },\n    },\n    settings: { pages: { membership: true, success: true, cancel: true } },\n  },\n})\n","nuxt.config.ts","ts",[604,803,804,825,838,852,863,880,894,902,962,973,983,1050,1107,1113,1159,1165],{"__ignoreMap":767},[771,805,806,810,813,817,821],{"class":773,"line":774},[771,807,809],{"class":808},"s7zQu","export",[771,811,812],{"class":808}," default",[771,814,816],{"class":815},"s2Zo4"," defineNuxtConfig",[771,818,820],{"class":819},"sTEyZ","(",[771,822,824],{"class":823},"sMK4o","{\n",[771,826,828,832,835],{"class":773,"line":827},2,[771,829,831],{"class":830},"swJcz","  modules",[771,833,834],{"class":823},":",[771,836,837],{"class":819}," [\n",[771,839,841,844,846,849],{"class":773,"line":840},3,[771,842,843],{"class":823},"    '",[771,845,728],{"class":781},[771,847,848],{"class":823},"'",[771,850,851],{"class":823},",\n",[771,853,855,857,859,861],{"class":773,"line":854},4,[771,856,843],{"class":823},[771,858,732],{"class":781},[771,860,848],{"class":823},[771,862,851],{"class":823},[771,864,866,868,871,873,876],{"class":773,"line":865},5,[771,867,843],{"class":823},[771,869,870],{"class":781},"@frigear-nu\u002Fmenu",[771,872,848],{"class":823},[771,874,875],{"class":823},",",[771,877,879],{"class":878},"sHwdD"," \u002F\u002F optional\n",[771,881,883,885,887,889,891],{"class":773,"line":882},6,[771,884,843],{"class":823},[771,886,606],{"class":781},[771,888,848],{"class":823},[771,890,875],{"class":823},[771,892,893],{"class":878}," \u002F\u002F installs Users and Stripe for you\n",[771,895,897,900],{"class":773,"line":896},7,[771,898,899],{"class":819},"  ]",[771,901,851],{"class":823},[771,903,905,908,910,913,916,918,920,923,925,928,931,933,935,938,940,942,945,947,950,953,955,959],{"class":773,"line":904},8,[771,906,907],{"class":830},"  hub",[771,909,834],{"class":823},[771,911,912],{"class":823}," {",[771,914,915],{"class":830}," db",[771,917,834],{"class":823},[771,919,912],{"class":823},[771,921,922],{"class":830}," dialect",[771,924,834],{"class":823},[771,926,927],{"class":823}," '",[771,929,930],{"class":781},"sqlite",[771,932,848],{"class":823},[771,934,875],{"class":823},[771,936,937],{"class":830}," driver",[771,939,834],{"class":823},[771,941,927],{"class":823},[771,943,944],{"class":781},"libsql",[771,946,848],{"class":823},[771,948,949],{"class":823}," },",[771,951,952],{"class":830}," kv",[771,954,834],{"class":823},[771,956,958],{"class":957},"sfNiH"," true",[771,960,961],{"class":823}," },\n",[771,963,965,968,970],{"class":773,"line":964},9,[771,966,967],{"class":830},"  subscriptions",[771,969,834],{"class":823},[771,971,972],{"class":823}," {\n",[771,974,976,979,981],{"class":773,"line":975},10,[771,977,978],{"class":830},"    plans",[771,980,834],{"class":823},[771,982,972],{"class":823},[771,984,986,989,991,993,996,998,1000,1003,1005,1007,1010,1012,1016,1018,1021,1023,1026,1029,1032,1034,1036,1039,1041,1044,1047],{"class":773,"line":985},11,[771,987,988],{"class":830},"      member",[771,990,834],{"class":823},[771,992,912],{"class":823},[771,994,995],{"class":830}," label",[771,997,834],{"class":823},[771,999,927],{"class":823},[771,1001,1002],{"class":781},"Member",[771,1004,848],{"class":823},[771,1006,875],{"class":823},[771,1008,1009],{"class":830}," rank",[771,1011,834],{"class":823},[771,1013,1015],{"class":1014},"sbssI"," 1",[771,1017,875],{"class":823},[771,1019,1020],{"class":830}," prices",[771,1022,834],{"class":823},[771,1024,1025],{"class":819}," [",[771,1027,1028],{"class":823},"{",[771,1030,1031],{"class":830}," lookupKey",[771,1033,834],{"class":823},[771,1035,927],{"class":823},[771,1037,1038],{"class":781},"member_yearly",[771,1040,848],{"class":823},[771,1042,1043],{"class":823}," }",[771,1045,1046],{"class":819},"] ",[771,1048,1049],{"class":823},"},\n",[771,1051,1053,1056,1058,1060,1062,1064,1066,1069,1071,1073,1075,1077,1080,1082,1084,1086,1088,1090,1092,1094,1096,1099,1101,1103,1105],{"class":773,"line":1052},12,[771,1054,1055],{"class":830},"      patron",[771,1057,834],{"class":823},[771,1059,912],{"class":823},[771,1061,995],{"class":830},[771,1063,834],{"class":823},[771,1065,927],{"class":823},[771,1067,1068],{"class":781},"Patron",[771,1070,848],{"class":823},[771,1072,875],{"class":823},[771,1074,1009],{"class":830},[771,1076,834],{"class":823},[771,1078,1079],{"class":1014}," 2",[771,1081,875],{"class":823},[771,1083,1020],{"class":830},[771,1085,834],{"class":823},[771,1087,1025],{"class":819},[771,1089,1028],{"class":823},[771,1091,1031],{"class":830},[771,1093,834],{"class":823},[771,1095,927],{"class":823},[771,1097,1098],{"class":781},"patron_yearly",[771,1100,848],{"class":823},[771,1102,1043],{"class":823},[771,1104,1046],{"class":819},[771,1106,1049],{"class":823},[771,1108,1110],{"class":773,"line":1109},13,[771,1111,1112],{"class":823},"    },\n",[771,1114,1116,1119,1121,1123,1126,1128,1130,1133,1135,1137,1139,1142,1144,1146,1148,1151,1153,1155,1157],{"class":773,"line":1115},14,[771,1117,1118],{"class":830},"    settings",[771,1120,834],{"class":823},[771,1122,912],{"class":823},[771,1124,1125],{"class":830}," pages",[771,1127,834],{"class":823},[771,1129,912],{"class":823},[771,1131,1132],{"class":830}," membership",[771,1134,834],{"class":823},[771,1136,958],{"class":957},[771,1138,875],{"class":823},[771,1140,1141],{"class":830}," success",[771,1143,834],{"class":823},[771,1145,958],{"class":957},[771,1147,875],{"class":823},[771,1149,1150],{"class":830}," cancel",[771,1152,834],{"class":823},[771,1154,958],{"class":957},[771,1156,1043],{"class":823},[771,1158,961],{"class":823},[771,1160,1162],{"class":773,"line":1161},15,[771,1163,1164],{"class":823},"  },\n",[771,1166,1168,1171],{"class":773,"line":1167},16,[771,1169,1170],{"class":823},"}",[771,1172,1173],{"class":819},")\n",[1175,1176,1177,1178,1181],"caution",{},"Use test keys (",[604,1179,1180],{},"sk_test_...",") until the whole flow works: live keys charge real cards.",[757,1183,1185],{"id":1184},"connect-your-stripe-account","Connect your Stripe account",[593,1187,1188,1189,1191],{},"Follow ",[597,1190,146],{"href":147}," for the keys, the webhook events, recurring prices with these\nlookup keys and the billing portal.",[1193,1194,1195,1196,1199],"warning",{},"Without a ",[597,1197,1198],{"href":87},"migration",", webhooks and checkouts fail.",[757,1201,1203],{"id":1202},"generate-the-migration","Generate the migration",[593,1205,1206,1207,1210,1211,1214],{},"Generate one migration for the ",[604,1208,1209],{},"subscriptions"," table and Stripe's ",[604,1212,1213],{},"users"," column, and commit it:",[762,1216,1218],{"className":764,"code":1217,"language":766,"meta":767,"style":767},"pnpm db:generate\n",[604,1219,1220],{"__ignoreMap":767},[771,1221,1222,1224],{"class":773,"line":774},[771,1223,778],{"class":777},[771,1225,1226],{"class":781}," db:generate\n",[757,1228,1230],{"id":1229},"check-the-plan-in-your-code","Check the plan in your code",[593,1232,1233],{},"Let only members call a route:",[762,1235,1238],{"className":798,"code":1236,"filename":1237,"language":801,"meta":767,"style":767},"import { forbidden } from '@frigear-nu\u002Fmodule-kit\u002Fserver'\n\nexport default defineEventHandler(async (event) => {\n  const user = await requireUser(event)\n  if (!await hasActiveSubscription(user.id, { plans: ['member', 'patron'] })) {\n    throw forbidden('Members only.')\n  }\n  return { perks: [] }\n})\n","server\u002Fapi\u002Fperks.get.ts",[604,1239,1240,1263,1269,1299,1322,1384,1402,1407,1425],{"__ignoreMap":767},[771,1241,1242,1245,1247,1250,1252,1255,1257,1260],{"class":773,"line":774},[771,1243,1244],{"class":808},"import",[771,1246,912],{"class":823},[771,1248,1249],{"class":819}," forbidden",[771,1251,1043],{"class":823},[771,1253,1254],{"class":808}," from",[771,1256,927],{"class":823},[771,1258,1259],{"class":781},"@frigear-nu\u002Fmodule-kit\u002Fserver",[771,1261,1262],{"class":823},"'\n",[771,1264,1265],{"class":773,"line":827},[771,1266,1268],{"emptyLinePlaceholder":1267},true,"\n",[771,1270,1271,1273,1275,1278,1280,1284,1287,1291,1294,1297],{"class":773,"line":840},[771,1272,809],{"class":808},[771,1274,812],{"class":808},[771,1276,1277],{"class":815}," defineEventHandler",[771,1279,820],{"class":819},[771,1281,1283],{"class":1282},"spNyl","async",[771,1285,1286],{"class":823}," (",[771,1288,1290],{"class":1289},"sHdIc","event",[771,1292,1293],{"class":823},")",[771,1295,1296],{"class":1282}," =>",[771,1298,972],{"class":823},[771,1300,1301,1304,1307,1310,1313,1316,1318,1320],{"class":773,"line":854},[771,1302,1303],{"class":1282},"  const",[771,1305,1306],{"class":819}," user",[771,1308,1309],{"class":823}," =",[771,1311,1312],{"class":808}," await",[771,1314,1315],{"class":815}," requireUser",[771,1317,820],{"class":830},[771,1319,1290],{"class":819},[771,1321,1173],{"class":830},[771,1323,1324,1327,1329,1332,1335,1338,1340,1343,1345,1348,1350,1352,1355,1357,1359,1361,1364,1366,1368,1370,1373,1375,1377,1379,1382],{"class":773,"line":865},[771,1325,1326],{"class":808},"  if",[771,1328,1286],{"class":830},[771,1330,1331],{"class":823},"!",[771,1333,1334],{"class":808},"await",[771,1336,1337],{"class":815}," hasActiveSubscription",[771,1339,820],{"class":830},[771,1341,1342],{"class":819},"user",[771,1344,599],{"class":823},[771,1346,1347],{"class":819},"id",[771,1349,875],{"class":823},[771,1351,912],{"class":823},[771,1353,1354],{"class":830}," plans",[771,1356,834],{"class":823},[771,1358,1025],{"class":830},[771,1360,848],{"class":823},[771,1362,1363],{"class":781},"member",[771,1365,848],{"class":823},[771,1367,875],{"class":823},[771,1369,927],{"class":823},[771,1371,1372],{"class":781},"patron",[771,1374,848],{"class":823},[771,1376,1046],{"class":830},[771,1378,1170],{"class":823},[771,1380,1381],{"class":830},")) ",[771,1383,824],{"class":823},[771,1385,1386,1389,1391,1393,1395,1398,1400],{"class":773,"line":882},[771,1387,1388],{"class":808},"    throw",[771,1390,1249],{"class":815},[771,1392,820],{"class":830},[771,1394,848],{"class":823},[771,1396,1397],{"class":781},"Members only.",[771,1399,848],{"class":823},[771,1401,1173],{"class":830},[771,1403,1404],{"class":773,"line":896},[771,1405,1406],{"class":823},"  }\n",[771,1408,1409,1412,1414,1417,1419,1422],{"class":773,"line":904},[771,1410,1411],{"class":808},"  return",[771,1413,912],{"class":823},[771,1415,1416],{"class":830}," perks",[771,1418,834],{"class":823},[771,1420,1421],{"class":830}," [] ",[771,1423,1424],{"class":823},"}\n",[771,1426,1427,1429],{"class":773,"line":964},[771,1428,1170],{"class":823},[771,1430,1173],{"class":819},[1432,1433,1436,1439,1440,1442,1443,681,1446,1449,1450,1453],"callout",{"color":1434,"icon":1435},"success","i-lucide-check",[633,1437,1438],{},"What you should see:"," signed in, ",[604,1441,638],{}," lists both plans. After subscribing with Stripe's test card\n",[604,1444,1445],{},"4242 4242 4242 4242",[604,1447,1448],{},"GET \u002Fapi\u002Fsubscriptions\u002Fme"," returns ",[604,1451,1452],{},"activePlan: 'member'"," once the webhook has arrived.",[622,1455,1457],{"id":1456},"options","Options",[593,1459,1460,1461,1463],{},"Options go under the ",[604,1462,1209],{}," key.",[1465,1466,1467,1486],"table",{},[1468,1469,1470],"thead",{},[1471,1472,1473,1477,1480,1483],"tr",{},[1474,1475,1476],"th",{},"Option",[1474,1478,1479],{},"Type",[1474,1481,1482],{},"Default",[1474,1484,1485],{},"Purpose",[1487,1488,1489,1510,1528,1545,1563,1579,1596,1613,1636,1656,1676,1696],"tbody",{},[1471,1490,1491,1497,1502,1507],{},[1492,1493,1494],"td",{},[604,1495,1496],{},"plans",[1492,1498,1499],{},[604,1500,1501],{},"Record\u003Cstring, PlanConfig>",[1492,1503,1504],{},[604,1505,1506],{},"{}",[1492,1508,1509],{},"Plans by plan key. Empty means any active subscription counts.",[1471,1511,1512,1517,1522,1525],{},[1492,1513,1514],{},[604,1515,1516],{},"plans.\u003Ckey>.prices",[1492,1518,1519],{},[604,1520,1521],{},"Array\u003Cstring | { lookupKey }>",[1492,1523,1524],{},"–",[1492,1526,1527],{},"Required. Stripe price ids or lookup keys, such as monthly and yearly.",[1471,1529,1530,1535,1540,1542],{},[1492,1531,1532],{},[604,1533,1534],{},"plans.\u003Ckey>.rank",[1492,1536,1537],{},[604,1538,1539],{},"number",[1492,1541,1524],{},[1492,1543,1544],{},"Required. A higher rank is a higher tier, which decides upgrade or downgrade.",[1471,1546,1547,1552,1557,1560],{},[1492,1548,1549],{},[604,1550,1551],{},"plans.\u003Ckey>.label",[1492,1553,1554],{},[604,1555,1556],{},"string",[1492,1558,1559],{},"the key",[1492,1561,1562],{},"The display label.",[1471,1564,1565,1570,1574,1576],{},[1492,1566,1567],{},[604,1568,1569],{},"plans.\u003Ckey>.description",[1492,1571,1572],{},[604,1573,1556],{},[1492,1575,1524],{},[1492,1577,1578],{},"The plan description.",[1471,1580,1581,1586,1591,1593],{},[1492,1582,1583],{},[604,1584,1585],{},"plans.\u003Ckey>.features",[1492,1587,1588],{},[604,1589,1590],{},"string[]",[1492,1592,1524],{},[1492,1594,1595],{},"Bullet points on the plan card.",[1471,1597,1598,1603,1608,1610],{},[1492,1599,1600],{},[604,1601,1602],{},"plans.\u003Ckey>.availability.disabledRanges",[1492,1604,1605],{},[604,1606,1607],{},"{ from, to }[]",[1492,1609,1524],{},[1492,1611,1612],{},"Date windows in which new subscribers cannot see or buy the plan.",[1471,1614,1615,1620,1625,1628],{},[1492,1616,1617],{},[604,1618,1619],{},"settings.pages.membership",[1492,1621,1622],{},[604,1623,1624],{},"string | boolean",[1492,1626,1627],{},"off",[1492,1629,1630,1632,1633,1635],{},[604,1631,696],{}," is ",[604,1634,638],{},". A string is a custom path.",[1471,1637,1638,1643,1647,1649],{},[1492,1639,1640],{},[604,1641,1642],{},"settings.pages.success",[1492,1644,1645],{},[604,1646,1624],{},[1492,1648,1627],{},[1492,1650,1651,1632,1653,599],{},[604,1652,696],{},[604,1654,1655],{},"\u002Faccount\u002Fmembership\u002Fsuccess",[1471,1657,1658,1663,1667,1669],{},[1492,1659,1660],{},[604,1661,1662],{},"settings.pages.cancel",[1492,1664,1665],{},[604,1666,1624],{},[1492,1668,1627],{},[1492,1670,1671,1632,1673,599],{},[604,1672,696],{},[604,1674,1675],{},"\u002Faccount\u002Fmembership\u002Fcancel",[1471,1677,1678,1683,1688,1693],{},[1492,1679,1680],{},[604,1681,1682],{},"settings.allowChangeInPortal",[1492,1684,1685],{},[604,1686,1687],{},"boolean",[1492,1689,1690],{},[604,1691,1692],{},"false",[1492,1694,1695],{},"Tells the interface that plans change in the billing portal. Not enforced.",[1471,1697,1698,1703,1707,1711],{},[1492,1699,1700],{},[604,1701,1702],{},"settings.mcp",[1492,1704,1705],{},[604,1706,1687],{},[1492,1708,1709],{},[604,1710,1692],{},[1492,1712,1713,1714,705,1717,1719],{},"Adds the ",[604,1715,1716],{},"my-subscriptions",[597,1718,317],{"href":318}," tool.",[593,1721,1722,1726,1727,1730,1731,599],{},[633,1723,1724],{},[604,1725,1496],{}," left empty makes checkout require a ",[604,1728,1729],{},"priceId",". It then accepts any active recurring Stripe price, and stored\nrows get ",[604,1732,1733],{},"planKey = null",[593,1735,1736,681,1740,648,1745,1750,1751,1754],{},[633,1737,1738],{},[604,1739,1551],{},[633,1741,1742],{},[604,1743,1744],{},"description",[633,1746,1747],{},[604,1748,1749],{},"features"," give way to ",[604,1752,1753],{},"subscriptions.catalog.\u003Ckey>.*"," i18n keys.",[593,1756,1757,1761,1762,1765,1766,1769],{},[633,1758,1759],{},[604,1760,1602],{}," dates are inclusive. ",[604,1763,1764],{},"{fullYear}"," becomes the current year, as in\n",[604,1767,1768],{},"{fullYear}-06-01",". Subscribers still see the plan.",[593,1771,1772,1777,1778,599],{},[633,1773,1774],{},[604,1775,1776],{},"settings.pages.*"," need ",[604,1779,732],{},[757,1781,1783],{"id":1782},"runtime-config","Runtime config",[593,1785,1786,1789,1790,599],{},[604,1787,1788],{},"public.subscriptions"," exposes the page paths, the plans without prices and ",[604,1791,1792],{},"allowChangeInPortal",[622,1794,619],{"id":1795},"permissions",[593,1797,1798,1799,599],{},"The module registers these permissions with ",[597,1800,199],{"href":200},[1465,1802,1803,1819],{},[1468,1804,1805],{},[1471,1806,1807,1810,1813,1816],{},[1474,1808,1809],{},"Permission",[1474,1811,1812],{},"Flags",[1474,1814,1815],{},"Held by default",[1474,1817,1818],{},"What it allows",[1487,1820,1821,1837],{},[1471,1822,1823,1828,1831,1834],{},[1492,1824,1825],{},[604,1826,1827],{},"subscriptions:read",[1492,1829,1830],{},"implicit",[1492,1832,1833],{},"every signed-in user",[1492,1835,1836],{},"Read your own subscriptions and the plans.",[1471,1838,1839,1843,1846,1849],{},[1492,1840,1841],{},[604,1842,671],{},[1492,1844,1845],{},"sessionOnly",[1492,1847,1848],{},"nobody",[1492,1850,1851],{},"Grant and revoke free memberships, and send payment links.",[627,1853,1854,1867,1876,1892],{},[630,1855,1856,1862,1863,1866],{},[633,1857,1858,1859,1861],{},"Nobody holds ",[604,1860,671],{}," by default."," Granting a free membership gives away paid access, so you grant it\nby name to the roles that may. ",[604,1864,1865],{},"*"," does not cover it for a token, because it is session only.",[630,1868,1869,1872,1873,1875],{},[633,1870,1871],{},"Staff reads"," of a user's membership use ",[604,1874,664],{},", like the rest of the admin user page.",[630,1877,1878,1881,1882,705,1884,1887,1888,1891],{},[633,1879,1880],{},"Requirement:"," the module registers the ",[604,1883,614],{},[597,1885,1886],{"href":206},"role requirement",".\nA role with ",[604,1889,1890],{},"requirements: { subscription: '*' }"," counts only while the user holds an active or trialing subscription\non any plan (free grants count). Use a plan key, or a list of keys, to name plans.",[630,1893,1894,1897,1898,1900],{},[633,1895,1896],{},"Scope and policies:"," the module registers no named scope, role or policy. A token can carry the\n",[604,1899,1827],{}," permission directly.",[762,1902,1904],{"className":798,"code":1903,"filename":800,"language":801,"meta":767,"style":767},"export default defineNuxtConfig({\n  authorization: {\n    defaultRoles: ['user'],\n    roles: {\n      member: {\n        label: 'Member',\n        grant: ['member-area:view'],\n        requirements: { subscription: ['member', 'patron'] }, \u002F\u002F plan keys, or '*' for any plan\n        auto: true, \u002F\u002F held by everyone who meets the requirement; not assignable by hand\n        inherit: ['user'],\n      },\n      coordinator: { label: 'Coordinator', grant: ['subscriptions:manage', 'users:read', 'users:list'] },\n    },\n  },\n})\n",[604,1905,1906,1918,1927,1947,1956,1964,1979,1999,2037,2051,2070,2075,2131,2135,2139],{"__ignoreMap":767},[771,1907,1908,1910,1912,1914,1916],{"class":773,"line":774},[771,1909,809],{"class":808},[771,1911,812],{"class":808},[771,1913,816],{"class":815},[771,1915,820],{"class":819},[771,1917,824],{"class":823},[771,1919,1920,1923,1925],{"class":773,"line":827},[771,1921,1922],{"class":830},"  authorization",[771,1924,834],{"class":823},[771,1926,972],{"class":823},[771,1928,1929,1932,1934,1936,1938,1940,1942,1945],{"class":773,"line":840},[771,1930,1931],{"class":830},"    defaultRoles",[771,1933,834],{"class":823},[771,1935,1025],{"class":819},[771,1937,848],{"class":823},[771,1939,1342],{"class":781},[771,1941,848],{"class":823},[771,1943,1944],{"class":819},"]",[771,1946,851],{"class":823},[771,1948,1949,1952,1954],{"class":773,"line":854},[771,1950,1951],{"class":830},"    roles",[771,1953,834],{"class":823},[771,1955,972],{"class":823},[771,1957,1958,1960,1962],{"class":773,"line":865},[771,1959,988],{"class":830},[771,1961,834],{"class":823},[771,1963,972],{"class":823},[771,1965,1966,1969,1971,1973,1975,1977],{"class":773,"line":882},[771,1967,1968],{"class":830},"        label",[771,1970,834],{"class":823},[771,1972,927],{"class":823},[771,1974,1002],{"class":781},[771,1976,848],{"class":823},[771,1978,851],{"class":823},[771,1980,1981,1984,1986,1988,1990,1993,1995,1997],{"class":773,"line":896},[771,1982,1983],{"class":830},"        grant",[771,1985,834],{"class":823},[771,1987,1025],{"class":819},[771,1989,848],{"class":823},[771,1991,1992],{"class":781},"member-area:view",[771,1994,848],{"class":823},[771,1996,1944],{"class":819},[771,1998,851],{"class":823},[771,2000,2001,2004,2006,2008,2011,2013,2015,2017,2019,2021,2023,2025,2027,2029,2031,2034],{"class":773,"line":904},[771,2002,2003],{"class":830},"        requirements",[771,2005,834],{"class":823},[771,2007,912],{"class":823},[771,2009,2010],{"class":830}," subscription",[771,2012,834],{"class":823},[771,2014,1025],{"class":819},[771,2016,848],{"class":823},[771,2018,1363],{"class":781},[771,2020,848],{"class":823},[771,2022,875],{"class":823},[771,2024,927],{"class":823},[771,2026,1372],{"class":781},[771,2028,848],{"class":823},[771,2030,1046],{"class":819},[771,2032,2033],{"class":823},"},",[771,2035,2036],{"class":878}," \u002F\u002F plan keys, or '*' for any plan\n",[771,2038,2039,2042,2044,2046,2048],{"class":773,"line":964},[771,2040,2041],{"class":830},"        auto",[771,2043,834],{"class":823},[771,2045,958],{"class":957},[771,2047,875],{"class":823},[771,2049,2050],{"class":878}," \u002F\u002F held by everyone who meets the requirement; not assignable by hand\n",[771,2052,2053,2056,2058,2060,2062,2064,2066,2068],{"class":773,"line":975},[771,2054,2055],{"class":830},"        inherit",[771,2057,834],{"class":823},[771,2059,1025],{"class":819},[771,2061,848],{"class":823},[771,2063,1342],{"class":781},[771,2065,848],{"class":823},[771,2067,1944],{"class":819},[771,2069,851],{"class":823},[771,2071,2072],{"class":773,"line":985},[771,2073,2074],{"class":823},"      },\n",[771,2076,2077,2080,2082,2084,2086,2088,2090,2093,2095,2097,2100,2102,2104,2106,2108,2110,2112,2114,2116,2118,2120,2122,2125,2127,2129],{"class":773,"line":1052},[771,2078,2079],{"class":830},"      coordinator",[771,2081,834],{"class":823},[771,2083,912],{"class":823},[771,2085,995],{"class":830},[771,2087,834],{"class":823},[771,2089,927],{"class":823},[771,2091,2092],{"class":781},"Coordinator",[771,2094,848],{"class":823},[771,2096,875],{"class":823},[771,2098,2099],{"class":830}," grant",[771,2101,834],{"class":823},[771,2103,1025],{"class":819},[771,2105,848],{"class":823},[771,2107,671],{"class":781},[771,2109,848],{"class":823},[771,2111,875],{"class":823},[771,2113,927],{"class":823},[771,2115,664],{"class":781},[771,2117,848],{"class":823},[771,2119,875],{"class":823},[771,2121,927],{"class":823},[771,2123,2124],{"class":781},"users:list",[771,2126,848],{"class":823},[771,2128,1046],{"class":819},[771,2130,1049],{"class":823},[771,2132,2133],{"class":773,"line":1109},[771,2134,1112],{"class":823},[771,2136,2137],{"class":773,"line":1115},[771,2138,1164],{"class":823},[771,2140,2141,2143],{"class":773,"line":1161},[771,2142,1170],{"class":823},[771,2144,1173],{"class":819},[698,2146,2147,2148,2151],{},"A role with ",[604,2149,2150],{},"auto: true"," cannot be assigned or removed by hand, and it drops away as soon as the requirement stops\nholding, for example when a subscription ends.",[622,2153,2155],{"id":2154},"module-pages","Module pages",[1465,2157,2158,2171],{},[1468,2159,2160],{},[1471,2161,2162,2165,2168],{},[1474,2163,2164],{},"Page",[1474,2166,2167],{},"What it covers",[1474,2169,2170],{},"For",[1487,2172,2173,2185,2197],{},[1471,2174,2175,2179,2182],{},[1492,2176,2177],{},[597,2178,175],{"href":264},[1492,2180,2181],{},"Checking plans, webhooks, checkout rules and staff membership.",[1492,2183,2184],{},"App developers and module authors",[1471,2186,2187,2191,2194],{},[1492,2188,2189],{},[597,2190,267],{"href":268},[1492,2192,2193],{},"Composables, the route middleware, components and the membership pages.",[1492,2195,2196],{},"App developers",[1471,2198,2199,2203,2206],{},[1492,2200,2201],{},[597,2202,179],{"href":271},[1492,2204,2205],{},"Hooks, routes and DTOs, the database and translations.",[1492,2207,2196],{},[622,2209,2211],{"id":2210},"next-steps","Next steps",[627,2213,2214,2219],{},[630,2215,2216,2218],{},[597,2217,146],{"href":147}," – create the prices and the billing portal your plans use.",[630,2220,2221,2224],{},[597,2222,2223],{"href":268},"Subscriptions app"," – build your own pricing page with the composables.",[2226,2227,2228],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .sfNiH, html code.shiki .sfNiH{--shiki-light:#FF5370;--shiki-default:#FF9CAC;--shiki-dark:#FF9CAC}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sHdIc, html code.shiki .sHdIc{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#EEFFFF;--shiki-default-font-style:italic;--shiki-dark:#BABED8;--shiki-dark-font-style:italic}",{"title":767,"searchDepth":827,"depth":827,"links":2230},[2231,2232,2239,2242,2243,2244],{"id":624,"depth":827,"text":625},{"id":751,"depth":827,"text":752,"children":2233},[2234,2235,2236,2237,2238],{"id":759,"depth":840,"text":760},{"id":794,"depth":840,"text":795},{"id":1184,"depth":840,"text":1185},{"id":1202,"depth":840,"text":1203},{"id":1229,"depth":840,"text":1230},{"id":1456,"depth":827,"text":1457,"children":2240},[2241],{"id":1782,"depth":840,"text":1783},{"id":1795,"depth":827,"text":619},{"id":2154,"depth":827,"text":2155},{"id":2210,"depth":827,"text":2211},"Sell recurring plans, such as a yearly membership, through Stripe, and check which plan a user holds.","md",null,{},{"title":173},{"title":258,"description":2245},"Z9TxkZ4EY0d_8lFJeD5F8Ac_B6GrOTvoI1K8s_OhLFc",[2253,2255],{"title":254,"path":255,"stem":256,"description":2254,"children":-1},"Charge a signed-in user once through Stripe Checkout, and hear through a hook when the money arrives.",{"title":175,"path":264,"stem":265,"description":2256,"children":-1},"Check which plan a user holds, and how webhooks, checkout and staff grants change subscriptions.",1794503149404]