[{"data":1,"prerenderedAt":1241},["ShallowReactive",2],{"navigation_docs":3,"-packages-python-subscriptionplans":465,"-packages-python-subscriptionplans-surround":1236},[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":141,"body":467,"description":1229,"extension":1230,"links":1231,"meta":1232,"navigation":1233,"path":339,"seo":1234,"stem":340,"__hash__":1235},"docs\u002F3.packages\u002F6.python\u002F05.subscriptionplans.md",{"type":468,"value":469,"toc":1225},"minimark",[470,483,488,752,875,891,895,1134,1145,1208,1221],[471,472,473,474,478,479,482],"p",{},"Plans define the recurring product, price and billing interval sold through a\n",[475,476,477],"a",{"href":333},"checkout",". A plan is not a customer's subscription.\nExamples accept the client from ",[475,480,481],{"href":324},"setup",".",[484,485,487],"h2",{"id":486},"create-a-monthly-plan","Create a monthly plan",[489,490,495],"pre",{"className":491,"code":492,"language":493,"meta":494,"style":494},"language-python shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","from vatly import VatlyClient\nfrom vatly.models import CreateSubscriptionPlanRequest\n\n\ndef example(client: VatlyClient):\n    return client.subscription_plans.create(\n        CreateSubscriptionPlanRequest(\n            name=\"Pro\",\n            description=\"Monthly access to Pro\",\n            base_price={\"value\": \"19.00\", \"currency\": \"EUR\"},\n            product_type=\"saas\",\n            interval=\"month\",\n            interval_count=1,\n        )\n    )\n","python","",[496,497,498,517,536,543,548,575,598,606,627,644,692,709,726,740,746],"code",{"__ignoreMap":494},[499,500,503,507,511,514],"span",{"class":501,"line":502},"line",1,[499,504,506],{"class":505},"s7zQu","from",[499,508,510],{"class":509},"sTEyZ"," vatly ",[499,512,513],{"class":505},"import",[499,515,516],{"class":509}," VatlyClient\n",[499,518,520,522,525,528,531,533],{"class":501,"line":519},2,[499,521,506],{"class":505},[499,523,524],{"class":509}," vatly",[499,526,482],{"class":527},"sMK4o",[499,529,530],{"class":509},"models ",[499,532,513],{"class":505},[499,534,535],{"class":509}," CreateSubscriptionPlanRequest\n",[499,537,539],{"class":501,"line":538},3,[499,540,542],{"emptyLinePlaceholder":541},true,"\n",[499,544,546],{"class":501,"line":545},4,[499,547,542],{"emptyLinePlaceholder":541},[499,549,551,555,559,562,566,569,572],{"class":501,"line":550},5,[499,552,554],{"class":553},"spNyl","def",[499,556,558],{"class":557},"s2Zo4"," example",[499,560,561],{"class":527},"(",[499,563,565],{"class":564},"sHdIc","client",[499,567,568],{"class":527},":",[499,570,571],{"class":509}," VatlyClient",[499,573,574],{"class":527},"):\n",[499,576,578,581,584,586,590,592,595],{"class":501,"line":577},6,[499,579,580],{"class":505},"    return",[499,582,583],{"class":509}," client",[499,585,482],{"class":527},[499,587,589],{"class":588},"swJcz","subscription_plans",[499,591,482],{"class":527},[499,593,594],{"class":557},"create",[499,596,597],{"class":527},"(\n",[499,599,601,604],{"class":501,"line":600},7,[499,602,603],{"class":557},"        CreateSubscriptionPlanRequest",[499,605,597],{"class":527},[499,607,609,612,615,618,622,624],{"class":501,"line":608},8,[499,610,611],{"class":564},"            name",[499,613,614],{"class":527},"=",[499,616,617],{"class":527},"\"",[499,619,621],{"class":620},"sfazB","Pro",[499,623,617],{"class":527},[499,625,626],{"class":527},",\n",[499,628,630,633,635,637,640,642],{"class":501,"line":629},9,[499,631,632],{"class":564},"            description",[499,634,614],{"class":527},[499,636,617],{"class":527},[499,638,639],{"class":620},"Monthly access to Pro",[499,641,617],{"class":527},[499,643,626],{"class":527},[499,645,647,650,653,655,658,660,662,665,668,670,673,675,678,680,682,684,687,689],{"class":501,"line":646},10,[499,648,649],{"class":564},"            base_price",[499,651,652],{"class":527},"={",[499,654,617],{"class":527},[499,656,657],{"class":620},"value",[499,659,617],{"class":527},[499,661,568],{"class":527},[499,663,664],{"class":527}," \"",[499,666,667],{"class":620},"19.00",[499,669,617],{"class":527},[499,671,672],{"class":527},",",[499,674,664],{"class":527},[499,676,677],{"class":620},"currency",[499,679,617],{"class":527},[499,681,568],{"class":527},[499,683,664],{"class":527},[499,685,686],{"class":620},"EUR",[499,688,617],{"class":527},[499,690,691],{"class":527},"},\n",[499,693,695,698,700,702,705,707],{"class":501,"line":694},11,[499,696,697],{"class":564},"            product_type",[499,699,614],{"class":527},[499,701,617],{"class":527},[499,703,704],{"class":620},"saas",[499,706,617],{"class":527},[499,708,626],{"class":527},[499,710,712,715,717,719,722,724],{"class":501,"line":711},12,[499,713,714],{"class":564},"            interval",[499,716,614],{"class":527},[499,718,617],{"class":527},[499,720,721],{"class":620},"month",[499,723,617],{"class":527},[499,725,626],{"class":527},[499,727,729,732,734,738],{"class":501,"line":728},13,[499,730,731],{"class":564},"            interval_count",[499,733,614],{"class":527},[499,735,737],{"class":736},"sbssI","1",[499,739,626],{"class":527},[499,741,743],{"class":501,"line":742},14,[499,744,745],{"class":527},"        )\n",[499,747,749],{"class":501,"line":748},15,[499,750,751],{"class":527},"    )\n",[753,754,755,771],"table",{},[756,757,758],"thead",{},[759,760,761,765,768],"tr",{},[762,763,764],"th",{},"Input field",[762,766,767],{},"Type",[762,769,770],{},"Required?",[772,773,774,792,807,821,844,856],"tbody",{},[759,775,776,786,789],{},[777,778,779,782,783],"td",{},[496,780,781],{},"name",", ",[496,784,785],{},"description",[777,787,788],{},"string",[777,790,791],{},"Yes",[759,793,794,799,805],{},[777,795,796],{},[496,797,798],{},"base_price",[777,800,801,802],{},"EUR money, e.g. ",[496,803,804],{},"{\"value\": \"19.00\", \"currency\": \"EUR\"}",[777,806,791],{},[759,808,809,814,819],{},[777,810,811],{},[496,812,813],{},"product_type",[777,815,816],{},[496,817,818],{},"\"saas\"",[777,820,791],{},[759,822,823,828,842],{},[777,824,825],{},[496,826,827],{},"interval",[777,829,830,782,833,782,836,782,839],{},[496,831,832],{},"\"day\"",[496,834,835],{},"\"week\"",[496,837,838],{},"\"month\"",[496,840,841],{},"\"year\"",[777,843,791],{},[759,845,846,851,854],{},[777,847,848],{},[496,849,850],{},"interval_count",[777,852,853],{},"positive integer",[777,855,791],{},[759,857,858,863,872],{},[777,859,860],{},[496,861,862],{},"tax_behavior",[777,864,865,868,869],{},[496,866,867],{},"\"exclusive\""," or ",[496,870,871],{},"\"inclusive\"",[777,873,874],{},"No",[471,876,877,878,782,881,626,884,887,888,482],{},"Use decimal strings, never floats, for money. The current creation contract uses\nEUR. Model fields are snake_case; dictionary inputs use ",[496,879,880],{},"basePrice",[496,882,883],{},"productType",[496,885,886],{},"intervalCount"," and ",[496,889,890],{},"taxBehavior",[484,892,894],{"id":893},"find-update-and-archive","Find, update and archive",[489,896,898],{"className":491,"code":897,"language":493,"meta":494,"style":494},"from vatly import VatlyClient\n\n\ndef example(client: VatlyClient):\n    plans = list(client.subscription_plans.list_all({\"includeArchived\": True, \"limit\": 25}))\n    plan = client.subscription_plans.get(\"subscription_plan_example\")\n    updated = client.subscription_plans.update(plan.id, {\"name\": \"Pro monthly\"})\n    client.subscription_plans.archive(updated.id)\n    restored = client.subscription_plans.unarchive(updated.id)\n    return plans, restored\n",[496,899,900,910,914,918,934,988,1018,1069,1094,1122],{"__ignoreMap":494},[499,901,902,904,906,908],{"class":501,"line":502},[499,903,506],{"class":505},[499,905,510],{"class":509},[499,907,513],{"class":505},[499,909,516],{"class":509},[499,911,912],{"class":501,"line":519},[499,913,542],{"emptyLinePlaceholder":541},[499,915,916],{"class":501,"line":538},[499,917,542],{"emptyLinePlaceholder":541},[499,919,920,922,924,926,928,930,932],{"class":501,"line":545},[499,921,554],{"class":553},[499,923,558],{"class":557},[499,925,561],{"class":527},[499,927,565],{"class":564},[499,929,568],{"class":527},[499,931,571],{"class":509},[499,933,574],{"class":527},[499,935,936,939,941,945,947,949,951,953,955,958,961,963,966,968,970,973,975,978,980,982,985],{"class":501,"line":550},[499,937,938],{"class":509},"    plans ",[499,940,614],{"class":527},[499,942,944],{"class":943},"sBMFI"," list",[499,946,561],{"class":527},[499,948,565],{"class":557},[499,950,482],{"class":527},[499,952,589],{"class":588},[499,954,482],{"class":527},[499,956,957],{"class":557},"list_all",[499,959,960],{"class":527},"({",[499,962,617],{"class":527},[499,964,965],{"class":620},"includeArchived",[499,967,617],{"class":527},[499,969,568],{"class":527},[499,971,972],{"class":527}," True,",[499,974,664],{"class":527},[499,976,977],{"class":620},"limit",[499,979,617],{"class":527},[499,981,568],{"class":527},[499,983,984],{"class":736}," 25",[499,986,987],{"class":527},"}))\n",[499,989,990,993,995,997,999,1001,1003,1006,1008,1010,1013,1015],{"class":501,"line":577},[499,991,992],{"class":509},"    plan ",[499,994,614],{"class":527},[499,996,583],{"class":509},[499,998,482],{"class":527},[499,1000,589],{"class":588},[499,1002,482],{"class":527},[499,1004,1005],{"class":557},"get",[499,1007,561],{"class":527},[499,1009,617],{"class":527},[499,1011,1012],{"class":620},"subscription_plan_example",[499,1014,617],{"class":527},[499,1016,1017],{"class":527},")\n",[499,1019,1020,1023,1025,1027,1029,1031,1033,1036,1038,1041,1043,1046,1048,1051,1053,1055,1057,1059,1061,1064,1066],{"class":501,"line":600},[499,1021,1022],{"class":509},"    updated ",[499,1024,614],{"class":527},[499,1026,583],{"class":509},[499,1028,482],{"class":527},[499,1030,589],{"class":588},[499,1032,482],{"class":527},[499,1034,1035],{"class":557},"update",[499,1037,561],{"class":527},[499,1039,1040],{"class":557},"plan",[499,1042,482],{"class":527},[499,1044,1045],{"class":588},"id",[499,1047,672],{"class":527},[499,1049,1050],{"class":527}," {",[499,1052,617],{"class":527},[499,1054,781],{"class":620},[499,1056,617],{"class":527},[499,1058,568],{"class":527},[499,1060,664],{"class":527},[499,1062,1063],{"class":620},"Pro monthly",[499,1065,617],{"class":527},[499,1067,1068],{"class":527},"})\n",[499,1070,1071,1074,1076,1078,1080,1083,1085,1088,1090,1092],{"class":501,"line":608},[499,1072,1073],{"class":509},"    client",[499,1075,482],{"class":527},[499,1077,589],{"class":588},[499,1079,482],{"class":527},[499,1081,1082],{"class":557},"archive",[499,1084,561],{"class":527},[499,1086,1087],{"class":557},"updated",[499,1089,482],{"class":527},[499,1091,1045],{"class":588},[499,1093,1017],{"class":527},[499,1095,1096,1099,1101,1103,1105,1107,1109,1112,1114,1116,1118,1120],{"class":501,"line":629},[499,1097,1098],{"class":509},"    restored ",[499,1100,614],{"class":527},[499,1102,583],{"class":509},[499,1104,482],{"class":527},[499,1106,589],{"class":588},[499,1108,482],{"class":527},[499,1110,1111],{"class":557},"unarchive",[499,1113,561],{"class":527},[499,1115,1087],{"class":557},[499,1117,482],{"class":527},[499,1119,1045],{"class":588},[499,1121,1017],{"class":527},[499,1123,1124,1126,1129,1131],{"class":501,"line":646},[499,1125,580],{"class":505},[499,1127,1128],{"class":509}," plans",[499,1130,672],{"class":527},[499,1132,1133],{"class":509}," restored\n",[471,1135,1136,1137,1140,1141,1144],{},"Archiving prevents new sales, not existing renewals. ",[496,1138,1139],{},"archive()"," returns None;\n",[496,1142,1143],{},"unarchive()"," returns the plan. Test changes are auto-approved; live changes may\nrequire approval.",[753,1146,1147,1157],{},[756,1148,1149],{},[759,1150,1151,1154],{},[762,1152,1153],{},"Response field",[762,1155,1156],{},"Meaning",[772,1158,1159,1171,1184,1195],{},[759,1160,1161,1165],{},[777,1162,1163],{},[496,1164,1045],{},[777,1166,1167,1170],{},[496,1168,1169],{},"subscription_plan_..."," catalog ID",[759,1172,1173,1181],{},[777,1174,1175,782,1177,782,1179],{},[496,1176,781],{},[496,1178,785],{},[496,1180,798],{},[777,1182,1183],{},"Product and price",[759,1185,1186,1192],{},[777,1187,1188,782,1190],{},[496,1189,827],{},[496,1191,850],{},[777,1193,1194],{},"Billing cadence",[759,1196,1197,1205],{},[777,1198,1199,782,1202],{},[496,1200,1201],{},"testmode",[496,1203,1204],{},"links",[777,1206,1207],{},"Mode and resource links",[471,1209,1210,1216,1217],{},[475,1211,1215],{"href":1212,"rel":1213},"https:\u002F\u002Fdocs.vatly.com\u002Fapi-reference\u002Fsubscription-plans",[1214],"nofollow","Plan API reference"," · ",[475,1218,1220],{"href":1219},"\u002Fpackages\u002Fpython\u002Fapi#subscription_plans","All methods",[1222,1223,1224],"style",{},"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 .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 .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}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 .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 .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}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 .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}",{"title":494,"searchDepth":519,"depth":519,"links":1226},[1227,1228],{"id":486,"depth":519,"text":487},{"id":893,"depth":519,"text":894},"Plans define the recurring product, price and billing interval sold through a checkout.","md",null,{},{"title":141},{"title":141,"description":1229},"-Q5URYIxSX4g-ijHIHShGGTu9uxUFVLySSgWVuS35Eo",[1237,1239],{"title":88,"path":336,"stem":337,"description":1238,"children":-1},"A paid checkout containing a subscription plan starts recurring billing.",{"title":96,"path":342,"stem":343,"description":1240,"children":-1},"Orders contain purchased lines, tax and financial totals.",1794594931617]