[{"data":1,"prerenderedAt":1242},["ShallowReactive",2],{"navigation_docs":3,"-packages-python-subscriptions":465,"-packages-python-subscriptions-surround":1237},[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":88,"body":467,"description":1230,"extension":1231,"links":1232,"meta":1233,"navigation":1234,"path":336,"seo":1235,"stem":337,"__hash__":1236},"docs\u002F3.packages\u002F6.python\u002F04.subscriptions.md",{"type":468,"value":469,"toc":1226},"minimark",[470,484,489,734,741,812,816,819,897,900,964,1102,1112,1200,1210,1222],[471,472,473,474,478,479,483],"p",{},"A paid checkout containing a subscription plan starts recurring billing. There is\nno direct ",[475,476,477],"code",{},"subscriptions.create()",". Read and manage the resulting subscription ID\nafter establishing who owns it. Examples use the client from ",[480,481,482],"a",{"href":324},"setup",".",[485,486,488],"h2",{"id":487},"read-and-change-a-subscription","Read and change a subscription",[490,491,496],"pre",{"className":492,"code":493,"language":494,"meta":495,"style":495},"language-python shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","from vatly import RequestOptions, VatlyClient\n\n\ndef example(client: VatlyClient):\n    subscription = client.subscriptions.get(\"subscription_example\")\n    changed = client.subscriptions.update(\n        subscription.id,\n        {\"subscriptionPlanId\": \"subscription_plan_pro\", \"quantity\": 2},\n        options=RequestOptions(idempotency_key=\"plan-change:42\"),\n    )\n    return changed.status, changed.scheduled_update\n","python","",[475,497,498,524,531,536,563,600,622,636,677,705,711],{"__ignoreMap":495},[499,500,503,507,511,514,517,521],"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}," RequestOptions",[499,518,520],{"class":519},"sMK4o",",",[499,522,523],{"class":509}," VatlyClient\n",[499,525,527],{"class":501,"line":526},2,[499,528,530],{"emptyLinePlaceholder":529},true,"\n",[499,532,534],{"class":501,"line":533},3,[499,535,530],{"emptyLinePlaceholder":529},[499,537,539,543,547,550,554,557,560],{"class":501,"line":538},4,[499,540,542],{"class":541},"spNyl","def",[499,544,546],{"class":545},"s2Zo4"," example",[499,548,549],{"class":519},"(",[499,551,553],{"class":552},"sHdIc","client",[499,555,556],{"class":519},":",[499,558,559],{"class":509}," VatlyClient",[499,561,562],{"class":519},"):\n",[499,564,566,569,572,575,577,581,583,586,588,591,595,597],{"class":501,"line":565},5,[499,567,568],{"class":509},"    subscription ",[499,570,571],{"class":519},"=",[499,573,574],{"class":509}," client",[499,576,483],{"class":519},[499,578,580],{"class":579},"swJcz","subscriptions",[499,582,483],{"class":519},[499,584,585],{"class":545},"get",[499,587,549],{"class":519},[499,589,590],{"class":519},"\"",[499,592,594],{"class":593},"sfazB","subscription_example",[499,596,590],{"class":519},[499,598,599],{"class":519},")\n",[499,601,603,606,608,610,612,614,616,619],{"class":501,"line":602},6,[499,604,605],{"class":509},"    changed ",[499,607,571],{"class":519},[499,609,574],{"class":509},[499,611,483],{"class":519},[499,613,580],{"class":579},[499,615,483],{"class":519},[499,617,618],{"class":545},"update",[499,620,621],{"class":519},"(\n",[499,623,625,628,630,633],{"class":501,"line":624},7,[499,626,627],{"class":545},"        subscription",[499,629,483],{"class":519},[499,631,632],{"class":579},"id",[499,634,635],{"class":519},",\n",[499,637,639,642,644,647,649,651,654,657,659,661,663,666,668,670,674],{"class":501,"line":638},8,[499,640,641],{"class":519},"        {",[499,643,590],{"class":519},[499,645,646],{"class":593},"subscriptionPlanId",[499,648,590],{"class":519},[499,650,556],{"class":519},[499,652,653],{"class":519}," \"",[499,655,656],{"class":593},"subscription_plan_pro",[499,658,590],{"class":519},[499,660,520],{"class":519},[499,662,653],{"class":519},[499,664,665],{"class":593},"quantity",[499,667,590],{"class":519},[499,669,556],{"class":519},[499,671,673],{"class":672},"sbssI"," 2",[499,675,676],{"class":519},"},\n",[499,678,680,683,685,688,690,693,695,697,700,702],{"class":501,"line":679},9,[499,681,682],{"class":552},"        options",[499,684,571],{"class":519},[499,686,687],{"class":545},"RequestOptions",[499,689,549],{"class":519},[499,691,692],{"class":552},"idempotency_key",[499,694,571],{"class":519},[499,696,590],{"class":519},[499,698,699],{"class":593},"plan-change:42",[499,701,590],{"class":519},[499,703,704],{"class":519},"),\n",[499,706,708],{"class":501,"line":707},10,[499,709,710],{"class":519},"    )\n",[499,712,714,717,720,722,725,727,729,731],{"class":501,"line":713},11,[499,715,716],{"class":505},"    return",[499,718,719],{"class":509}," changed",[499,721,483],{"class":519},[499,723,724],{"class":579},"status",[499,726,520],{"class":519},[499,728,719],{"class":509},[499,730,483],{"class":519},[499,732,733],{"class":579},"scheduled_update\n",[471,735,736,737,740],{},"Changes are scheduled by default. Inspect ",[475,738,739],{},"scheduled_update","; do not immediately\nreplace the active plan in your application.",[742,743,744,757],"table",{},[745,746,747],"thead",{},[748,749,750,754],"tr",{},[751,752,753],"th",{},"Update parameter (wire key)",[751,755,756],{},"Purpose",[758,759,760,776,786,802],"tbody",{},[748,761,762,773],{},[763,764,765,767,768,767,770],"td",{},[475,766,646],{},", ",[475,769,665],{},[475,771,772],{},"price",[763,774,775],{},"Send at least one to request a change",[748,777,778,783],{},[763,779,780],{},[475,781,782],{},"applyImmediately",[763,784,785],{},"Apply now instead of scheduling",[748,787,788,799],{},[763,789,790,767,793,767,796],{},[475,791,792],{},"invoiceImmediately",[475,794,795],{},"prorate",[475,797,798],{},"prorationCharge",[763,800,801],{},"Explicit invoicing\u002Fproration choices",[748,803,804,809],{},[763,805,806],{},[475,807,808],{},"trialUntil",[763,810,811],{},"Optional aware datetime; cannot be the sole change",[485,813,815],{"id":814},"cancel-resume-and-update-billing-details","Cancel, resume and update billing details",[471,817,818],{},"These are separate user actions. Only resume during a valid grace period.",[490,820,822],{"className":492,"code":821,"language":494,"meta":495,"style":495},"from vatly import VatlyClient\n\n\ndef example(client: VatlyClient):\n    client.subscriptions.cancel(\"subscription_example\", {\"immediately\": False})\n",[475,823,824,834,838,842,858],{"__ignoreMap":495},[499,825,826,828,830,832],{"class":501,"line":502},[499,827,506],{"class":505},[499,829,510],{"class":509},[499,831,513],{"class":505},[499,833,523],{"class":509},[499,835,836],{"class":501,"line":526},[499,837,530],{"emptyLinePlaceholder":529},[499,839,840],{"class":501,"line":533},[499,841,530],{"emptyLinePlaceholder":529},[499,843,844,846,848,850,852,854,856],{"class":501,"line":538},[499,845,542],{"class":541},[499,847,546],{"class":545},[499,849,549],{"class":519},[499,851,553],{"class":552},[499,853,556],{"class":519},[499,855,559],{"class":509},[499,857,562],{"class":519},[499,859,860,863,865,867,869,872,874,876,878,880,882,885,887,890,892,894],{"class":501,"line":565},[499,861,862],{"class":509},"    client",[499,864,483],{"class":519},[499,866,580],{"class":579},[499,868,483],{"class":519},[499,870,871],{"class":545},"cancel",[499,873,549],{"class":519},[499,875,590],{"class":519},[499,877,594],{"class":593},[499,879,590],{"class":519},[499,881,520],{"class":519},[499,883,884],{"class":519}," {",[499,886,590],{"class":519},[499,888,889],{"class":593},"immediately",[499,891,590],{"class":519},[499,893,556],{"class":519},[499,895,896],{"class":519}," False})\n",[471,898,899],{},"For a later, separate resume request:",[490,901,903],{"className":492,"code":902,"language":494,"meta":495,"style":495},"from vatly import VatlyClient\n\n\ndef example(client: VatlyClient):\n    return client.subscriptions.resume(\"subscription_example\")\n",[475,904,905,915,919,923,939],{"__ignoreMap":495},[499,906,907,909,911,913],{"class":501,"line":502},[499,908,506],{"class":505},[499,910,510],{"class":509},[499,912,513],{"class":505},[499,914,523],{"class":509},[499,916,917],{"class":501,"line":526},[499,918,530],{"emptyLinePlaceholder":529},[499,920,921],{"class":501,"line":533},[499,922,530],{"emptyLinePlaceholder":529},[499,924,925,927,929,931,933,935,937],{"class":501,"line":538},[499,926,542],{"class":541},[499,928,546],{"class":545},[499,930,549],{"class":519},[499,932,553],{"class":552},[499,934,556],{"class":519},[499,936,559],{"class":509},[499,938,562],{"class":519},[499,940,941,943,945,947,949,951,954,956,958,960,962],{"class":501,"line":565},[499,942,716],{"class":505},[499,944,574],{"class":509},[499,946,483],{"class":519},[499,948,580],{"class":579},[499,950,483],{"class":519},[499,952,953],{"class":545},"resume",[499,955,549],{"class":519},[499,957,590],{"class":519},[499,959,594],{"class":593},[499,961,590],{"class":519},[499,963,599],{"class":519},[490,965,967],{"className":492,"code":966,"language":494,"meta":495,"style":495},"from vatly import VatlyClient\n\n\ndef example(client: VatlyClient):\n    link = client.subscriptions.create_billing_update_link(\n        \"subscription_example\",\n        {\n            \"redirectUrlSuccess\": \"https:\u002F\u002Fapp.example.com\u002Fbilling\u002Fsuccess\",\n            \"redirectUrlCanceled\": \"https:\u002F\u002Fapp.example.com\u002Fbilling\u002Fcanceled\",\n        },\n    )\n    return link.href\n",[475,968,969,979,983,987,1003,1023,1034,1039,1060,1080,1085,1089],{"__ignoreMap":495},[499,970,971,973,975,977],{"class":501,"line":502},[499,972,506],{"class":505},[499,974,510],{"class":509},[499,976,513],{"class":505},[499,978,523],{"class":509},[499,980,981],{"class":501,"line":526},[499,982,530],{"emptyLinePlaceholder":529},[499,984,985],{"class":501,"line":533},[499,986,530],{"emptyLinePlaceholder":529},[499,988,989,991,993,995,997,999,1001],{"class":501,"line":538},[499,990,542],{"class":541},[499,992,546],{"class":545},[499,994,549],{"class":519},[499,996,553],{"class":552},[499,998,556],{"class":519},[499,1000,559],{"class":509},[499,1002,562],{"class":519},[499,1004,1005,1008,1010,1012,1014,1016,1018,1021],{"class":501,"line":565},[499,1006,1007],{"class":509},"    link ",[499,1009,571],{"class":519},[499,1011,574],{"class":509},[499,1013,483],{"class":519},[499,1015,580],{"class":579},[499,1017,483],{"class":519},[499,1019,1020],{"class":545},"create_billing_update_link",[499,1022,621],{"class":519},[499,1024,1025,1028,1030,1032],{"class":501,"line":602},[499,1026,1027],{"class":519},"        \"",[499,1029,594],{"class":593},[499,1031,590],{"class":519},[499,1033,635],{"class":519},[499,1035,1036],{"class":501,"line":624},[499,1037,1038],{"class":519},"        {\n",[499,1040,1041,1044,1047,1049,1051,1053,1056,1058],{"class":501,"line":638},[499,1042,1043],{"class":519},"            \"",[499,1045,1046],{"class":593},"redirectUrlSuccess",[499,1048,590],{"class":519},[499,1050,556],{"class":519},[499,1052,653],{"class":519},[499,1054,1055],{"class":593},"https:\u002F\u002Fapp.example.com\u002Fbilling\u002Fsuccess",[499,1057,590],{"class":519},[499,1059,635],{"class":519},[499,1061,1062,1064,1067,1069,1071,1073,1076,1078],{"class":501,"line":679},[499,1063,1043],{"class":519},[499,1065,1066],{"class":593},"redirectUrlCanceled",[499,1068,590],{"class":519},[499,1070,556],{"class":519},[499,1072,653],{"class":519},[499,1074,1075],{"class":593},"https:\u002F\u002Fapp.example.com\u002Fbilling\u002Fcanceled",[499,1077,590],{"class":519},[499,1079,635],{"class":519},[499,1081,1082],{"class":501,"line":707},[499,1083,1084],{"class":519},"        },\n",[499,1086,1087],{"class":501,"line":713},[499,1088,710],{"class":519},[499,1090,1092,1094,1097,1099],{"class":501,"line":1091},12,[499,1093,716],{"class":505},[499,1095,1096],{"class":509}," link",[499,1098,483],{"class":519},[499,1100,1101],{"class":579},"href\n",[471,1103,1104,1105,1108,1109,1111],{},"Cancellation returns None; resume returns a Subscription. Set ",[475,1106,1107],{},"immediately=True","\nonly when the user intends immediate cancellation. Reuse business idempotency\nkeys with ",[475,1110,687],{}," when retrying mutations.",[742,1113,1114,1124],{},[745,1115,1116],{},[748,1117,1118,1121],{},[751,1119,1120],{},"Response field",[751,1122,1123],{},"Meaning",[758,1125,1126,1135,1150,1165,1175,1191],{},[748,1127,1128,1132],{},[763,1129,1130],{},[475,1131,724],{},[763,1133,1134],{},"Current lifecycle state; inspect it before granting access",[748,1136,1137,1147],{},[763,1138,1139,767,1142,767,1145],{},[475,1140,1141],{},"customer_id",[475,1143,1144],{},"subscription_plan_id",[475,1146,665],{},[763,1148,1149],{},"Billing identity and current purchase",[748,1151,1152,1157],{},[763,1153,1154],{},[475,1155,1156],{},"canceled_at",[763,1158,1159,1160,1164],{},"Cancellation ",[1161,1162,1163],"strong",{},"request"," time, not grace expiry",[748,1166,1167,1172],{},[763,1168,1169],{},[475,1170,1171],{},"ended_at",[763,1173,1174],{},"Actual end when present",[748,1176,1177,1188],{},[763,1178,1179,767,1182,767,1185],{},[475,1180,1181],{},"next_renewal_at",[475,1183,1184],{},"renewed_until",[475,1186,1187],{},"trial_until",[763,1189,1190],{},"Period information; nullable",[748,1192,1193,1197],{},[763,1194,1195],{},[475,1196,739],{},[763,1198,1199],{},"Pending changes or None",[471,1201,1202,1203,1209],{},"Do not infer a subscription ID from a plan ID. Initial order lines can still\nreference plans; this alpha does not consume the proposed related-resources\nsubscription reference. ",[480,1204,1208],{"href":1205,"rel":1206},"https:\u002F\u002Fdocs.vatly.com\u002Fpackages\u002Ffluent-python\u002Fsubscriptions",[1207],"nofollow","Fluent's guide","\nexplains recovery and expiry limits.",[471,1211,1212,1217,1218],{},[480,1213,1216],{"href":1214,"rel":1215},"https:\u002F\u002Fdocs.vatly.com\u002Fapi-reference\u002Fsubscriptions",[1207],"Subscription API reference"," · ",[480,1219,1221],{"href":1220},"\u002Fpackages\u002Fpython\u002Fapi#subscriptions","All methods",[1223,1224,1225],"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);}",{"title":495,"searchDepth":526,"depth":526,"links":1227},[1228,1229],{"id":487,"depth":526,"text":488},{"id":814,"depth":526,"text":815},"A paid checkout containing a subscription plan starts recurring billing.","md",null,{},{"title":88},{"title":88,"description":1230},"F2tEFHvBidh0TT5pJIKzxwgSFQF4pP3q6wZYvNr9xK0",[1238,1240],{"title":80,"path":333,"stem":334,"description":1239,"children":-1},"Create a hosted payment page and redirect your buyer to it.",{"title":141,"path":339,"stem":340,"description":1241,"children":-1},"Plans define the recurring product, price and billing interval sold through a checkout.",1794594931541]