[{"data":1,"prerenderedAt":2543},["ShallowReactive",2],{"navigation_docs":3,"-modules-commerce-subscriptions-reference":587,"-modules-commerce-subscriptions-reference-surround":2538},[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":589,"body":590,"description":2531,"extension":2532,"links":2533,"meta":2534,"navigation":2535,"path":271,"seo":2536,"stem":272,"__hash__":2537},"docs\u002F3.modules\u002F2.commerce\u002F3.subscriptions\u002F4.reference.md","Subscriptions reference",{"type":591,"value":592,"toc":2524},"minimark",[593,601,605,613,687,1111,1149,1152,1371,1375,1378,1622,1688,2069,2072,2080,2094,2265,2270,2273,2279,2300,2501,2505,2520],[594,595,596,597,600],"p",{},"This page lists the hooks, routes, table and translation keys of Subscriptions. It is for app developers, in server\nmode. Set up the module first: ",[598,599,173],"a",{"href":259},".",[602,603,234],"h2",{"id":604},"hooks",[594,606,607,608,612],{},"Your app answers these Nitro hooks from a server plugin (",[609,610,611],"code",{},"server\u002Fplugins\u002F*.ts",").",[614,615,616,632],"table",{},[617,618,619],"thead",{},[620,621,622,626,629],"tr",{},[623,624,625],"th",{},"Hook",[623,627,628],{},"When",[623,630,631],{},"Payload",[633,634,635,654,672],"tbody",{},[620,636,637,643,649],{},[638,639,640],"td",{},[609,641,642],{},"subscriptions:checkout:before",[638,644,645,646,600],{},"Before a new checkout or a plan change, after validation. Throw to deny. Not run for ",[609,647,648],{},"resume",[638,650,651],{},[609,652,653],{},"CheckoutBeforeContext",[620,655,656,661,667],{},[638,657,658],{},[609,659,660],{},"subscriptions:plans:filter",[638,662,663,664,600],{},"Whenever plans are listed or checked, so it also gates checkout. Change ",[609,665,666],{},"ctx.plans",[638,668,669],{},[609,670,671],{},"PlansFilterContext",[620,673,674,679,682],{},[638,675,676],{},[609,677,678],{},"subscriptions:invoice",[638,680,681],{},"A subscription invoice was paid, failed or voided. Fired only with Payments installed.",[638,683,684],{},[609,685,686],{},"{ invoice: InvoicePaymentEvent }",[688,689,694],"pre",{"className":690,"code":691,"language":692,"meta":693,"style":693},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","type CheckoutBeforeContext = {\n  event: H3Event\n  userId: number\n  planKey: string | null\n  priceId: string\n  kind: 'checkout' | 'upgrade' | 'downgrade'\n  params: Stripe.Checkout.SessionCreateParams   \u002F\u002F only used when kind === 'checkout'\n}\n\ntype PlansFilterContext = {\n  event: H3Event | undefined   \u002F\u002F undefined outside a request\n  plans: ResolvedPlan[]        \u002F\u002F a copy of the cached plans\n}\n\ntype ResolvedPlan = { key: string, label: string, description?: string, rank: number, features?: string[], prices: PlanPrice[] }\ntype PlanPrice = {\n  id: string\n  amount: number | null           \u002F\u002F minor units\n  currency: string\n  interval: 'day' | 'week' | 'month' | 'year'\n  intervalCount: number\n  trialPeriodDays: number | null\n  lookupKey: string | null\n}\n","ts","",[609,695,696,716,729,740,757,768,805,830,836,843,855,873,891,896,901,977,988,998,1016,1026,1068,1078,1092,1106],{"__ignoreMap":693},[697,698,701,705,709,713],"span",{"class":699,"line":700},"line",1,[697,702,704],{"class":703},"spNyl","type",[697,706,708],{"class":707},"sBMFI"," CheckoutBeforeContext",[697,710,712],{"class":711},"sMK4o"," =",[697,714,715],{"class":711}," {\n",[697,717,719,723,726],{"class":699,"line":718},2,[697,720,722],{"class":721},"swJcz","  event",[697,724,725],{"class":711},":",[697,727,728],{"class":707}," H3Event\n",[697,730,732,735,737],{"class":699,"line":731},3,[697,733,734],{"class":721},"  userId",[697,736,725],{"class":711},[697,738,739],{"class":707}," number\n",[697,741,743,746,748,751,754],{"class":699,"line":742},4,[697,744,745],{"class":721},"  planKey",[697,747,725],{"class":711},[697,749,750],{"class":707}," string",[697,752,753],{"class":711}," |",[697,755,756],{"class":707}," null\n",[697,758,760,763,765],{"class":699,"line":759},5,[697,761,762],{"class":721},"  priceId",[697,764,725],{"class":711},[697,766,767],{"class":707}," string\n",[697,769,771,774,776,779,783,786,788,790,793,795,797,799,802],{"class":699,"line":770},6,[697,772,773],{"class":721},"  kind",[697,775,725],{"class":711},[697,777,778],{"class":711}," '",[697,780,782],{"class":781},"sfazB","checkout",[697,784,785],{"class":711},"'",[697,787,753],{"class":711},[697,789,778],{"class":711},[697,791,792],{"class":781},"upgrade",[697,794,785],{"class":711},[697,796,753],{"class":711},[697,798,778],{"class":711},[697,800,801],{"class":781},"downgrade",[697,803,804],{"class":711},"'\n",[697,806,808,811,813,816,818,821,823,826],{"class":699,"line":807},7,[697,809,810],{"class":721},"  params",[697,812,725],{"class":711},[697,814,815],{"class":707}," Stripe",[697,817,600],{"class":711},[697,819,820],{"class":707},"Checkout",[697,822,600],{"class":711},[697,824,825],{"class":707},"SessionCreateParams",[697,827,829],{"class":828},"sHwdD","   \u002F\u002F only used when kind === 'checkout'\n",[697,831,833],{"class":699,"line":832},8,[697,834,835],{"class":711},"}\n",[697,837,839],{"class":699,"line":838},9,[697,840,842],{"emptyLinePlaceholder":841},true,"\n",[697,844,846,848,851,853],{"class":699,"line":845},10,[697,847,704],{"class":703},[697,849,850],{"class":707}," PlansFilterContext",[697,852,712],{"class":711},[697,854,715],{"class":711},[697,856,858,860,862,865,867,870],{"class":699,"line":857},11,[697,859,722],{"class":721},[697,861,725],{"class":711},[697,863,864],{"class":707}," H3Event",[697,866,753],{"class":711},[697,868,869],{"class":707}," undefined",[697,871,872],{"class":828},"   \u002F\u002F undefined outside a request\n",[697,874,876,879,881,884,888],{"class":699,"line":875},12,[697,877,878],{"class":721},"  plans",[697,880,725],{"class":711},[697,882,883],{"class":707}," ResolvedPlan",[697,885,887],{"class":886},"sTEyZ","[]        ",[697,889,890],{"class":828},"\u002F\u002F a copy of the cached plans\n",[697,892,894],{"class":699,"line":893},13,[697,895,835],{"class":711},[697,897,899],{"class":699,"line":898},14,[697,900,842],{"emptyLinePlaceholder":841},[697,902,904,906,908,910,913,916,918,920,923,926,928,930,932,935,938,940,942,945,947,950,952,955,957,959,962,964,967,969,972,975],{"class":699,"line":903},15,[697,905,704],{"class":703},[697,907,883],{"class":707},[697,909,712],{"class":711},[697,911,912],{"class":711}," {",[697,914,915],{"class":721}," key",[697,917,725],{"class":711},[697,919,750],{"class":707},[697,921,922],{"class":711},",",[697,924,925],{"class":721}," label",[697,927,725],{"class":711},[697,929,750],{"class":707},[697,931,922],{"class":711},[697,933,934],{"class":721}," description",[697,936,937],{"class":711},"?:",[697,939,750],{"class":707},[697,941,922],{"class":711},[697,943,944],{"class":721}," rank",[697,946,725],{"class":711},[697,948,949],{"class":707}," number",[697,951,922],{"class":711},[697,953,954],{"class":721}," features",[697,956,937],{"class":711},[697,958,750],{"class":707},[697,960,961],{"class":886},"[]",[697,963,922],{"class":711},[697,965,966],{"class":721}," prices",[697,968,725],{"class":711},[697,970,971],{"class":707}," PlanPrice",[697,973,974],{"class":886},"[] ",[697,976,835],{"class":711},[697,978,980,982,984,986],{"class":699,"line":979},16,[697,981,704],{"class":703},[697,983,971],{"class":707},[697,985,712],{"class":711},[697,987,715],{"class":711},[697,989,991,994,996],{"class":699,"line":990},17,[697,992,993],{"class":721},"  id",[697,995,725],{"class":711},[697,997,767],{"class":707},[697,999,1001,1004,1006,1008,1010,1013],{"class":699,"line":1000},18,[697,1002,1003],{"class":721},"  amount",[697,1005,725],{"class":711},[697,1007,949],{"class":707},[697,1009,753],{"class":711},[697,1011,1012],{"class":707}," null",[697,1014,1015],{"class":828},"           \u002F\u002F minor units\n",[697,1017,1019,1022,1024],{"class":699,"line":1018},19,[697,1020,1021],{"class":721},"  currency",[697,1023,725],{"class":711},[697,1025,767],{"class":707},[697,1027,1029,1032,1034,1036,1039,1041,1043,1045,1048,1050,1052,1054,1057,1059,1061,1063,1066],{"class":699,"line":1028},20,[697,1030,1031],{"class":721},"  interval",[697,1033,725],{"class":711},[697,1035,778],{"class":711},[697,1037,1038],{"class":781},"day",[697,1040,785],{"class":711},[697,1042,753],{"class":711},[697,1044,778],{"class":711},[697,1046,1047],{"class":781},"week",[697,1049,785],{"class":711},[697,1051,753],{"class":711},[697,1053,778],{"class":711},[697,1055,1056],{"class":781},"month",[697,1058,785],{"class":711},[697,1060,753],{"class":711},[697,1062,778],{"class":711},[697,1064,1065],{"class":781},"year",[697,1067,804],{"class":711},[697,1069,1071,1074,1076],{"class":699,"line":1070},21,[697,1072,1073],{"class":721},"  intervalCount",[697,1075,725],{"class":711},[697,1077,739],{"class":707},[697,1079,1081,1084,1086,1088,1090],{"class":699,"line":1080},22,[697,1082,1083],{"class":721},"  trialPeriodDays",[697,1085,725],{"class":711},[697,1087,949],{"class":707},[697,1089,753],{"class":711},[697,1091,756],{"class":707},[697,1093,1095,1098,1100,1102,1104],{"class":699,"line":1094},23,[697,1096,1097],{"class":721},"  lookupKey",[697,1099,725],{"class":711},[697,1101,750],{"class":707},[697,1103,753],{"class":711},[697,1105,756],{"class":707},[697,1107,1109],{"class":699,"line":1108},24,[697,1110,835],{"class":711},[594,1112,1113,1114,1117,1118,1121,1122,1125,1126,1129,1130,1133,1134,1137,1138,1125,1141,1144,1145,1148],{},"The default ",[609,1115,1116],{},"params"," hold ",[609,1119,1120],{},"mode: 'subscription'",", the line item, ",[609,1123,1124],{},"success_url",", ",[609,1127,1128],{},"cancel_url",",\n",[609,1131,1132],{},"client_reference_id"," (the user id) and ",[609,1135,1136],{},"subscription_data.metadata"," (",[609,1139,1140],{},"userId",[609,1142,1143],{},"planKey","). The Stripe ",[609,1146,1147],{},"customer"," is\nadded after the hook.",[594,1150,1151],{},"This plugin closes sign-up out of season:",[688,1153,1156],{"className":690,"code":1154,"filename":1155,"language":692,"meta":693,"style":693},"export default defineNitroPlugin((nitro) => {\n  nitro.hooks.hook('subscriptions:checkout:before', (ctx) => {\n    if (!isSignupSeason(new Date())) throw createError({ statusCode: 403, statusMessage: 'Sign-up is closed' })\n    if (ctx.kind === 'checkout') ctx.params.metadata = { ...ctx.params.metadata, source: 'website' }\n  })\n})\n","server\u002Fplugins\u002Fsubscriptions.ts",[609,1157,1158,1188,1223,1287,1357,1364],{"__ignoreMap":693},[697,1159,1160,1164,1167,1171,1174,1176,1180,1183,1186],{"class":699,"line":700},[697,1161,1163],{"class":1162},"s7zQu","export",[697,1165,1166],{"class":1162}," default",[697,1168,1170],{"class":1169},"s2Zo4"," defineNitroPlugin",[697,1172,1173],{"class":886},"(",[697,1175,1173],{"class":711},[697,1177,1179],{"class":1178},"sHdIc","nitro",[697,1181,1182],{"class":711},")",[697,1184,1185],{"class":703}," =>",[697,1187,715],{"class":711},[697,1189,1190,1193,1195,1197,1199,1202,1204,1206,1208,1210,1212,1214,1217,1219,1221],{"class":699,"line":718},[697,1191,1192],{"class":886},"  nitro",[697,1194,600],{"class":711},[697,1196,604],{"class":886},[697,1198,600],{"class":711},[697,1200,1201],{"class":1169},"hook",[697,1203,1173],{"class":721},[697,1205,785],{"class":711},[697,1207,642],{"class":781},[697,1209,785],{"class":711},[697,1211,922],{"class":711},[697,1213,1137],{"class":711},[697,1215,1216],{"class":1178},"ctx",[697,1218,1182],{"class":711},[697,1220,1185],{"class":703},[697,1222,715],{"class":711},[697,1224,1225,1228,1230,1233,1236,1238,1241,1244,1247,1250,1253,1255,1258,1261,1263,1267,1269,1272,1274,1276,1279,1281,1284],{"class":699,"line":731},[697,1226,1227],{"class":1162},"    if",[697,1229,1137],{"class":721},[697,1231,1232],{"class":711},"!",[697,1234,1235],{"class":1169},"isSignupSeason",[697,1237,1173],{"class":721},[697,1239,1240],{"class":711},"new",[697,1242,1243],{"class":1169}," Date",[697,1245,1246],{"class":721},"())) ",[697,1248,1249],{"class":1162},"throw",[697,1251,1252],{"class":1169}," createError",[697,1254,1173],{"class":721},[697,1256,1257],{"class":711},"{",[697,1259,1260],{"class":721}," statusCode",[697,1262,725],{"class":711},[697,1264,1266],{"class":1265},"sbssI"," 403",[697,1268,922],{"class":711},[697,1270,1271],{"class":721}," statusMessage",[697,1273,725],{"class":711},[697,1275,778],{"class":711},[697,1277,1278],{"class":781},"Sign-up is closed",[697,1280,785],{"class":711},[697,1282,1283],{"class":711}," }",[697,1285,1286],{"class":721},")\n",[697,1288,1289,1291,1293,1295,1297,1300,1303,1305,1307,1309,1312,1314,1316,1318,1320,1323,1325,1327,1330,1332,1334,1336,1338,1340,1342,1345,1347,1349,1352,1354],{"class":699,"line":742},[697,1290,1227],{"class":1162},[697,1292,1137],{"class":721},[697,1294,1216],{"class":886},[697,1296,600],{"class":711},[697,1298,1299],{"class":886},"kind",[697,1301,1302],{"class":711}," ===",[697,1304,778],{"class":711},[697,1306,782],{"class":781},[697,1308,785],{"class":711},[697,1310,1311],{"class":721},") ",[697,1313,1216],{"class":886},[697,1315,600],{"class":711},[697,1317,1116],{"class":886},[697,1319,600],{"class":711},[697,1321,1322],{"class":886},"metadata",[697,1324,712],{"class":711},[697,1326,912],{"class":711},[697,1328,1329],{"class":711}," ...",[697,1331,1216],{"class":886},[697,1333,600],{"class":711},[697,1335,1116],{"class":886},[697,1337,600],{"class":711},[697,1339,1322],{"class":886},[697,1341,922],{"class":711},[697,1343,1344],{"class":721}," source",[697,1346,725],{"class":711},[697,1348,778],{"class":711},[697,1350,1351],{"class":781},"website",[697,1353,785],{"class":711},[697,1355,1356],{"class":711}," }\n",[697,1358,1359,1362],{"class":699,"line":759},[697,1360,1361],{"class":711},"  }",[697,1363,1286],{"class":721},[697,1365,1366,1369],{"class":699,"line":770},[697,1367,1368],{"class":711},"}",[697,1370,1286],{"class":886},[602,1372,1374],{"id":1373},"routes","Routes",[594,1376,1377],{},"Routes the module registers, and who may call them.",[614,1379,1380,1398],{},[617,1381,1382],{},[620,1383,1384,1387,1390,1392,1395],{},[623,1385,1386],{},"Method",[623,1388,1389],{},"Path",[623,1391,168],{},[623,1393,1394],{},"Status",[623,1396,1397],{},"Purpose",[633,1399,1400,1428,1455,1478,1503,1524,1546,1574,1599],{},[620,1401,1402,1407,1412,1415,1418],{},[638,1403,1404],{},[609,1405,1406],{},"GET",[638,1408,1409],{},[609,1410,1411],{},"\u002Fapi\u002Fsubscriptions\u002Fplans",[638,1413,1414],{},"public",[638,1416,1417],{},"200",[638,1419,1420,1423,1424,1427],{},[609,1421,1422],{},"{ plans: ResolvedPlan[] }",", after the ",[609,1425,1426],{},"plans:filter"," hook.",[620,1429,1430,1434,1439,1444,1446],{},[638,1431,1432],{},[609,1433,1406],{},[638,1435,1436],{},[609,1437,1438],{},"\u002Fapi\u002Fsubscriptions\u002Fme",[638,1440,1441],{},[609,1442,1443],{},"subscriptions:read",[638,1445,1417],{},[638,1447,1448,1451,1452,600],{},[609,1449,1450],{},"MeResponse",": all subscriptions and ",[609,1453,1454],{},"activePlan",[620,1456,1457,1462,1467,1470,1472],{},[638,1458,1459],{},[609,1460,1461],{},"POST",[638,1463,1464],{},[609,1465,1466],{},"\u002Fapi\u002Fsubscriptions\u002Fme\u002Fcheckout",[638,1468,1469],{},"session only",[638,1471,1417],{},[638,1473,1474,1475,600],{},"A new checkout or a plan change. See ",[598,1476,820],{"href":1477},"\u002Fmodules\u002Fcommerce\u002Fsubscriptions\u002Fserver#checkout",[620,1479,1480,1484,1489,1491,1493],{},[638,1481,1482],{},[609,1483,1461],{},[638,1485,1486],{},[609,1487,1488],{},"\u002Fapi\u002Fsubscriptions\u002Fme\u002Fportal",[638,1490,1469],{},[638,1492,1417],{},[638,1494,1495,1498,1499,1502],{},[609,1496,1497],{},"{ url }"," of a billing portal session. Body ",[609,1500,1501],{},"{ returnUrl? }",", same origin.",[620,1504,1505,1509,1514,1519,1521],{},[638,1506,1507],{},[609,1508,1406],{},[638,1510,1511],{},[609,1512,1513],{},"\u002Fapi\u002Fadmin\u002Fusers\u002F:id\u002Fmembership",[638,1515,1516],{},[609,1517,1518],{},"users:read",[638,1520,1417],{},[638,1522,1523],{},"The current membership and the plans staff can grant.",[620,1525,1526,1530,1535,1539,1541],{},[638,1527,1528],{},[609,1529,1406],{},[638,1531,1532],{},[609,1533,1534],{},"\u002Fapi\u002Fadmin\u002Fusers\u002F:id\u002Fmembership\u002Fhistory",[638,1536,1537],{},[609,1538,1518],{},[638,1540,1417],{},[638,1542,1543,1544,600],{},"The full history, ended rows included, as ",[609,1545,1450],{},[620,1547,1548,1552,1556,1561,1564],{},[638,1549,1550],{},[609,1551,1461],{},[638,1553,1554],{},[609,1555,1513],{},[638,1557,1558],{},[609,1559,1560],{},"subscriptions:manage",[638,1562,1563],{},"201",[638,1565,1566,1567,1570,1571,600],{},"Grants a free membership. Body ",[609,1568,1569],{},"{ planKey, endsAt? }",". Answers a ",[609,1572,1573],{},"SubscriptionDto",[620,1575,1576,1581,1585,1589,1592],{},[638,1577,1578],{},[609,1579,1580],{},"DELETE",[638,1582,1583],{},[609,1584,1513],{},[638,1586,1587],{},[609,1588,1560],{},[638,1590,1591],{},"204",[638,1593,1594,1595,1598],{},"Revokes a free membership. ",[609,1596,1597],{},"404 not_found"," when there is none.",[620,1600,1601,1605,1610,1614,1616],{},[638,1602,1603],{},[609,1604,1461],{},[638,1606,1607],{},[609,1608,1609],{},"\u002Fapi\u002Fadmin\u002Fusers\u002F:id\u002Fmembership\u002Fpayment-link",[638,1611,1612],{},[609,1613,1560],{},[638,1615,1417],{},[638,1617,1618,1619,600],{},"Creates a checkout link, and emails it on request: ",[609,1620,1621],{},"{ url, emailed }",[1623,1624,1625,1637,1653,1663,1678],"ul",{},[1626,1627,1628,1629,1632,1633,1636],"li",{},"Checkout and the portal are billing, so they need a session. An ",[598,1630,1631],{"href":87},"API token"," or access\ntoken gets ",[609,1634,1635],{},"403 session_required",", whatever its scopes.",[1626,1638,1639,1640,1642,1643,1646,1647,1649,1650,1652],{},"A token with the ",[609,1641,1443],{}," permission can read ",[609,1644,1645],{},"me",". ",[609,1648,1560],{}," is session only, so a token\ngets ",[609,1651,1635],{}," on the staff change routes.",[1626,1654,1655,1656,1659,1660,600],{},"A ",[609,1657,1658],{},"returnUrl"," on another origin answers ",[609,1661,1662],{},"400 bad_request",[1626,1664,1665,1666,1669,1670,1673,1674,1677],{},"Granting answers ",[609,1667,1668],{},"400"," for an unknown plan or a past ",[609,1671,1672],{},"endsAt",", and ",[609,1675,1676],{},"409"," when the user has a paid subscription.",[1626,1679,1680,1681,1684,1685,600],{},"Path builders are ",[609,1682,1683],{},"subscriptionsApi"," from ",[609,1686,1687],{},"@frigear-nu\u002Fsubscriptions\u002Fapi",[688,1689,1691],{"className":690,"code":1690,"language":692,"meta":693,"style":693},"type SubscriptionDto = {\n  id: string\n  planKey: string | null\n  priceId: string\n  status: string                      \u002F\u002F raw Stripe status\n  cancelAtPeriodEnd: boolean\n  currentPeriodStart: string | null   \u002F\u002F ISO\n  currentPeriodEnd: string | null\n  endedAt: string | null\n  source?: 'stripe' | 'manual'        \u002F\u002F 'manual' for free memberships granted by staff\n}\n\ntype MeResponse = {\n  subscriptions: SubscriptionDto[]\n  activePlan: string | null           \u002F\u002F plan of the entitled subscription with the latest period end\n}\n\ntype AdminMembershipResponse = {      \u002F\u002F GET \u002Fapi\u002Fadmin\u002Fusers\u002F:id\u002Fmembership\n  plans: Array\u003C{ key: string, label: string, rank: number }>\n  current: {\n    id: string\n    planKey: string | null\n    status: string\n    source: 'stripe' | 'manual'\n    currentPeriodEnd: string | null\n    cancelAtPeriodEnd: boolean\n  } | null\n}\n\n\u002F\u002F POST ...\u002Fmembership\u002Fpayment-link takes { planKey?, priceId?, email? }\ntype AdminPaymentLinkResponse = { url: string, emailed: boolean }\n",[609,1692,1693,1704,1712,1724,1732,1744,1754,1770,1783,1796,1822,1826,1830,1841,1853,1869,1873,1877,1891,1928,1937,1946,1959,1968,1989,2003,2013,2022,2027,2032,2038],{"__ignoreMap":693},[697,1694,1695,1697,1700,1702],{"class":699,"line":700},[697,1696,704],{"class":703},[697,1698,1699],{"class":707}," SubscriptionDto",[697,1701,712],{"class":711},[697,1703,715],{"class":711},[697,1705,1706,1708,1710],{"class":699,"line":718},[697,1707,993],{"class":721},[697,1709,725],{"class":711},[697,1711,767],{"class":707},[697,1713,1714,1716,1718,1720,1722],{"class":699,"line":731},[697,1715,745],{"class":721},[697,1717,725],{"class":711},[697,1719,750],{"class":707},[697,1721,753],{"class":711},[697,1723,756],{"class":707},[697,1725,1726,1728,1730],{"class":699,"line":742},[697,1727,762],{"class":721},[697,1729,725],{"class":711},[697,1731,767],{"class":707},[697,1733,1734,1737,1739,1741],{"class":699,"line":759},[697,1735,1736],{"class":721},"  status",[697,1738,725],{"class":711},[697,1740,750],{"class":707},[697,1742,1743],{"class":828},"                      \u002F\u002F raw Stripe status\n",[697,1745,1746,1749,1751],{"class":699,"line":770},[697,1747,1748],{"class":721},"  cancelAtPeriodEnd",[697,1750,725],{"class":711},[697,1752,1753],{"class":707}," boolean\n",[697,1755,1756,1759,1761,1763,1765,1767],{"class":699,"line":807},[697,1757,1758],{"class":721},"  currentPeriodStart",[697,1760,725],{"class":711},[697,1762,750],{"class":707},[697,1764,753],{"class":711},[697,1766,1012],{"class":707},[697,1768,1769],{"class":828},"   \u002F\u002F ISO\n",[697,1771,1772,1775,1777,1779,1781],{"class":699,"line":832},[697,1773,1774],{"class":721},"  currentPeriodEnd",[697,1776,725],{"class":711},[697,1778,750],{"class":707},[697,1780,753],{"class":711},[697,1782,756],{"class":707},[697,1784,1785,1788,1790,1792,1794],{"class":699,"line":838},[697,1786,1787],{"class":721},"  endedAt",[697,1789,725],{"class":711},[697,1791,750],{"class":707},[697,1793,753],{"class":711},[697,1795,756],{"class":707},[697,1797,1798,1801,1803,1805,1808,1810,1812,1814,1817,1819],{"class":699,"line":845},[697,1799,1800],{"class":721},"  source",[697,1802,937],{"class":711},[697,1804,778],{"class":711},[697,1806,1807],{"class":781},"stripe",[697,1809,785],{"class":711},[697,1811,753],{"class":711},[697,1813,778],{"class":711},[697,1815,1816],{"class":781},"manual",[697,1818,785],{"class":711},[697,1820,1821],{"class":828},"        \u002F\u002F 'manual' for free memberships granted by staff\n",[697,1823,1824],{"class":699,"line":857},[697,1825,835],{"class":711},[697,1827,1828],{"class":699,"line":875},[697,1829,842],{"emptyLinePlaceholder":841},[697,1831,1832,1834,1837,1839],{"class":699,"line":893},[697,1833,704],{"class":703},[697,1835,1836],{"class":707}," MeResponse",[697,1838,712],{"class":711},[697,1840,715],{"class":711},[697,1842,1843,1846,1848,1850],{"class":699,"line":898},[697,1844,1845],{"class":721},"  subscriptions",[697,1847,725],{"class":711},[697,1849,1699],{"class":707},[697,1851,1852],{"class":886},"[]\n",[697,1854,1855,1858,1860,1862,1864,1866],{"class":699,"line":903},[697,1856,1857],{"class":721},"  activePlan",[697,1859,725],{"class":711},[697,1861,750],{"class":707},[697,1863,753],{"class":711},[697,1865,1012],{"class":707},[697,1867,1868],{"class":828},"           \u002F\u002F plan of the entitled subscription with the latest period end\n",[697,1870,1871],{"class":699,"line":979},[697,1872,835],{"class":711},[697,1874,1875],{"class":699,"line":990},[697,1876,842],{"emptyLinePlaceholder":841},[697,1878,1879,1881,1884,1886,1888],{"class":699,"line":1000},[697,1880,704],{"class":703},[697,1882,1883],{"class":707}," AdminMembershipResponse",[697,1885,712],{"class":711},[697,1887,912],{"class":711},[697,1889,1890],{"class":828},"      \u002F\u002F GET \u002Fapi\u002Fadmin\u002Fusers\u002F:id\u002Fmembership\n",[697,1892,1893,1895,1897,1900,1903,1905,1907,1909,1911,1913,1915,1917,1919,1921,1923,1925],{"class":699,"line":1018},[697,1894,878],{"class":721},[697,1896,725],{"class":711},[697,1898,1899],{"class":707}," Array",[697,1901,1902],{"class":711},"\u003C{",[697,1904,915],{"class":721},[697,1906,725],{"class":711},[697,1908,750],{"class":707},[697,1910,922],{"class":711},[697,1912,925],{"class":721},[697,1914,725],{"class":711},[697,1916,750],{"class":707},[697,1918,922],{"class":711},[697,1920,944],{"class":721},[697,1922,725],{"class":711},[697,1924,949],{"class":707},[697,1926,1927],{"class":711}," }>\n",[697,1929,1930,1933,1935],{"class":699,"line":1028},[697,1931,1932],{"class":721},"  current",[697,1934,725],{"class":711},[697,1936,715],{"class":711},[697,1938,1939,1942,1944],{"class":699,"line":1070},[697,1940,1941],{"class":721},"    id",[697,1943,725],{"class":711},[697,1945,767],{"class":707},[697,1947,1948,1951,1953,1955,1957],{"class":699,"line":1080},[697,1949,1950],{"class":721},"    planKey",[697,1952,725],{"class":711},[697,1954,750],{"class":707},[697,1956,753],{"class":711},[697,1958,756],{"class":707},[697,1960,1961,1964,1966],{"class":699,"line":1094},[697,1962,1963],{"class":721},"    status",[697,1965,725],{"class":711},[697,1967,767],{"class":707},[697,1969,1970,1973,1975,1977,1979,1981,1983,1985,1987],{"class":699,"line":1108},[697,1971,1972],{"class":721},"    source",[697,1974,725],{"class":711},[697,1976,778],{"class":711},[697,1978,1807],{"class":781},[697,1980,785],{"class":711},[697,1982,753],{"class":711},[697,1984,778],{"class":711},[697,1986,1816],{"class":781},[697,1988,804],{"class":711},[697,1990,1992,1995,1997,1999,2001],{"class":699,"line":1991},25,[697,1993,1994],{"class":721},"    currentPeriodEnd",[697,1996,725],{"class":711},[697,1998,750],{"class":707},[697,2000,753],{"class":711},[697,2002,756],{"class":707},[697,2004,2006,2009,2011],{"class":699,"line":2005},26,[697,2007,2008],{"class":721},"    cancelAtPeriodEnd",[697,2010,725],{"class":711},[697,2012,1753],{"class":707},[697,2014,2016,2018,2020],{"class":699,"line":2015},27,[697,2017,1361],{"class":711},[697,2019,753],{"class":711},[697,2021,756],{"class":707},[697,2023,2025],{"class":699,"line":2024},28,[697,2026,835],{"class":711},[697,2028,2030],{"class":699,"line":2029},29,[697,2031,842],{"emptyLinePlaceholder":841},[697,2033,2035],{"class":699,"line":2034},30,[697,2036,2037],{"class":828},"\u002F\u002F POST ...\u002Fmembership\u002Fpayment-link takes { planKey?, priceId?, email? }\n",[697,2039,2041,2043,2046,2048,2050,2053,2055,2057,2059,2062,2064,2067],{"class":699,"line":2040},31,[697,2042,704],{"class":703},[697,2044,2045],{"class":707}," AdminPaymentLinkResponse",[697,2047,712],{"class":711},[697,2049,912],{"class":711},[697,2051,2052],{"class":721}," url",[697,2054,725],{"class":711},[697,2056,750],{"class":707},[697,2058,922],{"class":711},[697,2060,2061],{"class":721}," emailed",[697,2063,725],{"class":711},[697,2065,2066],{"class":707}," boolean",[697,2068,1356],{"class":711},[602,2070,41],{"id":2071},"database",[594,2073,2074,2075,2079],{},"Tables the module adds. Generate and commit a ",[598,2076,2078],{"href":2077},"\u002Fget-started\u002Fdatabase#migrations","migration"," after installing.",[594,2081,2082,2083,2086,2087,2090,2091,600],{},"The module adds one ",[609,2084,2085],{},"subscriptions"," table. The same migration must also cover the ",[609,2088,2089],{},"users.stripe_customer_id"," column of\n",[598,2092,250],{"href":2093},"\u002Fmodules\u002Fcommerce\u002Fstripe#database",[614,2095,2096,2109],{},[617,2097,2098],{},[620,2099,2100,2103,2106],{},[623,2101,2102],{},"Column",[623,2104,2105],{},"Type",[623,2107,2108],{},"Notes",[633,2110,2111,2132,2147,2162,2175,2187,2199,2221,2237,2250],{},[620,2112,2113,2118,2121],{},[638,2114,2115],{},[609,2116,2117],{},"id",[638,2119,2120],{},"text, primary key",[638,2122,2123,2124,2127,2128,2131],{},"The Stripe subscription id (",[609,2125,2126],{},"sub_...","), or ",[609,2129,2130],{},"manual_\u003Cuuid>"," for a free membership.",[620,2133,2134,2138,2141],{},[638,2135,2136],{},[609,2137,1140],{},[638,2139,2140],{},"integer",[638,2142,2143,2144,600],{},"Indexed, no foreign key. The webhook finds it through ",[609,2145,2146],{},"users.stripeCustomerId",[620,2148,2149,2153,2156],{},[638,2150,2151],{},[609,2152,1143],{},[638,2154,2155],{},"text, nullable",[638,2157,2158,2161],{},[609,2159,2160],{},"null"," when the price is in no configured plan, so config changes lose no data.",[620,2163,2164,2169,2172],{},[638,2165,2166],{},[609,2167,2168],{},"priceId",[638,2170,2171],{},"text",[638,2173,2174],{},"Empty for a free membership.",[620,2176,2177,2182,2184],{},[638,2178,2179],{},[609,2180,2181],{},"status",[638,2183,2171],{},[638,2185,2186],{},"The raw Stripe status.",[620,2188,2189,2194,2197],{},[638,2190,2191],{},[609,2192,2193],{},"cancelAtPeriodEnd",[638,2195,2196],{},"boolean",[638,2198],{},[620,2200,2201,2212,2215],{},[638,2202,2203,1125,2206,1125,2209],{},[609,2204,2205],{},"currentPeriodStart",[609,2207,2208],{},"currentPeriodEnd",[609,2210,2211],{},"endedAt",[638,2213,2214],{},"timestamps, nullable",[638,2216,2217,2218,2220],{},"On a free membership, ",[609,2219,2208],{}," is its optional end date.",[620,2222,2223,2228,2230],{},[638,2224,2225],{},[609,2226,2227],{},"source",[638,2229,2171],{},[638,2231,2232,2234,2235,600],{},[609,2233,1807],{}," (default) or ",[609,2236,1816],{},[620,2238,2239,2244,2247],{},[638,2240,2241],{},[609,2242,2243],{},"rawItems",[638,2245,2246],{},"JSON, nullable",[638,2248,2249],{},"Item id, price id, lookup key and quantity.",[620,2251,2252,2260,2263],{},[638,2253,2254,1125,2257],{},[609,2255,2256],{},"createdAt",[609,2258,2259],{},"updatedAt",[638,2261,2262],{},"timestamps",[638,2264],{},[594,2266,2267,2268,600],{},"Rows are never deleted. An ended subscription gets ",[609,2269,2211],{},[602,2271,395],{"id":2272},"translations",[594,2274,2275,2276,600],{},"Override any string in your app's ",[609,2277,2278],{},"i18n\u002Flocales\u002F\u003Ccode>.json",[594,2280,2281,2282,2285,2286,2289,2290,2292,2293,2296,2297,600],{},"The module registers ",[609,2283,2284],{},"da"," and ",[609,2287,2288],{},"en"," files with ",[598,2291,381],{"href":396},". Components read them\nthrough ",[609,2294,2295],{},"useModuleT('subscriptions.\u003Cgroup>')",", and parameters use ",[609,2298,2299],{},"{name}",[614,2301,2302,2312],{},[617,2303,2304],{},[620,2305,2306,2309],{},[623,2307,2308],{},"Group",[623,2310,2311],{},"Keys",[633,2313,2314,2368,2389,2430,2452,2466,2482],{},[620,2315,2316,2321],{},[638,2317,2318],{},[609,2319,2320],{},"plans.*",[638,2322,2323,1125,2326,1125,2329,1125,2332,1125,2335,1125,2337,1125,2339,1137,2342,2345,2346,1125,2349,1137,2352,2345,2355,1125,2358,1125,2361,1125,2364,2367],{},[609,2324,2325],{},"loading",[609,2327,2328],{},"empty",[609,2330,2331],{},"current",[609,2333,2334],{},"subscribe",[609,2336,792],{},[609,2338,801],{},[609,2340,2341],{},"trial",[609,2343,2344],{},"{days}","), ",[609,2347,2348],{},"confirmTitle",[609,2350,2351],{},"confirmBody",[609,2353,2354],{},"{plan}",[609,2356,2357],{},"confirm",[609,2359,2360],{},"cancel",[609,2362,2363],{},"select",[609,2365,2366],{},"resubscribe"," and the confirmation texts.",[620,2369,2370,2375],{},[638,2371,2372],{},[609,2373,2374],{},"interval.*",[638,2376,2377,1125,2379,1125,2381,1125,2383,2385,2386,600],{},[609,2378,1038],{},[609,2380,1047],{},[609,2382,1056],{},[609,2384,1065],{},", their plurals, and ",[609,2387,2388],{},"quarter",[620,2390,2391,2396],{},[638,2392,2393],{},[609,2394,2395],{},"status.*",[638,2397,2398,1125,2400,1125,2403,1125,2406,1137,2409,2345,2412,1137,2415,2345,2417,1125,2420,2422,2423,1125,2426,2429],{},[609,2399,2325],{},[609,2401,2402],{},"title",[609,2404,2405],{},"none",[609,2407,2408],{},"renews",[609,2410,2411],{},"{date}",[609,2413,2414],{},"cancels",[609,2416,2411],{},[609,2418,2419],{},"manage",[609,2421,2366],{},", the status names, ",[609,2424,2425],{},"emptyTitle",[609,2427,2428],{},"emptyDescription"," and the card texts.",[620,2431,2432,2440],{},[638,2433,2434,1125,2437],{},[609,2435,2436],{},"success.*",[609,2438,2439],{},"cancel.*",[638,2441,2442,2443,1125,2445,2285,2448,2451],{},"The page texts: ",[609,2444,2402],{},[609,2446,2447],{},"body",[609,2449,2450],{},"back"," (\"Back to membership\").",[620,2453,2454,2459],{},[638,2455,2456],{},[609,2457,2458],{},"errors.*",[638,2460,2461,1125,2463,600],{},[609,2462,782],{},[609,2464,2465],{},"portal",[620,2467,2468,2479],{},[638,2469,2470,1125,2473,1125,2476],{},[609,2471,2472],{},"menu.*",[609,2474,2475],{},"admin.*",[609,2477,2478],{},"overview.*",[638,2480,2481],{},"The account menu item, the admin tab, card and panel, and the account overview summary.",[620,2483,2484,2489],{},[638,2485,2486],{},[609,2487,2488],{},"catalog.\u003CplanKey>.*",[638,2490,2491,1125,2494,2285,2497,2500],{},[609,2492,2493],{},"label",[609,2495,2496],{},"description",[609,2498,2499],{},"features"," (an array) per plan. They fall back to the plan config.",[602,2502,2504],{"id":2503},"next-steps","Next steps",[1623,2506,2507,2513],{},[1626,2508,2509,2512],{},[598,2510,2511],{"href":264},"Subscriptions server API"," – the checkout rules these hooks plug into.",[1626,2514,2515,2519],{},[598,2516,2518],{"href":2517},"\u002Fmodules\u002Fplatform\u002Fmodule-kit\u002Fi18n#overriding-module-strings-in-your-app","Module Kit translations"," – how locale\nfiles merge with the module's.",[2521,2522,2523],"style",{},"html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}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 .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}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 .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}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 .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}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}",{"title":693,"searchDepth":718,"depth":718,"links":2525},[2526,2527,2528,2529,2530],{"id":604,"depth":718,"text":234},{"id":1373,"depth":718,"text":1374},{"id":2071,"depth":718,"text":41},{"id":2272,"depth":718,"text":395},{"id":2503,"depth":718,"text":2504},"The hooks, HTTP routes and DTOs, the subscriptions table and the translation keys of Subscriptions.","md",null,{},{"title":179},{"title":589,"description":2531},"MJfYoMBx_qPjEA4xHHJPaYvHL8UEdTBGUROPjbQpmkc",[2539,2541],{"title":267,"path":268,"stem":269,"description":2540,"children":-1},"Show plans, start a checkout, guard pages by plan and turn on the ready-made membership pages.",{"title":173,"path":280,"stem":281,"description":2542,"children":-1},"Sell tickets to your events, free or paid through Stripe, and check people in at the door with a QR code.",1794503157996]