[{"data":1,"prerenderedAt":1763},["ShallowReactive",2],{"navigation_docs":3,"-guides-plans-and-pricing":132,"-guides-plans-and-pricing-surround":1758},[4,30,47,128],{"title":5,"path":6,"stem":7,"children":8,"page":29},"Getting Started","\u002Fgetting-started","1.getting-started",[9,13,17,21,25],{"title":10,"path":11,"stem":12},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction",{"title":14,"path":15,"stem":16},"Quickstart","\u002Fgetting-started\u002Fquickstart","1.getting-started\u002F2.quickstart",{"title":18,"path":19,"stem":20},"Authentication","\u002Fgetting-started\u002Fauthentication","1.getting-started\u002F3.authentication",{"title":22,"path":23,"stem":24},"Self-Hosting","\u002Fgetting-started\u002Fself-hosting","1.getting-started\u002F4.self-hosting",{"title":26,"path":27,"stem":28},"Build an Integration","\u002Fgetting-started\u002Fbuild-an-integration","1.getting-started\u002F5.build-an-integration",false,{"title":31,"path":32,"stem":33,"children":34,"page":29},"Sdks","\u002Fsdks","2.sdks",[35,39,43],{"title":36,"path":37,"stem":38},"TypeScript SDK","\u002Fsdks\u002Ftypescript","2.sdks\u002F1.typescript",{"title":40,"path":41,"stem":42},"Python SDK","\u002Fsdks\u002Fpython","2.sdks\u002F2.python",{"title":44,"path":45,"stem":46},"PHP SDK","\u002Fsdks\u002Fphp","2.sdks\u002F3.php",{"title":48,"path":49,"stem":50,"children":51,"page":29},"Guides","\u002Fguides","3.guides",[52,56,60,64,68,72,76,80,84,88,92,96,100,104,108,112,116,120,124],{"title":53,"path":54,"stem":55},"Customers","\u002Fguides\u002Fcustomers","3.guides\u002F1.customers",{"title":57,"path":58,"stem":59},"Usage-Based Billing","\u002Fguides\u002Fusage-billing","3.guides\u002F10.usage-billing",{"title":61,"path":62,"stem":63},"Wallets","\u002Fguides\u002Fwallets","3.guides\u002F11.wallets",{"title":65,"path":66,"stem":67},"Coupons, Add-ons and Credit Notes","\u002Fguides\u002Fcoupons-add-ons-credit-notes","3.guides\u002F12.coupons-add-ons-credit-notes",{"title":69,"path":70,"stem":71},"Taxes","\u002Fguides\u002Ftaxes","3.guides\u002F13.taxes",{"title":73,"path":74,"stem":75},"Customer Portal","\u002Fguides\u002Fcustomer-portal","3.guides\u002F14.customer-portal",{"title":77,"path":78,"stem":79},"Ledger","\u002Fguides\u002Fledger","3.guides\u002F15.ledger",{"title":81,"path":82,"stem":83},"Plan Limits and Access","\u002Fguides\u002Fplan-limits-and-access","3.guides\u002F16.plan-limits-and-access",{"title":85,"path":86,"stem":87},"Currencies and Exchange Rates","\u002Fguides\u002Fcurrencies","3.guides\u002F17.currencies",{"title":89,"path":90,"stem":91},"Charge a Customer","\u002Fguides\u002Fcharge-a-customer","3.guides\u002F18.charge-a-customer",{"title":93,"path":94,"stem":95},"One-time Products & Partial Payments","\u002Fguides\u002Fone-time-products-and-partial-payments","3.guides\u002F19.one-time-products-and-partial-payments",{"title":97,"path":98,"stem":99},"Plans & Pricing","\u002Fguides\u002Fplans-and-pricing","3.guides\u002F2.plans-and-pricing",{"title":101,"path":102,"stem":103},"Subscriptions","\u002Fguides\u002Fsubscriptions","3.guides\u002F3.subscriptions",{"title":105,"path":106,"stem":107},"Invoices & Payments","\u002Fguides\u002Finvoices-and-payments","3.guides\u002F4.invoices-and-payments",{"title":109,"path":110,"stem":111},"Payment Providers","\u002Fguides\u002Fpayment-providers","3.guides\u002F5.payment-providers",{"title":113,"path":114,"stem":115},"Analytics","\u002Fguides\u002Fanalytics","3.guides\u002F6.analytics",{"title":117,"path":118,"stem":119},"Webhooks","\u002Fguides\u002Fwebhooks","3.guides\u002F7.webhooks",{"title":121,"path":122,"stem":123},"Sandbox","\u002Fguides\u002Fsandbox","3.guides\u002F8.sandbox",{"title":125,"path":126,"stem":127},"Money Movement","\u002Fguides\u002Fmoney-movement","3.guides\u002F9.money-movement",{"title":129,"path":130,"stem":131},"API Reference","\u002Fapi-reference","4.api-reference",{"id":133,"title":97,"body":134,"description":1752,"extension":1753,"links":1754,"meta":1755,"navigation":468,"path":98,"seo":1756,"stem":99,"__hash__":1757},"docs\u002F3.guides\u002F2.plans-and-pricing.md",{"type":135,"value":136,"toc":1738},"minimark",[137,141,146,275,279,284,791,795,798,1024,1028,1031,1035,1170,1174,1226,1230,1233,1491,1495,1499,1511,1701,1705,1734],[138,139,140],"p",{},"Plans define the products or services you offer to customers along with their pricing, billing frequency, and included features. PimaBill supports multi-currency pricing and flexible billing intervals.",[142,143,145],"h2",{"id":144},"plan-object","Plan Object",[147,148,149,165],"table",{},[150,151,152],"thead",{},[153,154,155,159,162],"tr",{},[156,157,158],"th",{},"Field",[156,160,161],{},"Type",[156,163,164],{},"Description",[166,167,168,187,199,213,235,250,263],"tbody",{},[153,169,170,177,180],{},[171,172,173],"td",{},[174,175,176],"code",{},"id",[171,178,179],{},"string",[171,181,182,183,186],{},"Unique identifier (e.g., ",[174,184,185],{},"plan_abc123",")",[153,188,189,194,196],{},[171,190,191],{},[174,192,193],{},"name",[171,195,179],{},[171,197,198],{},"Display name for the plan",[153,200,201,205,207],{},[171,202,203],{},[174,204,174],{},[171,206,179],{},[171,208,209,210,186],{},"Unique code for the plan (e.g., ",[174,211,212],{},"pro",[153,214,215,220,222],{},[171,216,217],{},[174,218,219],{},"billingInterval",[171,221,179],{},[171,223,224,225,228,229,228,232],{},"Billing frequency: ",[174,226,227],{},"MONTHLY",", ",[174,230,231],{},"QUARTERLY",[174,233,234],{},"YEARLY",[153,236,237,242,247],{},[171,238,239],{},[174,240,241],{},"features",[171,243,179,244],{},[245,246],"span",{},[171,248,249],{},"List of features included in the plan",[153,251,252,257,260],{},[171,253,254],{},[174,255,256],{},"isActive",[171,258,259],{},"boolean",[171,261,262],{},"Whether the plan is available for new subscriptions",[153,264,265,270,272],{},[171,266,267],{},[174,268,269],{},"createdAt",[171,271,179],{},[171,273,274],{},"ISO 8601 creation timestamp",[142,276,278],{"id":277},"creating-plans","Creating Plans",[280,281,283],"h3",{"id":282},"basic-plan","Basic Plan",[285,286,288,427,702],"code-group",{"sync":287},"lang",[289,290,296],"pre",{"className":291,"code":292,"filename":293,"language":294,"meta":295,"style":295},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fplans \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -H \"Authorization: Bearer sk_live_a1b2c3d4...\" \\\n  -d '{\n    \"name\": \"Starter\",\n    \"code\": \"starter\",\n    \"billingInterval\": \"MONTHLY\",\n    \"features\": [\n      \"5 projects\",\n      \"10 team members\",\n      \"Email support\",\n      \"1 GB storage\"\n    ]\n  }'\n","cURL","bash","",[174,297,298,320,338,352,364,370,376,382,388,394,400,406,412,418],{"__ignoreMap":295},[245,299,302,306,310,313,316],{"class":300,"line":301},"line",1,[245,303,305],{"class":304},"sBMFI","curl",[245,307,309],{"class":308},"sfazB"," -X",[245,311,312],{"class":308}," POST",[245,314,315],{"class":308}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fplans",[245,317,319],{"class":318},"sTEyZ"," \\\n",[245,321,323,326,330,333,336],{"class":300,"line":322},2,[245,324,325],{"class":308},"  -H",[245,327,329],{"class":328},"sMK4o"," \"",[245,331,332],{"class":308},"Content-Type: application\u002Fjson",[245,334,335],{"class":328},"\"",[245,337,319],{"class":318},[245,339,341,343,345,348,350],{"class":300,"line":340},3,[245,342,325],{"class":308},[245,344,329],{"class":328},[245,346,347],{"class":308},"Authorization: Bearer sk_live_a1b2c3d4...",[245,349,335],{"class":328},[245,351,319],{"class":318},[245,353,355,358,361],{"class":300,"line":354},4,[245,356,357],{"class":308},"  -d",[245,359,360],{"class":328}," '",[245,362,363],{"class":308},"{\n",[245,365,367],{"class":300,"line":366},5,[245,368,369],{"class":308},"    \"name\": \"Starter\",\n",[245,371,373],{"class":300,"line":372},6,[245,374,375],{"class":308},"    \"code\": \"starter\",\n",[245,377,379],{"class":300,"line":378},7,[245,380,381],{"class":308},"    \"billingInterval\": \"MONTHLY\",\n",[245,383,385],{"class":300,"line":384},8,[245,386,387],{"class":308},"    \"features\": [\n",[245,389,391],{"class":300,"line":390},9,[245,392,393],{"class":308},"      \"5 projects\",\n",[245,395,397],{"class":300,"line":396},10,[245,398,399],{"class":308},"      \"10 team members\",\n",[245,401,403],{"class":300,"line":402},11,[245,404,405],{"class":308},"      \"Email support\",\n",[245,407,409],{"class":300,"line":408},12,[245,410,411],{"class":308},"      \"1 GB storage\"\n",[245,413,415],{"class":300,"line":414},13,[245,416,417],{"class":308},"    ]\n",[245,419,421,424],{"class":300,"line":420},14,[245,422,423],{"class":308},"  }",[245,425,426],{"class":328},"'\n",[289,428,433],{"className":429,"code":430,"filename":431,"language":432,"meta":295,"style":295},"language-typescript shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","import { PimaBillClient } from 'pimabill';\n\nconst client = new PimaBillClient({ token: 'sk_live_a1b2c3d4...' });\n\nconst starter = await client.plans.create({\n  name: 'Starter',\n  code: 'starter',\n  billingInterval: 'MONTHLY',\n  features: [\n    '5 projects',\n    '10 team members',\n    'Email support',\n    '1 GB storage'\n  ]\n});\n\nconsole.log('Plan ID:', starter.id);\n","TypeScript","typescript",[174,434,435,464,470,514,518,548,565,581,596,606,618,629,640,649,654,664,669],{"__ignoreMap":295},[245,436,437,441,444,447,450,453,455,458,461],{"class":300,"line":301},[245,438,440],{"class":439},"s7zQu","import",[245,442,443],{"class":328}," {",[245,445,446],{"class":318}," PimaBillClient",[245,448,449],{"class":328}," }",[245,451,452],{"class":439}," from",[245,454,360],{"class":328},[245,456,457],{"class":308},"pimabill",[245,459,460],{"class":328},"'",[245,462,463],{"class":328},";\n",[245,465,466],{"class":300,"line":322},[245,467,469],{"emptyLinePlaceholder":468},true,"\n",[245,471,472,476,479,482,485,488,491,494,498,501,503,506,508,510,512],{"class":300,"line":340},[245,473,475],{"class":474},"spNyl","const",[245,477,478],{"class":318}," client ",[245,480,481],{"class":328},"=",[245,483,484],{"class":328}," new",[245,486,446],{"class":487},"s2Zo4",[245,489,490],{"class":318},"(",[245,492,493],{"class":328},"{",[245,495,497],{"class":496},"swJcz"," token",[245,499,500],{"class":328},":",[245,502,360],{"class":328},[245,504,505],{"class":308},"sk_live_a1b2c3d4...",[245,507,460],{"class":328},[245,509,449],{"class":328},[245,511,186],{"class":318},[245,513,463],{"class":328},[245,515,516],{"class":300,"line":354},[245,517,469],{"emptyLinePlaceholder":468},[245,519,520,522,525,527,530,533,536,539,541,544,546],{"class":300,"line":366},[245,521,475],{"class":474},[245,523,524],{"class":318}," starter ",[245,526,481],{"class":328},[245,528,529],{"class":439}," await",[245,531,532],{"class":318}," client",[245,534,535],{"class":328},".",[245,537,538],{"class":318},"plans",[245,540,535],{"class":328},[245,542,543],{"class":487},"create",[245,545,490],{"class":318},[245,547,363],{"class":328},[245,549,550,553,555,557,560,562],{"class":300,"line":372},[245,551,552],{"class":496},"  name",[245,554,500],{"class":328},[245,556,360],{"class":328},[245,558,559],{"class":308},"Starter",[245,561,460],{"class":328},[245,563,564],{"class":328},",\n",[245,566,567,570,572,574,577,579],{"class":300,"line":378},[245,568,569],{"class":496},"  code",[245,571,500],{"class":328},[245,573,360],{"class":328},[245,575,576],{"class":308},"starter",[245,578,460],{"class":328},[245,580,564],{"class":328},[245,582,583,586,588,590,592,594],{"class":300,"line":384},[245,584,585],{"class":496},"  billingInterval",[245,587,500],{"class":328},[245,589,360],{"class":328},[245,591,227],{"class":308},[245,593,460],{"class":328},[245,595,564],{"class":328},[245,597,598,601,603],{"class":300,"line":390},[245,599,600],{"class":496},"  features",[245,602,500],{"class":328},[245,604,605],{"class":318}," [\n",[245,607,608,611,614,616],{"class":300,"line":396},[245,609,610],{"class":328},"    '",[245,612,613],{"class":308},"5 projects",[245,615,460],{"class":328},[245,617,564],{"class":328},[245,619,620,622,625,627],{"class":300,"line":402},[245,621,610],{"class":328},[245,623,624],{"class":308},"10 team members",[245,626,460],{"class":328},[245,628,564],{"class":328},[245,630,631,633,636,638],{"class":300,"line":408},[245,632,610],{"class":328},[245,634,635],{"class":308},"Email support",[245,637,460],{"class":328},[245,639,564],{"class":328},[245,641,642,644,647],{"class":300,"line":414},[245,643,610],{"class":328},[245,645,646],{"class":308},"1 GB storage",[245,648,426],{"class":328},[245,650,651],{"class":300,"line":420},[245,652,653],{"class":318},"  ]\n",[245,655,657,660,662],{"class":300,"line":656},15,[245,658,659],{"class":328},"}",[245,661,186],{"class":318},[245,663,463],{"class":328},[245,665,667],{"class":300,"line":666},16,[245,668,469],{"emptyLinePlaceholder":468},[245,670,672,675,677,680,682,684,687,689,692,695,697,700],{"class":300,"line":671},17,[245,673,674],{"class":318},"console",[245,676,535],{"class":328},[245,678,679],{"class":487},"log",[245,681,490],{"class":318},[245,683,460],{"class":328},[245,685,686],{"class":308},"Plan ID:",[245,688,460],{"class":328},[245,690,691],{"class":328},",",[245,693,694],{"class":318}," starter",[245,696,535],{"class":328},[245,698,699],{"class":318},"id)",[245,701,463],{"class":328},[289,703,708],{"className":704,"code":705,"filename":706,"language":707,"meta":295,"style":295},"language-python shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","from pimabill import PimaBillClient\n\nclient = PimaBillClient(token=\"sk_live_a1b2c3d4...\")\n\nstarter = client.plans.create(\n    name=\"Starter\",\n    code=\"starter\",\n    billing_interval=\"MONTHLY\",\n    features=[\n        \"5 projects\",\n        \"10 team members\",\n        \"Email support\",\n        \"1 GB storage\"\n    ]\n)\n\nprint(f\"Plan ID: {starter.id}\")\n","Python","python",[174,709,710,715,719,724,728,733,738,743,748,753,758,763,768,773,777,782,786],{"__ignoreMap":295},[245,711,712],{"class":300,"line":301},[245,713,714],{},"from pimabill import PimaBillClient\n",[245,716,717],{"class":300,"line":322},[245,718,469],{"emptyLinePlaceholder":468},[245,720,721],{"class":300,"line":340},[245,722,723],{},"client = PimaBillClient(token=\"sk_live_a1b2c3d4...\")\n",[245,725,726],{"class":300,"line":354},[245,727,469],{"emptyLinePlaceholder":468},[245,729,730],{"class":300,"line":366},[245,731,732],{},"starter = client.plans.create(\n",[245,734,735],{"class":300,"line":372},[245,736,737],{},"    name=\"Starter\",\n",[245,739,740],{"class":300,"line":378},[245,741,742],{},"    code=\"starter\",\n",[245,744,745],{"class":300,"line":384},[245,746,747],{},"    billing_interval=\"MONTHLY\",\n",[245,749,750],{"class":300,"line":390},[245,751,752],{},"    features=[\n",[245,754,755],{"class":300,"line":396},[245,756,757],{},"        \"5 projects\",\n",[245,759,760],{"class":300,"line":402},[245,761,762],{},"        \"10 team members\",\n",[245,764,765],{"class":300,"line":408},[245,766,767],{},"        \"Email support\",\n",[245,769,770],{"class":300,"line":414},[245,771,772],{},"        \"1 GB storage\"\n",[245,774,775],{"class":300,"line":420},[245,776,417],{},[245,778,779],{"class":300,"line":656},[245,780,781],{},")\n",[245,783,784],{"class":300,"line":666},[245,785,469],{"emptyLinePlaceholder":468},[245,787,788],{"class":300,"line":671},[245,789,790],{},"print(f\"Plan ID: {starter.id}\")\n",[280,792,794],{"id":793},"adding-prices-to-a-plan","Adding Prices to a Plan",[138,796,797],{},"After creating a plan, add one or more prices for different currencies:",[285,799,800,866,995],{"sync":287},[289,801,803],{"className":291,"code":802,"filename":293,"language":294,"meta":295,"style":295},"curl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fplans\u002Fplan_abc123\u002Fprices \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -H \"Authorization: Bearer sk_live_a1b2c3d4...\" \\\n  -d '{\n    \"currency\": \"UGX\",\n    \"amount\": 50000\n  }'\n",[174,804,805,818,830,842,850,855,860],{"__ignoreMap":295},[245,806,807,809,811,813,816],{"class":300,"line":301},[245,808,305],{"class":304},[245,810,309],{"class":308},[245,812,312],{"class":308},[245,814,815],{"class":308}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fplans\u002Fplan_abc123\u002Fprices",[245,817,319],{"class":318},[245,819,820,822,824,826,828],{"class":300,"line":322},[245,821,325],{"class":308},[245,823,329],{"class":328},[245,825,332],{"class":308},[245,827,335],{"class":328},[245,829,319],{"class":318},[245,831,832,834,836,838,840],{"class":300,"line":340},[245,833,325],{"class":308},[245,835,329],{"class":328},[245,837,347],{"class":308},[245,839,335],{"class":328},[245,841,319],{"class":318},[245,843,844,846,848],{"class":300,"line":354},[245,845,357],{"class":308},[245,847,360],{"class":328},[245,849,363],{"class":308},[245,851,852],{"class":300,"line":366},[245,853,854],{"class":308},"    \"currency\": \"UGX\",\n",[245,856,857],{"class":300,"line":372},[245,858,859],{"class":308},"    \"amount\": 50000\n",[245,861,862,864],{"class":300,"line":378},[245,863,423],{"class":308},[245,865,426],{"class":328},[289,867,869],{"className":429,"code":868,"filename":431,"language":432,"meta":295,"style":295},"\u002F\u002F Ugandan Shilling price\nawait client.plans.addPrice('plan_abc123', { currency: 'UGX', amount: 50000 });\n\n\u002F\u002F US Dollar price\nawait client.plans.addPrice('plan_abc123', { currency: 'USD', amount: 15 });\n",[174,870,871,877,934,938,943],{"__ignoreMap":295},[245,872,873],{"class":300,"line":301},[245,874,876],{"class":875},"sHwdD","\u002F\u002F Ugandan Shilling price\n",[245,878,879,882,884,886,888,890,893,895,897,899,901,903,905,908,910,912,915,917,919,922,924,928,930,932],{"class":300,"line":322},[245,880,881],{"class":439},"await",[245,883,532],{"class":318},[245,885,535],{"class":328},[245,887,538],{"class":318},[245,889,535],{"class":328},[245,891,892],{"class":487},"addPrice",[245,894,490],{"class":318},[245,896,460],{"class":328},[245,898,185],{"class":308},[245,900,460],{"class":328},[245,902,691],{"class":328},[245,904,443],{"class":328},[245,906,907],{"class":496}," currency",[245,909,500],{"class":328},[245,911,360],{"class":328},[245,913,914],{"class":308},"UGX",[245,916,460],{"class":328},[245,918,691],{"class":328},[245,920,921],{"class":496}," amount",[245,923,500],{"class":328},[245,925,927],{"class":926},"sbssI"," 50000",[245,929,449],{"class":328},[245,931,186],{"class":318},[245,933,463],{"class":328},[245,935,936],{"class":300,"line":340},[245,937,469],{"emptyLinePlaceholder":468},[245,939,940],{"class":300,"line":354},[245,941,942],{"class":875},"\u002F\u002F US Dollar price\n",[245,944,945,947,949,951,953,955,957,959,961,963,965,967,969,971,973,975,978,980,982,984,986,989,991,993],{"class":300,"line":366},[245,946,881],{"class":439},[245,948,532],{"class":318},[245,950,535],{"class":328},[245,952,538],{"class":318},[245,954,535],{"class":328},[245,956,892],{"class":487},[245,958,490],{"class":318},[245,960,460],{"class":328},[245,962,185],{"class":308},[245,964,460],{"class":328},[245,966,691],{"class":328},[245,968,443],{"class":328},[245,970,907],{"class":496},[245,972,500],{"class":328},[245,974,360],{"class":328},[245,976,977],{"class":308},"USD",[245,979,460],{"class":328},[245,981,691],{"class":328},[245,983,921],{"class":496},[245,985,500],{"class":328},[245,987,988],{"class":926}," 15",[245,990,449],{"class":328},[245,992,186],{"class":318},[245,994,463],{"class":328},[289,996,998],{"className":704,"code":997,"filename":706,"language":707,"meta":295,"style":295},"# Ugandan Shilling price\nclient.plans.add_price(\"plan_abc123\", currency=\"UGX\", amount=50000)\n\n# US Dollar price\nclient.plans.add_price(\"plan_abc123\", currency=\"USD\", amount=15)\n",[174,999,1000,1005,1010,1014,1019],{"__ignoreMap":295},[245,1001,1002],{"class":300,"line":301},[245,1003,1004],{},"# Ugandan Shilling price\n",[245,1006,1007],{"class":300,"line":322},[245,1008,1009],{},"client.plans.add_price(\"plan_abc123\", currency=\"UGX\", amount=50000)\n",[245,1011,1012],{"class":300,"line":340},[245,1013,469],{"emptyLinePlaceholder":468},[245,1015,1016],{"class":300,"line":354},[245,1017,1018],{},"# US Dollar price\n",[245,1020,1021],{"class":300,"line":366},[245,1022,1023],{},"client.plans.add_price(\"plan_abc123\", currency=\"USD\", amount=15)\n",[142,1025,1027],{"id":1026},"multi-currency-pricing","Multi-Currency Pricing",[138,1029,1030],{},"PimaBill supports 17 currencies. Add multiple prices to a single plan for different markets.",[280,1032,1034],{"id":1033},"supported-currencies","Supported Currencies",[147,1036,1037,1050],{},[150,1038,1039],{},[153,1040,1041,1044,1047],{},[156,1042,1043],{},"Code",[156,1045,1046],{},"Currency",[156,1048,1049],{},"Example Amount",[166,1051,1052,1062,1073,1084,1095,1106,1117,1127,1138,1148,1159],{},[153,1053,1054,1056,1059],{},[171,1055,914],{},[171,1057,1058],{},"Ugandan Shilling",[171,1060,1061],{},"180,000",[153,1063,1064,1067,1070],{},[171,1065,1066],{},"NGN",[171,1068,1069],{},"Nigerian Naira",[171,1071,1072],{},"15,000",[153,1074,1075,1078,1081],{},[171,1076,1077],{},"KES",[171,1079,1080],{},"Kenyan Shilling",[171,1082,1083],{},"2,500",[153,1085,1086,1089,1092],{},[171,1087,1088],{},"GHS",[171,1090,1091],{},"Ghanaian Cedi",[171,1093,1094],{},"150",[153,1096,1097,1100,1103],{},[171,1098,1099],{},"ZAR",[171,1101,1102],{},"South African Rand",[171,1104,1105],{},"350",[153,1107,1108,1111,1114],{},[171,1109,1110],{},"TZS",[171,1112,1113],{},"Tanzanian Shilling",[171,1115,1116],{},"35,000",[153,1118,1119,1122,1125],{},[171,1120,1121],{},"RWF",[171,1123,1124],{},"Rwandan Franc",[171,1126,1072],{},[153,1128,1129,1132,1135],{},[171,1130,1131],{},"EGP",[171,1133,1134],{},"Egyptian Pound",[171,1136,1137],{},"500",[153,1139,1140,1142,1145],{},[171,1141,977],{},[171,1143,1144],{},"US Dollar",[171,1146,1147],{},"29",[153,1149,1150,1153,1156],{},[171,1151,1152],{},"EUR",[171,1154,1155],{},"Euro",[171,1157,1158],{},"25",[153,1160,1161,1164,1167],{},[171,1162,1163],{},"GBP",[171,1165,1166],{},"British Pound",[171,1168,1169],{},"22",[142,1171,1173],{"id":1172},"billing-intervals","Billing Intervals",[147,1175,1176,1188],{},[150,1177,1178],{},[153,1179,1180,1183,1185],{},[156,1181,1182],{},"Interval",[156,1184,164],{},[156,1186,1187],{},"Use Case",[166,1189,1190,1202,1214],{},[153,1191,1192,1196,1199],{},[171,1193,1194],{},[174,1195,227],{},[171,1197,1198],{},"Billed every month",[171,1200,1201],{},"Standard recurring billing",[153,1203,1204,1208,1211],{},[171,1205,1206],{},[174,1207,231],{},[171,1209,1210],{},"Billed every 3 months",[171,1212,1213],{},"Moderate commitment with slight discount",[153,1215,1216,1220,1223],{},[171,1217,1218],{},[174,1219,234],{},[171,1221,1222],{},"Billed every 12 months",[171,1224,1225],{},"Long-term commitment with significant discount",[142,1227,1229],{"id":1228},"updating-plans","Updating Plans",[138,1231,1232],{},"Update plan details. Changes apply to new subscriptions; existing subscriptions retain their original terms unless explicitly changed.",[285,1234,1235,1324,1440],{"sync":287},[289,1236,1238],{"className":291,"code":1237,"filename":293,"language":294,"meta":295,"style":295},"curl -X PATCH http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fplans\u002Fplan_abc123 \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -H \"Authorization: Bearer sk_live_a1b2c3d4...\" \\\n  -d '{\n    \"name\": \"Starter v2\",\n    \"features\": [\n      \"10 projects\",\n      \"20 team members\",\n      \"Email support\",\n      \"5 GB storage\"\n    ]\n  }'\n",[174,1239,1240,1254,1266,1278,1286,1291,1295,1300,1305,1309,1314,1318],{"__ignoreMap":295},[245,1241,1242,1244,1246,1249,1252],{"class":300,"line":301},[245,1243,305],{"class":304},[245,1245,309],{"class":308},[245,1247,1248],{"class":308}," PATCH",[245,1250,1251],{"class":308}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fplans\u002Fplan_abc123",[245,1253,319],{"class":318},[245,1255,1256,1258,1260,1262,1264],{"class":300,"line":322},[245,1257,325],{"class":308},[245,1259,329],{"class":328},[245,1261,332],{"class":308},[245,1263,335],{"class":328},[245,1265,319],{"class":318},[245,1267,1268,1270,1272,1274,1276],{"class":300,"line":340},[245,1269,325],{"class":308},[245,1271,329],{"class":328},[245,1273,347],{"class":308},[245,1275,335],{"class":328},[245,1277,319],{"class":318},[245,1279,1280,1282,1284],{"class":300,"line":354},[245,1281,357],{"class":308},[245,1283,360],{"class":328},[245,1285,363],{"class":308},[245,1287,1288],{"class":300,"line":366},[245,1289,1290],{"class":308},"    \"name\": \"Starter v2\",\n",[245,1292,1293],{"class":300,"line":372},[245,1294,387],{"class":308},[245,1296,1297],{"class":300,"line":378},[245,1298,1299],{"class":308},"      \"10 projects\",\n",[245,1301,1302],{"class":300,"line":384},[245,1303,1304],{"class":308},"      \"20 team members\",\n",[245,1306,1307],{"class":300,"line":390},[245,1308,405],{"class":308},[245,1310,1311],{"class":300,"line":396},[245,1312,1313],{"class":308},"      \"5 GB storage\"\n",[245,1315,1316],{"class":300,"line":402},[245,1317,417],{"class":308},[245,1319,1320,1322],{"class":300,"line":408},[245,1321,423],{"class":308},[245,1323,426],{"class":328},[289,1325,1327],{"className":429,"code":1326,"filename":431,"language":432,"meta":295,"style":295},"const updated = await client.plans.update('plan_abc123', {\n  name: 'Starter v2',\n  features: [\n    '10 projects',\n    '20 team members',\n    'Email support',\n    '5 GB storage'\n  ]\n});\n",[174,1328,1329,1364,1379,1387,1398,1409,1419,1428,1432],{"__ignoreMap":295},[245,1330,1331,1333,1336,1338,1340,1342,1344,1346,1348,1351,1353,1355,1357,1359,1361],{"class":300,"line":301},[245,1332,475],{"class":474},[245,1334,1335],{"class":318}," updated ",[245,1337,481],{"class":328},[245,1339,529],{"class":439},[245,1341,532],{"class":318},[245,1343,535],{"class":328},[245,1345,538],{"class":318},[245,1347,535],{"class":328},[245,1349,1350],{"class":487},"update",[245,1352,490],{"class":318},[245,1354,460],{"class":328},[245,1356,185],{"class":308},[245,1358,460],{"class":328},[245,1360,691],{"class":328},[245,1362,1363],{"class":328}," {\n",[245,1365,1366,1368,1370,1372,1375,1377],{"class":300,"line":322},[245,1367,552],{"class":496},[245,1369,500],{"class":328},[245,1371,360],{"class":328},[245,1373,1374],{"class":308},"Starter v2",[245,1376,460],{"class":328},[245,1378,564],{"class":328},[245,1380,1381,1383,1385],{"class":300,"line":340},[245,1382,600],{"class":496},[245,1384,500],{"class":328},[245,1386,605],{"class":318},[245,1388,1389,1391,1394,1396],{"class":300,"line":354},[245,1390,610],{"class":328},[245,1392,1393],{"class":308},"10 projects",[245,1395,460],{"class":328},[245,1397,564],{"class":328},[245,1399,1400,1402,1405,1407],{"class":300,"line":366},[245,1401,610],{"class":328},[245,1403,1404],{"class":308},"20 team members",[245,1406,460],{"class":328},[245,1408,564],{"class":328},[245,1410,1411,1413,1415,1417],{"class":300,"line":372},[245,1412,610],{"class":328},[245,1414,635],{"class":308},[245,1416,460],{"class":328},[245,1418,564],{"class":328},[245,1420,1421,1423,1426],{"class":300,"line":378},[245,1422,610],{"class":328},[245,1424,1425],{"class":308},"5 GB storage",[245,1427,426],{"class":328},[245,1429,1430],{"class":300,"line":384},[245,1431,653],{"class":318},[245,1433,1434,1436,1438],{"class":300,"line":390},[245,1435,659],{"class":328},[245,1437,186],{"class":318},[245,1439,463],{"class":328},[289,1441,1443],{"className":704,"code":1442,"filename":706,"language":707,"meta":295,"style":295},"updated = client.plans.update(\n    \"plan_abc123\",\n    name=\"Starter v2\",\n    features=[\n        \"10 projects\",\n        \"20 team members\",\n        \"Email support\",\n        \"5 GB storage\"\n    ]\n)\n",[174,1444,1445,1450,1455,1460,1464,1469,1474,1478,1483,1487],{"__ignoreMap":295},[245,1446,1447],{"class":300,"line":301},[245,1448,1449],{},"updated = client.plans.update(\n",[245,1451,1452],{"class":300,"line":322},[245,1453,1454],{},"    \"plan_abc123\",\n",[245,1456,1457],{"class":300,"line":340},[245,1458,1459],{},"    name=\"Starter v2\",\n",[245,1461,1462],{"class":300,"line":354},[245,1463,752],{},[245,1465,1466],{"class":300,"line":366},[245,1467,1468],{},"        \"10 projects\",\n",[245,1470,1471],{"class":300,"line":372},[245,1472,1473],{},"        \"20 team members\",\n",[245,1475,1476],{"class":300,"line":378},[245,1477,767],{},[245,1479,1480],{"class":300,"line":384},[245,1481,1482],{},"        \"5 GB storage\"\n",[245,1484,1485],{"class":300,"line":390},[245,1486,417],{},[245,1488,1489],{"class":300,"line":396},[245,1490,781],{},[1492,1493,1494],"note",{},"Price changes to a plan do not automatically update existing subscriptions. To change pricing for an existing subscription, update the subscription's plan or create a new plan version.",[142,1496,1498],{"id":1497},"listing-plans","Listing Plans",[138,1500,1501,1502,1505,1506,1510],{},"Add ",[174,1503,1504],{},"?code=starter"," to get just the plan with that code. Codes are the same in live and the ",[1507,1508,1509],"a",{"href":122},"sandbox",", while IDs are not, so look plans up by code in your app.",[285,1512,1513,1547,1677],{"sync":287},[289,1514,1516],{"className":291,"code":1515,"filename":293,"language":294,"meta":295,"style":295},"curl -X GET \"http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fplans?isActive=true\" \\\n  -H \"Authorization: Bearer sk_live_a1b2c3d4...\"\n",[174,1517,1518,1536],{"__ignoreMap":295},[245,1519,1520,1522,1524,1527,1529,1532,1534],{"class":300,"line":301},[245,1521,305],{"class":304},[245,1523,309],{"class":308},[245,1525,1526],{"class":308}," GET",[245,1528,329],{"class":328},[245,1530,1531],{"class":308},"http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fplans?isActive=true",[245,1533,335],{"class":328},[245,1535,319],{"class":318},[245,1537,1538,1540,1542,1544],{"class":300,"line":322},[245,1539,325],{"class":308},[245,1541,329],{"class":328},[245,1543,347],{"class":308},[245,1545,1546],{"class":328},"\"\n",[289,1548,1550],{"className":429,"code":1549,"filename":431,"language":432,"meta":295,"style":295},"const plans = await client.plans.list({ isActive: true });\n\nfor (const plan of plans) {\n  console.log(`${plan.name} (${plan.code}) - ${plan.billingInterval}`);\n}\n",[174,1551,1552,1593,1597,1618,1672],{"__ignoreMap":295},[245,1553,1554,1556,1559,1561,1563,1565,1567,1569,1571,1574,1576,1578,1581,1583,1587,1589,1591],{"class":300,"line":301},[245,1555,475],{"class":474},[245,1557,1558],{"class":318}," plans ",[245,1560,481],{"class":328},[245,1562,529],{"class":439},[245,1564,532],{"class":318},[245,1566,535],{"class":328},[245,1568,538],{"class":318},[245,1570,535],{"class":328},[245,1572,1573],{"class":487},"list",[245,1575,490],{"class":318},[245,1577,493],{"class":328},[245,1579,1580],{"class":496}," isActive",[245,1582,500],{"class":328},[245,1584,1586],{"class":1585},"sfNiH"," true",[245,1588,449],{"class":328},[245,1590,186],{"class":318},[245,1592,463],{"class":328},[245,1594,1595],{"class":300,"line":322},[245,1596,469],{"emptyLinePlaceholder":468},[245,1598,1599,1602,1605,1607,1610,1613,1616],{"class":300,"line":340},[245,1600,1601],{"class":439},"for",[245,1603,1604],{"class":318}," (",[245,1606,475],{"class":474},[245,1608,1609],{"class":318}," plan ",[245,1611,1612],{"class":328},"of",[245,1614,1615],{"class":318}," plans) ",[245,1617,363],{"class":328},[245,1619,1620,1623,1625,1627,1629,1632,1635,1637,1639,1641,1643,1646,1648,1650,1652,1654,1657,1659,1661,1663,1665,1668,1670],{"class":300,"line":354},[245,1621,1622],{"class":318},"  console",[245,1624,535],{"class":328},[245,1626,679],{"class":487},[245,1628,490],{"class":496},[245,1630,1631],{"class":328},"`${",[245,1633,1634],{"class":318},"plan",[245,1636,535],{"class":328},[245,1638,193],{"class":318},[245,1640,659],{"class":328},[245,1642,1604],{"class":308},[245,1644,1645],{"class":328},"${",[245,1647,1634],{"class":318},[245,1649,535],{"class":328},[245,1651,174],{"class":318},[245,1653,659],{"class":328},[245,1655,1656],{"class":308},") - ",[245,1658,1645],{"class":328},[245,1660,1634],{"class":318},[245,1662,535],{"class":328},[245,1664,219],{"class":318},[245,1666,1667],{"class":328},"}`",[245,1669,186],{"class":496},[245,1671,463],{"class":328},[245,1673,1674],{"class":300,"line":366},[245,1675,1676],{"class":328},"}\n",[289,1678,1680],{"className":704,"code":1679,"filename":706,"language":707,"meta":295,"style":295},"plans = client.plans.list(is_active=True)\n\nfor plan in plans:\n    print(f\"{plan.name} ({plan.code}) - {plan.billing_interval}\")\n",[174,1681,1682,1687,1691,1696],{"__ignoreMap":295},[245,1683,1684],{"class":300,"line":301},[245,1685,1686],{},"plans = client.plans.list(is_active=True)\n",[245,1688,1689],{"class":300,"line":322},[245,1690,469],{"emptyLinePlaceholder":468},[245,1692,1693],{"class":300,"line":340},[245,1694,1695],{},"for plan in plans:\n",[245,1697,1698],{"class":300,"line":354},[245,1699,1700],{},"    print(f\"{plan.name} ({plan.code}) - {plan.billing_interval}\")\n",[142,1702,1704],{"id":1703},"best-practices","Best Practices",[1706,1707,1708,1716,1722,1728],"ol",{},[1709,1710,1711,1715],"li",{},[1712,1713,1714],"strong",{},"Use descriptive names"," -- Plan names appear on invoices and customer-facing interfaces. Use clear, descriptive names like \"Pro Plan (Monthly)\" rather than internal codes.",[1709,1717,1718,1721],{},[1712,1719,1720],{},"Version your plans"," -- When making significant pricing changes, create a new plan version instead of modifying the existing one. Use the code field to track plan versions.",[1709,1723,1724,1727],{},[1712,1725,1726],{},"Offer annual discounts"," -- Annual plans reduce churn and improve cash flow. A 15-20% discount compared to monthly billing is a common approach.",[1709,1729,1730,1733],{},[1712,1731,1732],{},"Add multiple currency prices"," -- For each plan, add prices in all currencies you want to support. This enables automatic currency matching for customers.",[1735,1736,1737],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}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 .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .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 .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}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 .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sfNiH, html code.shiki .sfNiH{--shiki-light:#FF5370;--shiki-default:#FF9CAC;--shiki-dark:#FF9CAC}",{"title":295,"searchDepth":322,"depth":322,"links":1739},[1740,1741,1745,1748,1749,1750,1751],{"id":144,"depth":322,"text":145},{"id":277,"depth":322,"text":278,"children":1742},[1743,1744],{"id":282,"depth":340,"text":283},{"id":793,"depth":340,"text":794},{"id":1026,"depth":322,"text":1027,"children":1746},[1747],{"id":1033,"depth":340,"text":1034},{"id":1172,"depth":322,"text":1173},{"id":1228,"depth":322,"text":1229},{"id":1497,"depth":322,"text":1498},{"id":1703,"depth":322,"text":1704},"Create and manage subscription plans with multi-currency pricing and billing intervals.","md",null,{},{"title":97,"description":1752},"lpJb9rSxa-Fqs7R2SMKfMXjUU4YkxRqjfN90T1cK70E",[1759,1761],{"title":93,"path":94,"stem":95,"description":1760,"children":-1},"Sell bundles and courses that are paid once and never renew, and let customers pay with a deposit or in instalments.",{"title":101,"path":102,"stem":103,"description":1762,"children":-1},"Manage the full subscription lifecycle including creation, pausing, cancellation, and plan changes.",1793401245768]