Plan is a simple model that sets the price of a given subscription. A subscription can have several plans, which are common in business models with “add on” features.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Valued's documentation","colors":{"primary":"#0E65DA","light":"#D8E6FA","dark":"#0E65DA"},"favicon":"/favicon.svg","logo":{"dark":"https://mintlify.s3-us-west-1.amazonaws.com/valued/logo/dark.svg","light":"https://mintlify.s3-us-west-1.amazonaws.com/valued/logo/light.svg"},"navbar":{"links":[{"label":"Support","href":"mailto:support@valued.app"}],"primary":{"type":"button","label":"Dashboard","href":"https://highly.valued.app/"}},"footer":{"socials":{"twitter/X":"https://twitter.com/valuedapp","github":"https://github.com/valued-app","linkedin":"https://www.linkedin.com/company/highly-valued"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"valued","hasAudioNarration":false,"actualSubdomain":"valued","customDomains":["docs.valued.app"],"gitSource":{"type":"github","owner":"valued-app","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c40f00c8336c6f4e58a3","collectionId":"969c49f3-4299-449c-baf3-b49a530a3c39","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20c40f00c8336c6f4e58a3:success","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"Data reference","count":21},{"language":"default","tag":"Documentation","count":13},{"language":"default","tag":"Revenue Resources","count":8},{"language":"default","tag":"Events","count":6},{"language":"default","tag":"Core Resources","count":5},{"language":"default","tag":"Guides","count":4},{"language":"default","tag":"Introduction","count":4},{"language":"default","tag":"Integrations","count":4},{"language":"default","tag":"Legal","count":1}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"data-reference/revenue-resources/plan","slug":"/data-reference/revenue-resources/plan","pageMetadata":{"title":"Plan","description":"Define a subcription or \"add on\" plan with its price.","href":"/data-reference/revenue-resources/plan"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Define a subcription or “add on” plan with its price.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Plans define a base price and name for a recurring purchase in your product. Each subscription has at least one plan associated with it.`}),`\n`,_jsx(Heading,{level:`2`,id:`the-plan-model`,children:`The plan model`}),`\n`,_jsx(_components.p,{children:`Plan is a simple model that sets the price of a given subscription. A subscription can have several plans, which are common in business models with “add on” features.`}),`\n`,_jsx(Heading,{level:`3`,id:`properties`,children:`Properties`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Name`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`id`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`Unique identifier`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`name`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`string`})}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`A name of a plan`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`price`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/revenue-resources/price`,children:_jsx(_components.code,{children:`Price`})})}),_jsx(_components.td,{children:`Yes`}),_jsx(_components.td,{children:`Subscription price`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Plan","description":"Define a subcription or \"add on\" plan with its price.","href":"/data-reference/revenue-resources/plan"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"The plan model","slug":"the-plan-model","depth":2,"children":[{"title":"Properties","slug":"properties","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"valued","siteName":"Valued's documentation","title":"Plan - Valued's documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"data-reference/revenue-resources/plan.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Define a subcription or \u0026quot;add on\u0026quot; plan with its price.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Valued\u0026#x27;s documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/valued/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/valued/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/valued/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/valued/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Plan - Valued\u0026#x27;s documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Define a subcription or \u0026quot;add on\u0026quot; plan with its price.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Valued\u0026#x27;s documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.valued.app/data-reference/revenue-resources/plan\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://valued.mintlify.app/_mintlify/api/og/v2?division=Revenue+Resources\u0026amp;title=Plan\u0026amp;description=Define+a+subcription+or+%22add+on%22+plan+with+its+price.\u0026amp;theme=3e5fe4451e55b58794520f65\u0026amp;signature=4af9767d0ebfbaa1903c29f7adfc123450e2109dc8bacab64abbd5eaf1156066\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Plan - Valued\u0026#x27;s documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Define a subcription or \u0026quot;add on\u0026quot; plan with its price.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://valued.mintlify.app/_mintlify/api/og/v2?division=Revenue+Resources\u0026amp;title=Plan\u0026amp;description=Define+a+subcription+or+%22add+on%22+plan+with+its+price.\u0026amp;theme=3e5fe4451e55b58794520f65\u0026amp;signature=4af9767d0ebfbaa1903c29f7adfc123450e2109dc8bacab64abbd5eaf1156066\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/valued/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Valued\u0026#x27;s documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0E65DA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.valued.app/data-reference/revenue-resources/plan\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/data-reference/revenue-resources/plan.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.valued.app/#organization\",\"name\":\"Valued's documentation\",\"url\":\"https://docs.valued.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintlify.s3-us-west-1.amazonaws.com/valued/logo/light.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.valued.app#website\",\"name\":\"Valued's documentation\",\"url\":\"https://docs.valued.app\",\"publisher\":{\"@id\":\"https://docs.valued.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.valued.app/data-reference/revenue-resources/plan#webpage\",\"url\":\"https://docs.valued.app/data-reference/revenue-resources/plan\",\"name\":\"Plan\",\"description\":\"Define a subcription or \\\"add on\\\" plan with its price.\",\"isPartOf\":{\"@id\":\"https://docs.valued.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.valued.app/data-reference/revenue-resources/plan#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.valued.app/data-reference/revenue-resources/plan#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Revenue Resources\",\"item\":\"https://docs.valued.app/data-reference/revenue-resources/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Plan\",\"item\":\"https://docs.valued.app/data-reference/revenue-resources/plan\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.valued.app/data-reference/revenue-resources/plan#article\",\"headline\":\"Plan\",\"name\":\"Plan\",\"description\":\"Define a subcription or \\\"add on\\\" plan with its price.\",\"url\":\"https://docs.valued.app/data-reference/revenue-resources/plan\",\"mainEntityOfPage\":{\"@id\":\"https://docs.valued.app/data-reference/revenue-resources/plan#webpage\"},\"publisher\":{\"@id\":\"https://docs.valued.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.valued.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Valued's documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Valued's documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Data reference","groups":[{"group":"Data reference","pages":[{"title":"Introduction","href":"/data-reference/introduction"}]},{"group":"Core Resources","pages":[{"title":"Customer","href":"/data-reference/core-resources/customer"},{"title":"User","href":"/data-reference/core-resources/user"},{"title":"Goal","href":"/data-reference/core-resources/goal"},{"title":"Signal","href":"/data-reference/core-resources/signal"},{"title":"Membership","href":"/data-reference/core-resources/membership"}]},{"group":"Events","pages":[{"title":"Sync","href":"/data-reference/events/sync"},{"title":"Action","href":"/data-reference/events/action"},{"title":"Screen","href":"/data-reference/events/screen"},{"title":"Pageview","href":"/data-reference/events/pageview"},{"title":"Config","href":"/data-reference/events/config"},{"title":"Revenue","href":"/data-reference/events/revenue"}]},{"group":"Revenue Resources","pages":[{"title":"Revenue Overview","href":"/data-reference/revenue-resources/overview"},{"title":"Subscription","href":"/data-reference/revenue-resources/subscription"},{"title":"Subscription Item","description":"An individual subscription product bought by a customer","href":"/data-reference/revenue-resources/subscription-item"},{"title":"Plan","href":"/data-reference/revenue-resources/plan"},{"title":"Price","description":"Unit cost, currency and interval for a given","href":"/data-reference/revenue-resources/price"},{"title":"Tiers","href":"/data-reference/revenue-resources/tiers"},{"title":"Invoice","href":"/data-reference/revenue-resources/invoice"},{"title":"Invoice Item","href":"/data-reference/revenue-resources/invoice-item"}]}]}]},"title":"Plan - Valued's documentation","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":[],"chunks":[]}