[{"data":1,"prerenderedAt":1276},["ShallowReactive",2],{"navigation_docs":3,"-packages-javascript-subscriptionplans":465,"-packages-javascript-subscriptionplans-surround":1271},[4,8,62,115,450],{"title":5,"path":6,"stem":7},"Introduction","\u002Fintroduction","0.introduction",{"title":9,"path":10,"stem":11,"children":12,"page":61},"Guides","\u002Fguides","1.guides",[13,17,21,25,29,33,37,41,45,49,53,57],{"title":14,"path":15,"stem":16},"Quickstart","\u002Fguides\u002Fquickstart","1.guides\u002F1.quickstart",{"title":18,"path":19,"stem":20},"Payouts & Settlement","\u002Fguides\u002Fpayouts","1.guides\u002F10.payouts",{"title":22,"path":23,"stem":24},"Customer Emails","\u002Fguides\u002Fcustomer-emails","1.guides\u002F11.customer-emails",{"title":26,"path":27,"stem":28},"Build your own integration","\u002Fguides\u002Fbuild-your-own-integration","1.guides\u002F2.build-your-own-integration",{"title":30,"path":31,"stem":32},"Selling Workflow","\u002Fguides\u002Fselling-workflow","1.guides\u002F2.selling-workflow",{"title":34,"path":35,"stem":36},"Vatly SDKs","\u002Fguides\u002Fsdks","1.guides\u002F3.sdks",{"title":38,"path":39,"stem":40},"Authentication","\u002Fguides\u002Fauthentication","1.guides\u002F4.authentication",{"title":42,"path":43,"stem":44},"Pagination","\u002Fguides\u002Fpagination","1.guides\u002F5.pagination",{"title":46,"path":47,"stem":48},"Errors","\u002Fguides\u002Ferrors","1.guides\u002F6.errors",{"title":50,"path":51,"stem":52},"Webhooks","\u002Fguides\u002Fwebhooks","1.guides\u002F7.webhooks",{"title":54,"path":55,"stem":56},"Idempotency","\u002Fguides\u002Fidempotency","1.guides\u002F8.idempotency",{"title":58,"path":59,"stem":60},"Testing","\u002Fguides\u002Ftesting","1.guides\u002F9.testing",false,{"title":63,"path":64,"stem":65,"children":66,"page":61},"Api Reference","\u002Fapi-reference","2.api-reference",[67,71,75,79,83,87,91,95,99,103,107,111],{"title":68,"path":69,"stem":70},"Customers","\u002Fapi-reference\u002Fcustomers","2.api-reference\u002F1.customers",{"title":72,"path":73,"stem":74},"Webhook Endpoints","\u002Fapi-reference\u002Fwebhook-endpoints","2.api-reference\u002F10.webhook-endpoints",{"title":76,"path":77,"stem":78},"Test helpers","\u002Fapi-reference\u002Ftest-helpers","2.api-reference\u002F11.test-helpers",{"title":80,"path":81,"stem":82},"Checkouts","\u002Fapi-reference\u002Fcheckouts","2.api-reference\u002F2.checkouts",{"title":84,"path":85,"stem":86},"One-off Products","\u002Fapi-reference\u002Fone-off-products","2.api-reference\u002F3.one-off-products",{"title":88,"path":89,"stem":90},"Subscriptions","\u002Fapi-reference\u002Fsubscriptions","2.api-reference\u002F4.subscriptions",{"title":92,"path":93,"stem":94},"Subscription Plans","\u002Fapi-reference\u002Fsubscription-plans","2.api-reference\u002F5.subscription-plans",{"title":96,"path":97,"stem":98},"Orders","\u002Fapi-reference\u002Forders","2.api-reference\u002F6.orders",{"title":100,"path":101,"stem":102},"Order Refunds","\u002Fapi-reference\u002Frefunds","2.api-reference\u002F7.refunds",{"title":104,"path":105,"stem":106},"Refunds","\u002Fapi-reference\u002Fglobal-refunds","2.api-reference\u002F8.global-refunds",{"title":108,"path":109,"stem":110},"Chargebacks","\u002Fapi-reference\u002Fchargebacks","2.api-reference\u002F9.chargebacks",{"title":112,"path":113,"stem":114},"Webhook Events","\u002Fapi-reference\u002Fwebhook-events","2.api-reference\u002F99.webhook-events",{"title":116,"path":117,"stem":118,"children":119},"Packages","\u002Fpackages","3.packages",[120,122,164,210,244,283,318,366,408],{"title":116,"path":117,"stem":121},"3.packages\u002Findex",{"title":123,"path":124,"stem":125,"children":126,"page":61},"PHP SDK","\u002Fpackages\u002Fphp","3.packages\u002F1.php",[127,131,134,137,140,144,147,151,154,157,160],{"title":128,"path":129,"stem":130},"Getting started","\u002Fpackages\u002Fphp\u002Freadme","3.packages\u002F1.php\u002F00.readme",{"title":68,"path":132,"stem":133},"\u002Fpackages\u002Fphp\u002Fcustomers","3.packages\u002F1.php\u002F02.customers",{"title":80,"path":135,"stem":136},"\u002Fpackages\u002Fphp\u002Fcheckouts","3.packages\u002F1.php\u002F03.checkouts",{"title":88,"path":138,"stem":139},"\u002Fpackages\u002Fphp\u002Fsubscriptions","3.packages\u002F1.php\u002F04.subscriptions",{"title":141,"path":142,"stem":143},"Subscription plans","\u002Fpackages\u002Fphp\u002Fsubscriptionplans","3.packages\u002F1.php\u002F05.subscriptionplans",{"title":96,"path":145,"stem":146},"\u002Fpackages\u002Fphp\u002Forders","3.packages\u002F1.php\u002F06.orders",{"title":148,"path":149,"stem":150},"One-off products","\u002Fpackages\u002Fphp\u002Foneoffproducts","3.packages\u002F1.php\u002F07.oneoffproducts",{"title":104,"path":152,"stem":153},"\u002Fpackages\u002Fphp\u002Frefunds","3.packages\u002F1.php\u002F08.refunds",{"title":108,"path":155,"stem":156},"\u002Fpackages\u002Fphp\u002Fchargebacks","3.packages\u002F1.php\u002F09.chargebacks",{"title":50,"path":158,"stem":159},"\u002Fpackages\u002Fphp\u002Fwebhooks","3.packages\u002F1.php\u002F10.webhooks",{"title":161,"path":162,"stem":163},"Webhook URLs","\u002Fpackages\u002Fphp\u002Fwebhookendpoints","3.packages\u002F1.php\u002F11.webhookendpoints",{"title":165,"path":166,"stem":167,"children":168,"page":61},"PHP Fluent","\u002Fpackages\u002Ffluent-php","3.packages\u002F2.fluent-php",[169,172,176,180,183,186,189,192,196,199,203,207],{"title":128,"path":170,"stem":171},"\u002Fpackages\u002Ffluent-php\u002Freadme","3.packages\u002F2.fluent-php\u002F00.readme",{"title":173,"path":174,"stem":175},"Configuration","\u002Fpackages\u002Ffluent-php\u002Fconfiguration","3.packages\u002F2.fluent-php\u002F01.configuration",{"title":177,"path":178,"stem":179},"Core concepts","\u002Fpackages\u002Ffluent-php\u002Fcoreconcepts","3.packages\u002F2.fluent-php\u002F02.coreconcepts",{"title":68,"path":181,"stem":182},"\u002Fpackages\u002Ffluent-php\u002Fcustomers","3.packages\u002F2.fluent-php\u002F03.customers",{"title":80,"path":184,"stem":185},"\u002Fpackages\u002Ffluent-php\u002Fcheckouts","3.packages\u002F2.fluent-php\u002F04.checkouts",{"title":88,"path":187,"stem":188},"\u002Fpackages\u002Ffluent-php\u002Fsubscriptions","3.packages\u002F2.fluent-php\u002F05.subscriptions",{"title":96,"path":190,"stem":191},"\u002Fpackages\u002Ffluent-php\u002Forders","3.packages\u002F2.fluent-php\u002F06.orders",{"title":193,"path":194,"stem":195},"Customer portal","\u002Fpackages\u002Ffluent-php\u002Fcustomerportal","3.packages\u002F2.fluent-php\u002F07.customerportal",{"title":50,"path":197,"stem":198},"\u002Fpackages\u002Ffluent-php\u002Fwebhooks","3.packages\u002F2.fluent-php\u002F08.webhooks",{"title":200,"path":201,"stem":202},"Webhook event flow","\u002Fpackages\u002Ffluent-php\u002Fwebhook-flow","3.packages\u002F2.fluent-php\u002F09.webhook-flow",{"title":204,"path":205,"stem":206},"Existing tables","\u002Fpackages\u002Ffluent-php\u002Fhost-owns-its-tables","3.packages\u002F2.fluent-php\u002F10.host-owns-its-tables",{"title":58,"path":208,"stem":209},"\u002Fpackages\u002Ffluent-php\u002Ftesting","3.packages\u002F2.fluent-php\u002F11.testing",{"title":211,"path":212,"stem":213,"children":214,"page":61},"Laravel","\u002Fpackages\u002Flaravel","3.packages\u002F3.laravel",[215,218,221,224,227,230,233,236,240],{"title":128,"path":216,"stem":217},"\u002Fpackages\u002Flaravel\u002Freadme","3.packages\u002F3.laravel\u002F00.readme",{"title":173,"path":219,"stem":220},"\u002Fpackages\u002Flaravel\u002Fconfiguration","3.packages\u002F3.laravel\u002F01.configuration",{"title":68,"path":222,"stem":223},"\u002Fpackages\u002Flaravel\u002Fcustomers","3.packages\u002F3.laravel\u002F02.customers",{"title":80,"path":225,"stem":226},"\u002Fpackages\u002Flaravel\u002Fcheckouts","3.packages\u002F3.laravel\u002F03.checkouts",{"title":88,"path":228,"stem":229},"\u002Fpackages\u002Flaravel\u002Fsubscriptions","3.packages\u002F3.laravel\u002F04.subscriptions",{"title":96,"path":231,"stem":232},"\u002Fpackages\u002Flaravel\u002Forders","3.packages\u002F3.laravel\u002F05.orders",{"title":50,"path":234,"stem":235},"\u002Fpackages\u002Flaravel\u002Fwebhooks","3.packages\u002F3.laravel\u002F06.webhooks",{"title":237,"path":238,"stem":239},"Comparison","\u002Fpackages\u002Flaravel\u002Fcomparison","3.packages\u002F3.laravel\u002F07.comparison",{"title":241,"path":242,"stem":243},"Migrating from Cashier","\u002Fpackages\u002Flaravel\u002Fmigrating-to-vatly","3.packages\u002F3.laravel\u002F08.migrating-to-vatly",{"title":245,"path":246,"stem":247,"children":248,"page":61},"JavaScript SDK","\u002Fpackages\u002Fjavascript","3.packages\u002F4.javascript",[249,252,255,258,261,264,267,270,273,276,279],{"title":128,"path":250,"stem":251},"\u002Fpackages\u002Fjavascript\u002Freadme","3.packages\u002F4.javascript\u002F00.readme",{"title":68,"path":253,"stem":254},"\u002Fpackages\u002Fjavascript\u002Fcustomers","3.packages\u002F4.javascript\u002F02.customers",{"title":80,"path":256,"stem":257},"\u002Fpackages\u002Fjavascript\u002Fcheckouts","3.packages\u002F4.javascript\u002F03.checkouts",{"title":88,"path":259,"stem":260},"\u002Fpackages\u002Fjavascript\u002Fsubscriptions","3.packages\u002F4.javascript\u002F04.subscriptions",{"title":141,"path":262,"stem":263},"\u002Fpackages\u002Fjavascript\u002Fsubscriptionplans","3.packages\u002F4.javascript\u002F05.subscriptionplans",{"title":96,"path":265,"stem":266},"\u002Fpackages\u002Fjavascript\u002Forders","3.packages\u002F4.javascript\u002F06.orders",{"title":148,"path":268,"stem":269},"\u002Fpackages\u002Fjavascript\u002Foneoffproducts","3.packages\u002F4.javascript\u002F07.oneoffproducts",{"title":104,"path":271,"stem":272},"\u002Fpackages\u002Fjavascript\u002Frefunds","3.packages\u002F4.javascript\u002F08.refunds",{"title":108,"path":274,"stem":275},"\u002Fpackages\u002Fjavascript\u002Fchargebacks","3.packages\u002F4.javascript\u002F09.chargebacks",{"title":50,"path":277,"stem":278},"\u002Fpackages\u002Fjavascript\u002Fwebhooks","3.packages\u002F4.javascript\u002F10.webhooks",{"title":280,"path":281,"stem":282},"API reference","\u002Fpackages\u002Fjavascript\u002Fapi","3.packages\u002F4.javascript\u002F12.api",{"title":284,"path":285,"stem":286,"children":287,"page":61},"JavaScript Fluent","\u002Fpackages\u002Ffluent-js","3.packages\u002F5.fluent-js",[288,291,294,297,300,303,306,309,312,315],{"title":128,"path":289,"stem":290},"\u002Fpackages\u002Ffluent-js\u002Freadme","3.packages\u002F5.fluent-js\u002F00.readme",{"title":173,"path":292,"stem":293},"\u002Fpackages\u002Ffluent-js\u002Fconfiguration","3.packages\u002F5.fluent-js\u002F01.configuration",{"title":177,"path":295,"stem":296},"\u002Fpackages\u002Ffluent-js\u002Fcoreconcepts","3.packages\u002F5.fluent-js\u002F02.coreconcepts",{"title":68,"path":298,"stem":299},"\u002Fpackages\u002Ffluent-js\u002Fcustomers","3.packages\u002F5.fluent-js\u002F03.customers",{"title":80,"path":301,"stem":302},"\u002Fpackages\u002Ffluent-js\u002Fcheckouts","3.packages\u002F5.fluent-js\u002F04.checkouts",{"title":88,"path":304,"stem":305},"\u002Fpackages\u002Ffluent-js\u002Fsubscriptions","3.packages\u002F5.fluent-js\u002F05.subscriptions",{"title":96,"path":307,"stem":308},"\u002Fpackages\u002Ffluent-js\u002Forders","3.packages\u002F5.fluent-js\u002F06.orders",{"title":193,"path":310,"stem":311},"\u002Fpackages\u002Ffluent-js\u002Fcustomerportal","3.packages\u002F5.fluent-js\u002F07.customerportal",{"title":50,"path":313,"stem":314},"\u002Fpackages\u002Ffluent-js\u002Fwebhooks","3.packages\u002F5.fluent-js\u002F08.webhooks",{"title":58,"path":316,"stem":317},"\u002Fpackages\u002Ffluent-js\u002Ftesting","3.packages\u002F5.fluent-js\u002F11.testing",{"title":319,"path":320,"stem":321,"children":322,"page":61},"Python SDK","\u002Fpackages\u002Fpython","3.packages\u002F6.python",[323,326,329,332,335,338,341,344,347,350,353,356,359,362],{"title":128,"path":324,"stem":325},"\u002Fpackages\u002Fpython\u002Freadme","3.packages\u002F6.python\u002F00.readme",{"title":173,"path":327,"stem":328},"\u002Fpackages\u002Fpython\u002Fconfiguration","3.packages\u002F6.python\u002F01.configuration",{"title":68,"path":330,"stem":331},"\u002Fpackages\u002Fpython\u002Fcustomers","3.packages\u002F6.python\u002F02.customers",{"title":80,"path":333,"stem":334},"\u002Fpackages\u002Fpython\u002Fcheckouts","3.packages\u002F6.python\u002F03.checkouts",{"title":88,"path":336,"stem":337},"\u002Fpackages\u002Fpython\u002Fsubscriptions","3.packages\u002F6.python\u002F04.subscriptions",{"title":141,"path":339,"stem":340},"\u002Fpackages\u002Fpython\u002Fsubscriptionplans","3.packages\u002F6.python\u002F05.subscriptionplans",{"title":96,"path":342,"stem":343},"\u002Fpackages\u002Fpython\u002Forders","3.packages\u002F6.python\u002F06.orders",{"title":148,"path":345,"stem":346},"\u002Fpackages\u002Fpython\u002Foneoffproducts","3.packages\u002F6.python\u002F07.oneoffproducts",{"title":104,"path":348,"stem":349},"\u002Fpackages\u002Fpython\u002Frefunds","3.packages\u002F6.python\u002F08.refunds",{"title":108,"path":351,"stem":352},"\u002Fpackages\u002Fpython\u002Fchargebacks","3.packages\u002F6.python\u002F09.chargebacks",{"title":50,"path":354,"stem":355},"\u002Fpackages\u002Fpython\u002Fwebhooks","3.packages\u002F6.python\u002F10.webhooks",{"title":161,"path":357,"stem":358},"\u002Fpackages\u002Fpython\u002Fwebhookendpoints","3.packages\u002F6.python\u002F11.webhookendpoints",{"title":280,"path":360,"stem":361},"\u002Fpackages\u002Fpython\u002Fapi","3.packages\u002F6.python\u002F12.api",{"title":363,"path":364,"stem":365},"Development","\u002Fpackages\u002Fpython\u002Fdevelopment","3.packages\u002F6.python\u002F13.development",{"title":367,"path":368,"stem":369,"children":370,"page":61},"Python Fluent","\u002Fpackages\u002Ffluent-python","3.packages\u002F7.fluent-python",[371,374,377,380,383,386,389,392,395,398,401,405],{"title":128,"path":372,"stem":373},"\u002Fpackages\u002Ffluent-python\u002Freadme","3.packages\u002F7.fluent-python\u002F00.readme",{"title":173,"path":375,"stem":376},"\u002Fpackages\u002Ffluent-python\u002Fconfiguration","3.packages\u002F7.fluent-python\u002F01.configuration",{"title":177,"path":378,"stem":379},"\u002Fpackages\u002Ffluent-python\u002Fcoreconcepts","3.packages\u002F7.fluent-python\u002F02.coreconcepts",{"title":68,"path":381,"stem":382},"\u002Fpackages\u002Ffluent-python\u002Fcustomers","3.packages\u002F7.fluent-python\u002F03.customers",{"title":80,"path":384,"stem":385},"\u002Fpackages\u002Ffluent-python\u002Fcheckouts","3.packages\u002F7.fluent-python\u002F04.checkouts",{"title":88,"path":387,"stem":388},"\u002Fpackages\u002Ffluent-python\u002Fsubscriptions","3.packages\u002F7.fluent-python\u002F05.subscriptions",{"title":96,"path":390,"stem":391},"\u002Fpackages\u002Ffluent-python\u002Forders","3.packages\u002F7.fluent-python\u002F06.orders",{"title":193,"path":393,"stem":394},"\u002Fpackages\u002Ffluent-python\u002Fcustomerportal","3.packages\u002F7.fluent-python\u002F07.customerportal",{"title":50,"path":396,"stem":397},"\u002Fpackages\u002Ffluent-python\u002Fwebhooks","3.packages\u002F7.fluent-python\u002F08.webhooks",{"title":58,"path":399,"stem":400},"\u002Fpackages\u002Ffluent-python\u002Ftesting","3.packages\u002F7.fluent-python\u002F11.testing",{"title":402,"path":403,"stem":404},"Porting","\u002Fpackages\u002Ffluent-python\u002Fporting","3.packages\u002F7.fluent-python\u002F12.porting",{"title":363,"path":406,"stem":407},"\u002Fpackages\u002Ffluent-python\u002Fdevelopment","3.packages\u002F7.fluent-python\u002F13.development",{"title":409,"path":410,"stem":411,"children":412,"page":61},"Django","\u002Fpackages\u002Fdjango","3.packages\u002F8.django",[413,416,420,423,427,431,434,437,440,444,447],{"title":128,"path":414,"stem":415},"\u002Fpackages\u002Fdjango\u002Freadme","3.packages\u002F8.django\u002F00.readme",{"title":417,"path":418,"stem":419},"Installation","\u002Fpackages\u002Fdjango\u002Finstallation","3.packages\u002F8.django\u002F01.installation",{"title":173,"path":421,"stem":422},"\u002Fpackages\u002Fdjango\u002Fconfiguration","3.packages\u002F8.django\u002F02.configuration",{"title":424,"path":425,"stem":426},"Billable models","\u002Fpackages\u002Fdjango\u002Fbillablemodels","3.packages\u002F8.django\u002F03.billablemodels",{"title":428,"path":429,"stem":430},"Checkout","\u002Fpackages\u002Fdjango\u002Fcheckout","3.packages\u002F8.django\u002F04.checkout",{"title":88,"path":432,"stem":433},"\u002Fpackages\u002Fdjango\u002Fbilling","3.packages\u002F8.django\u002F05.billing",{"title":193,"path":435,"stem":436},"\u002Fpackages\u002Fdjango\u002Fcustomerportal","3.packages\u002F8.django\u002F06.customerportal",{"title":50,"path":438,"stem":439},"\u002Fpackages\u002Fdjango\u002Fwebhooks","3.packages\u002F8.django\u002F07.webhooks",{"title":441,"path":442,"stem":443},"Admin","\u002Fpackages\u002Fdjango\u002Fadmin","3.packages\u002F8.django\u002F08.admin",{"title":58,"path":445,"stem":446},"\u002Fpackages\u002Fdjango\u002Ftesting","3.packages\u002F8.django\u002F09.testing",{"title":363,"path":448,"stem":449},"\u002Fpackages\u002Fdjango\u002Fdevelopment","3.packages\u002F8.django\u002F10.development",{"title":451,"path":452,"stem":453,"children":454},"Integrations","\u002Fintegrations","4.integrations",[455,457,461],{"title":451,"path":452,"stem":456},"4.integrations\u002Findex",{"title":458,"path":459,"stem":460},"Lovable payments with Vatly","\u002Fintegrations\u002Flovable","4.integrations\u002F1.lovable",{"title":462,"path":463,"stem":464},"Bolt payments with Vatly","\u002Fintegrations\u002Fbolt","4.integrations\u002F2.bolt",{"id":466,"title":92,"body":467,"description":1264,"extension":1265,"links":1266,"meta":1267,"navigation":1268,"path":262,"seo":1269,"stem":263,"__hash__":1270},"docs\u002F3.packages\u002F4.javascript\u002F05.subscriptionplans.md",{"type":468,"value":469,"toc":1258},"minimark",[470,474,491,496,686,690,695,797,801,806,910,923,927,1227,1254],[471,472,473],"p",{},"Subscription plans define recurring products, prices, and billing intervals.\nThe API supports creation, updates, archive and unarchive.",[471,475,476,477,484,485,490],{},"For all fields and options, see the ",[478,479,483],"a",{"href":480,"rel":481},"https:\u002F\u002Fdocs.vatly.com\u002Fapi-reference\u002Fsubscription-plans",[482],"nofollow","Subscription Plans API reference",". The ",[478,486,489],{"href":487,"rel":488},"https:\u002F\u002Fdocs.vatly.com\u002Fopenapi.yaml",[482],"OpenAPI spec"," is also available for tooling.",[492,493,495],"h2",{"id":494},"the-subscription-plan-resource","The Subscription Plan resource",[497,498,499,515],"table",{},[500,501,502],"thead",{},[503,504,505,509,512],"tr",{},[506,507,508],"th",{},"Name",[506,510,511],{},"Type",[506,513,514],{},"Description",[516,517,518,539,557,571,586,604,629,657,671],"tbody",{},[503,519,520,527,532],{},[521,522,523],"td",{},[524,525,526],"code",{},"id",[521,528,529],{},[524,530,531],{},"string",[521,533,534,535,538],{},"Unique identifier (",[524,536,537],{},"subscription_plan_…",").",[503,540,541,546,550],{},[521,542,543],{},[524,544,545],{},"resource",[521,547,548],{},[524,549,531],{},[521,551,552,553,556],{},"Always ",[524,554,555],{},"subscription_plan",".",[503,558,559,564,568],{},[521,560,561],{},[524,562,563],{},"name",[521,565,566],{},[524,567,531],{},[521,569,570],{},"Display name.",[503,572,573,578,583],{},[521,574,575],{},[524,576,577],{},"description",[521,579,580],{},[524,581,582],{},"string | null",[521,584,585],{},"Optional description.",[503,587,588,593,598],{},[521,589,590],{},[524,591,592],{},"basePrice",[521,594,595],{},[524,596,597],{},"Money",[521,599,600,601,556],{},"Price per interval, e.g. ",[524,602,603],{},"{ value: \"29.00\", currency: \"EUR\" }",[503,605,606,615,622],{},[521,607,608,611,612],{},[524,609,610],{},"interval"," \u002F ",[524,613,614],{},"intervalCount",[521,616,617,611,619],{},[524,618,531],{},[524,620,621],{},"number",[521,623,624,625,628],{},"Billing cadence (e.g. ",[524,626,627],{},"month"," × 1).",[503,630,631,636,640],{},[521,632,633],{},[524,634,635],{},"status",[521,637,638],{},[524,639,531],{},[521,641,642,645,646,649,650,653,654,556],{},[524,643,644],{},"active",", ",[524,647,648],{},"pending",", or ",[524,651,652],{},"rejected",". Archive state is separate in ",[524,655,656],{},"archivedAt",[503,658,659,664,668],{},[521,660,661],{},[524,662,663],{},"createdAt",[521,665,666],{},[524,667,531],{},[521,669,670],{},"Creation timestamp (ISO 8601).",[503,672,673,678,683],{},[521,674,675],{},[524,676,677],{},"testmode",[521,679,680],{},[524,681,682],{},"boolean",[521,684,685],{},"Whether this is a test plan.",[492,687,689],{"id":688},"retrieve-a-subscription-plan","Retrieve a subscription plan",[471,691,692],{},[524,693,694],{},"GET \u002Fv1\u002Fsubscription-plans\u002F{subscriptionPlanId}",[696,697,702],"pre",{"className":698,"code":699,"language":700,"meta":701,"style":701},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","const plan = await vatly.subscriptionPlans.get(\"subscription_plan_abc123\");\nconsole.log(plan.basePrice.value, plan.basePrice.currency);\n","ts","",[524,703,704,757],{"__ignoreMap":701},[705,706,709,713,717,721,725,728,730,733,735,739,742,745,749,751,754],"span",{"class":707,"line":708},"line",1,[705,710,712],{"class":711},"spNyl","const",[705,714,716],{"class":715},"sTEyZ"," plan ",[705,718,720],{"class":719},"sMK4o","=",[705,722,724],{"class":723},"s7zQu"," await",[705,726,727],{"class":715}," vatly",[705,729,556],{"class":719},[705,731,732],{"class":715},"subscriptionPlans",[705,734,556],{"class":719},[705,736,738],{"class":737},"s2Zo4","get",[705,740,741],{"class":715},"(",[705,743,744],{"class":719},"\"",[705,746,748],{"class":747},"sfazB","subscription_plan_abc123",[705,750,744],{"class":719},[705,752,753],{"class":715},")",[705,755,756],{"class":719},";\n",[705,758,760,763,765,768,771,773,775,777,780,783,786,788,790,792,795],{"class":707,"line":759},2,[705,761,762],{"class":715},"console",[705,764,556],{"class":719},[705,766,767],{"class":737},"log",[705,769,770],{"class":715},"(plan",[705,772,556],{"class":719},[705,774,592],{"class":715},[705,776,556],{"class":719},[705,778,779],{"class":715},"value",[705,781,782],{"class":719},",",[705,784,785],{"class":715}," plan",[705,787,556],{"class":719},[705,789,592],{"class":715},[705,791,556],{"class":719},[705,793,794],{"class":715},"currency)",[705,796,756],{"class":719},[492,798,800],{"id":799},"list-subscription-plans","List subscription plans",[471,802,803],{},[524,804,805],{},"GET \u002Fv1\u002Fsubscription-plans",[696,807,809],{"className":698,"code":808,"language":700,"meta":701,"style":701},"const page = await vatly.subscriptionPlans.list({ limit: 25 });\n\nfor await (const plan of vatly.subscriptionPlans.listAll()) {\n  \u002F\u002F ...\n}\n",[524,810,811,856,862,897,904],{"__ignoreMap":701},[705,812,813,815,818,820,822,824,826,828,830,833,835,838,842,845,849,852,854],{"class":707,"line":708},[705,814,712],{"class":711},[705,816,817],{"class":715}," page ",[705,819,720],{"class":719},[705,821,724],{"class":723},[705,823,727],{"class":715},[705,825,556],{"class":719},[705,827,732],{"class":715},[705,829,556],{"class":719},[705,831,832],{"class":737},"list",[705,834,741],{"class":715},[705,836,837],{"class":719},"{",[705,839,841],{"class":840},"swJcz"," limit",[705,843,844],{"class":719},":",[705,846,848],{"class":847},"sbssI"," 25",[705,850,851],{"class":719}," }",[705,853,753],{"class":715},[705,855,756],{"class":719},[705,857,858],{"class":707,"line":759},[705,859,861],{"emptyLinePlaceholder":860},true,"\n",[705,863,865,868,870,873,875,877,880,882,884,886,888,891,894],{"class":707,"line":864},3,[705,866,867],{"class":723},"for",[705,869,724],{"class":723},[705,871,872],{"class":715}," (",[705,874,712],{"class":711},[705,876,716],{"class":715},[705,878,879],{"class":719},"of",[705,881,727],{"class":715},[705,883,556],{"class":719},[705,885,732],{"class":715},[705,887,556],{"class":719},[705,889,890],{"class":737},"listAll",[705,892,893],{"class":715},"()) ",[705,895,896],{"class":719},"{\n",[705,898,900],{"class":707,"line":899},4,[705,901,903],{"class":902},"sHwdD","  \u002F\u002F ...\n",[705,905,907],{"class":707,"line":906},5,[705,908,909],{"class":719},"}\n",[471,911,912,913,915,916,919,920,556],{},"To sell a plan, pass its ",[524,914,526],{}," in a ",[478,917,918],{"href":256},"checkout","'s ",[524,921,922],{},"products",[492,924,926],{"id":925},"create-update-and-archive","Create, update and archive",[696,928,930],{"className":698,"code":929,"language":700,"meta":701,"style":701},"const plan = await vatly.subscriptionPlans.create({\n  name: \"Pro Monthly\", description: \"Pro features\", productType: \"saas\",\n  basePrice: { value: \"29.00\", currency: \"EUR\" }, interval: \"month\", intervalCount: 1,\n});\nawait vatly.subscriptionPlans.update(plan.id, { interval: \"week\", intervalCount: 2 });\nawait vatly.subscriptionPlans.archive(plan.id); \u002F\u002F 204: no return value\nconst restored = await vatly.subscriptionPlans.unarchive(plan.id);\nconst all = await vatly.subscriptionPlans.list({ includeArchived: true });\n",[524,931,932,957,1003,1065,1074,1126,1155,1186],{"__ignoreMap":701},[705,933,934,936,938,940,942,944,946,948,950,953,955],{"class":707,"line":708},[705,935,712],{"class":711},[705,937,716],{"class":715},[705,939,720],{"class":719},[705,941,724],{"class":723},[705,943,727],{"class":715},[705,945,556],{"class":719},[705,947,732],{"class":715},[705,949,556],{"class":719},[705,951,952],{"class":737},"create",[705,954,741],{"class":715},[705,956,896],{"class":719},[705,958,959,962,964,967,970,972,974,977,979,981,984,986,988,991,993,995,998,1000],{"class":707,"line":759},[705,960,961],{"class":840},"  name",[705,963,844],{"class":719},[705,965,966],{"class":719}," \"",[705,968,969],{"class":747},"Pro Monthly",[705,971,744],{"class":719},[705,973,782],{"class":719},[705,975,976],{"class":840}," description",[705,978,844],{"class":719},[705,980,966],{"class":719},[705,982,983],{"class":747},"Pro features",[705,985,744],{"class":719},[705,987,782],{"class":719},[705,989,990],{"class":840}," productType",[705,992,844],{"class":719},[705,994,966],{"class":719},[705,996,997],{"class":747},"saas",[705,999,744],{"class":719},[705,1001,1002],{"class":719},",\n",[705,1004,1005,1008,1010,1013,1016,1018,1020,1023,1025,1027,1030,1032,1034,1037,1039,1042,1045,1047,1049,1051,1053,1055,1058,1060,1063],{"class":707,"line":864},[705,1006,1007],{"class":840},"  basePrice",[705,1009,844],{"class":719},[705,1011,1012],{"class":719}," {",[705,1014,1015],{"class":840}," value",[705,1017,844],{"class":719},[705,1019,966],{"class":719},[705,1021,1022],{"class":747},"29.00",[705,1024,744],{"class":719},[705,1026,782],{"class":719},[705,1028,1029],{"class":840}," currency",[705,1031,844],{"class":719},[705,1033,966],{"class":719},[705,1035,1036],{"class":747},"EUR",[705,1038,744],{"class":719},[705,1040,1041],{"class":719}," },",[705,1043,1044],{"class":840}," interval",[705,1046,844],{"class":719},[705,1048,966],{"class":719},[705,1050,627],{"class":747},[705,1052,744],{"class":719},[705,1054,782],{"class":719},[705,1056,1057],{"class":840}," intervalCount",[705,1059,844],{"class":719},[705,1061,1062],{"class":847}," 1",[705,1064,1002],{"class":719},[705,1066,1067,1070,1072],{"class":707,"line":899},[705,1068,1069],{"class":719},"}",[705,1071,753],{"class":715},[705,1073,756],{"class":719},[705,1075,1076,1079,1081,1083,1085,1087,1090,1092,1094,1096,1098,1100,1102,1104,1106,1109,1111,1113,1115,1117,1120,1122,1124],{"class":707,"line":906},[705,1077,1078],{"class":723},"await",[705,1080,727],{"class":715},[705,1082,556],{"class":719},[705,1084,732],{"class":715},[705,1086,556],{"class":719},[705,1088,1089],{"class":737},"update",[705,1091,770],{"class":715},[705,1093,556],{"class":719},[705,1095,526],{"class":715},[705,1097,782],{"class":719},[705,1099,1012],{"class":719},[705,1101,1044],{"class":840},[705,1103,844],{"class":719},[705,1105,966],{"class":719},[705,1107,1108],{"class":747},"week",[705,1110,744],{"class":719},[705,1112,782],{"class":719},[705,1114,1057],{"class":840},[705,1116,844],{"class":719},[705,1118,1119],{"class":847}," 2",[705,1121,851],{"class":719},[705,1123,753],{"class":715},[705,1125,756],{"class":719},[705,1127,1129,1131,1133,1135,1137,1139,1142,1144,1146,1149,1152],{"class":707,"line":1128},6,[705,1130,1078],{"class":723},[705,1132,727],{"class":715},[705,1134,556],{"class":719},[705,1136,732],{"class":715},[705,1138,556],{"class":719},[705,1140,1141],{"class":737},"archive",[705,1143,770],{"class":715},[705,1145,556],{"class":719},[705,1147,1148],{"class":715},"id)",[705,1150,1151],{"class":719},";",[705,1153,1154],{"class":902}," \u002F\u002F 204: no return value\n",[705,1156,1158,1160,1163,1165,1167,1169,1171,1173,1175,1178,1180,1182,1184],{"class":707,"line":1157},7,[705,1159,712],{"class":711},[705,1161,1162],{"class":715}," restored ",[705,1164,720],{"class":719},[705,1166,724],{"class":723},[705,1168,727],{"class":715},[705,1170,556],{"class":719},[705,1172,732],{"class":715},[705,1174,556],{"class":719},[705,1176,1177],{"class":737},"unarchive",[705,1179,770],{"class":715},[705,1181,556],{"class":719},[705,1183,1148],{"class":715},[705,1185,756],{"class":719},[705,1187,1189,1191,1194,1196,1198,1200,1202,1204,1206,1208,1210,1212,1215,1217,1221,1223,1225],{"class":707,"line":1188},8,[705,1190,712],{"class":711},[705,1192,1193],{"class":715}," all ",[705,1195,720],{"class":719},[705,1197,724],{"class":723},[705,1199,727],{"class":715},[705,1201,556],{"class":719},[705,1203,732],{"class":715},[705,1205,556],{"class":719},[705,1207,832],{"class":737},[705,1209,741],{"class":715},[705,1211,837],{"class":719},[705,1213,1214],{"class":840}," includeArchived",[705,1216,844],{"class":719},[705,1218,1220],{"class":1219},"sfNiH"," true",[705,1222,851],{"class":719},[705,1224,753],{"class":715},[705,1226,756],{"class":719},[471,1228,1229,1230,1233,1234,1237,1238,1240,1241,1244,1245,645,1247,1250,1251,556],{},"New prices are EUR-only. ",[524,1231,1232],{},"taxBehavior"," defaults to ",[524,1235,1236],{},"exclusive"," and is immutable.\nPlans sell ",[524,1239,997],{}," only; ",[524,1242,1243],{},"day"," intervals are test-mode-only. Creation and updates\nmay require approval; inspect ",[524,1246,635],{},[524,1248,1249],{},"pendingUpdates",", and ",[524,1252,1253],{},"updateStatus",[1255,1256,1257],"style",{},"html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}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 .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 .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 .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}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}",{"title":701,"searchDepth":759,"depth":759,"links":1259},[1260,1261,1262,1263],{"id":494,"depth":759,"text":495},{"id":688,"depth":759,"text":689},{"id":799,"depth":759,"text":800},{"id":925,"depth":759,"text":926},"Subscription plans define recurring products, prices, and billing intervals.","md",null,{},{"title":141},{"title":92,"description":1264},"rJnTXkRYlCvxbejcS95dOuISP5VaWGow3a4BuPlAeiw",[1272,1274],{"title":88,"path":259,"stem":260,"description":1273,"children":-1},"Subscriptions are recurring billing relationships.",{"title":96,"path":265,"stem":266,"description":1275,"children":-1},"Orders record checkout purchases and subscription renewals, including pending payments.",1794594929533]