[{"data":1,"prerenderedAt":3794},["ShallowReactive",2],{"navigation_docs":3,"-api-reference":132,"-api-reference-surround":3791},[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":129,"body":134,"description":3785,"extension":3786,"links":3787,"meta":3788,"navigation":1529,"path":130,"seo":3789,"stem":131,"__hash__":3790},"docs\u002F4.api-reference.md",{"type":135,"value":136,"toc":3740},"minimark",[137,141,156,161,172,175,181,184,187,255,261,265,268,407,411,422,425,429,432,519,524,602,606,647,649,653,656,769,771,774,777,900,904,1164,1166,1170,1173,1295,1299,1560,1562,1565,1568,1692,1696,1811,1813,1817,1820,1959,1961,1965,1968,2024,2028,2081,2083,2086,2089,2184,2186,2190,2193,2274,2298,2302,2394,2396,2400,2403,2473,2477,2557,2559,2563,2566,2661,2681,2685,2787,2789,2793,2796,2905,2907,2911,2914,3037,3039,3043,3046,3142,3159,3161,3165,3168,3277,3281,3372,3376,3447,3449,3452,3455,3525,3536,3538,3541,3544,3628,3630,3634,3637,3721,3723,3727,3730,3736],[138,139,140],"p",{},"The full interactive API reference is hosted alongside the PimaBill API server.",[142,143,144,155],"tip",{},[145,146,147],"strong",{},[148,149,154],"a",{"href":150,"rel":151,"target":153},"http:\u002F\u002Flocalhost:4000\u002Fapi\u002Freference",[152],"nofollow","_blank","Open API Reference"," -- Browse all endpoints, try requests, and view response schemas in the interactive documentation.",[157,158,160],"h2",{"id":159},"base-url","Base URL",[162,163,168],"pre",{"className":164,"code":166,"language":167},[165],"language-text","http:\u002F\u002Flocalhost:4000\u002Fapi\n","text",[169,170,166],"code",{"__ignoreMap":171},"",[138,173,174],{},"Webhooks are received at:",[162,176,179],{"className":177,"code":178,"language":167},[165],"http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fwebhooks\u002F{provider}\n",[169,180,178],{"__ignoreMap":171},[157,182,18],{"id":183},"authentication",[138,185,186],{},"All API endpoints require authentication. PimaBill uses two authentication methods:",[188,189,190,206],"table",{},[191,192,193],"thead",{},[194,195,196,200,203],"tr",{},[197,198,199],"th",{},"Method",[197,201,202],{},"Header",[197,204,205],{},"Used For",[207,208,209,233],"tbody",{},[194,210,211,217,222],{},[212,213,214],"td",{},[145,215,216],{},"JWT Bearer",[212,218,219],{},[169,220,221],{},"Authorization: Bearer \u003Cjwt_token>",[212,223,224,225,228,229,232],{},"Tenant management (",[169,226,227],{},"\u002Fauth\u002F*",", ",[169,230,231],{},"\u002Ftenants\u002F*",")",[194,234,235,240,245],{},[212,236,237],{},[145,238,239],{},"API Key",[212,241,242],{},[169,243,244],{},"Authorization: Bearer sk_live_...",[212,246,247,248,228,251,254],{},"Data operations (",[169,249,250],{},"\u002Fcustomers\u002F*",[169,252,253],{},"\u002Fplans\u002F*",", etc.)",[138,256,257,258,260],{},"See ",[148,259,18],{"href":19}," for details on obtaining tokens and API keys.",[157,262,264],{"id":263},"response-format","Response Format",[138,266,267],{},"All successful responses return JSON. List endpoints include pagination metadata:",[162,269,273],{"className":270,"code":271,"language":272,"meta":171,"style":171},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"data\": [...],\n  \"meta\": {\n    \"total\": 150,\n    \"page\": 1,\n    \"limit\": 20,\n    \"totalPages\": 8\n  }\n}\n","json",[169,274,275,284,310,325,346,363,380,395,401],{"__ignoreMap":171},[276,277,280],"span",{"class":278,"line":279},"line",1,[276,281,283],{"class":282},"sMK4o","{\n",[276,285,287,290,294,297,300,303,307],{"class":278,"line":286},2,[276,288,289],{"class":282},"  \"",[276,291,293],{"class":292},"spNyl","data",[276,295,296],{"class":282},"\"",[276,298,299],{"class":282},":",[276,301,302],{"class":282}," [",[276,304,306],{"class":305},"sTEyZ","...",[276,308,309],{"class":282},"],\n",[276,311,313,315,318,320,322],{"class":278,"line":312},3,[276,314,289],{"class":282},[276,316,317],{"class":292},"meta",[276,319,296],{"class":282},[276,321,299],{"class":282},[276,323,324],{"class":282}," {\n",[276,326,328,331,335,337,339,343],{"class":278,"line":327},4,[276,329,330],{"class":282},"    \"",[276,332,334],{"class":333},"sBMFI","total",[276,336,296],{"class":282},[276,338,299],{"class":282},[276,340,342],{"class":341},"sbssI"," 150",[276,344,345],{"class":282},",\n",[276,347,349,351,354,356,358,361],{"class":278,"line":348},5,[276,350,330],{"class":282},[276,352,353],{"class":333},"page",[276,355,296],{"class":282},[276,357,299],{"class":282},[276,359,360],{"class":341}," 1",[276,362,345],{"class":282},[276,364,366,368,371,373,375,378],{"class":278,"line":365},6,[276,367,330],{"class":282},[276,369,370],{"class":333},"limit",[276,372,296],{"class":282},[276,374,299],{"class":282},[276,376,377],{"class":341}," 20",[276,379,345],{"class":282},[276,381,383,385,388,390,392],{"class":278,"line":382},7,[276,384,330],{"class":282},[276,386,387],{"class":333},"totalPages",[276,389,296],{"class":282},[276,391,299],{"class":282},[276,393,394],{"class":341}," 8\n",[276,396,398],{"class":278,"line":397},8,[276,399,400],{"class":282},"  }\n",[276,402,404],{"class":278,"line":403},9,[276,405,406],{"class":282},"}\n",[157,408,410],{"id":409},"rate-limiting","Rate Limiting",[138,412,413,414,417,418,421],{},"All endpoints are rate-limited to ",[145,415,416],{},"100 requests per minute"," per tenant. Exceeding this returns a ",[169,419,420],{},"429 Too Many Requests"," response.",[423,424],"hr",{},[157,426,428],{"id":427},"auth","Auth",[138,430,431],{},"Public endpoints for tenant registration, login, and password management.",[188,433,434,446],{},[191,435,436],{},[194,437,438,440,443],{},[197,439,199],{},[197,441,442],{},"Endpoint",[197,444,445],{},"Description",[207,447,448,463,477,491,505],{},[194,449,450,455,460],{},[212,451,452],{},[169,453,454],{},"POST",[212,456,457],{},[169,458,459],{},"\u002Fauth\u002Fregister",[212,461,462],{},"Register a new tenant — provisions isolated database, generates API key, returns JWT tokens",[194,464,465,469,474],{},[212,466,467],{},[169,468,454],{},[212,470,471],{},[169,472,473],{},"\u002Fauth\u002Flogin",[212,475,476],{},"Login with email and password — returns access and refresh tokens",[194,478,479,483,488],{},[212,480,481],{},[169,482,454],{},[212,484,485],{},[169,486,487],{},"\u002Fauth\u002Frefresh",[212,489,490],{},"Exchange a refresh token for a new access\u002Frefresh token pair",[194,492,493,497,502],{},[212,494,495],{},[169,496,454],{},[212,498,499],{},[169,500,501],{},"\u002Fauth\u002Fforgot-password",[212,503,504],{},"Request a password reset email (always returns success to prevent enumeration)",[194,506,507,511,516],{},[212,508,509],{},[169,510,454],{},[212,512,513],{},[169,514,515],{},"\u002Fauth\u002Freset-password",[212,517,518],{},"Set a new password using the reset token received via email",[520,521,523],"h3",{"id":522},"register","Register",[162,525,529],{"className":526,"code":527,"language":528,"meta":171,"style":171},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fauth\u002Fregister \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"John Doe\",\n    \"email\": \"john@company.com\",\n    \"password\": \"securePassword123\",\n    \"companyName\": \"Acme Corp\"\n  }'\n","bash",[169,530,531,549,564,574,579,584,589,594],{"__ignoreMap":171},[276,532,533,536,540,543,546],{"class":278,"line":279},[276,534,535],{"class":333},"curl",[276,537,539],{"class":538},"sfazB"," -X",[276,541,542],{"class":538}," POST",[276,544,545],{"class":538}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fauth\u002Fregister",[276,547,548],{"class":305}," \\\n",[276,550,551,554,557,560,562],{"class":278,"line":286},[276,552,553],{"class":538},"  -H",[276,555,556],{"class":282}," \"",[276,558,559],{"class":538},"Content-Type: application\u002Fjson",[276,561,296],{"class":282},[276,563,548],{"class":305},[276,565,566,569,572],{"class":278,"line":312},[276,567,568],{"class":538},"  -d",[276,570,571],{"class":282}," '",[276,573,283],{"class":538},[276,575,576],{"class":278,"line":327},[276,577,578],{"class":538},"    \"name\": \"John Doe\",\n",[276,580,581],{"class":278,"line":348},[276,582,583],{"class":538},"    \"email\": \"john@company.com\",\n",[276,585,586],{"class":278,"line":365},[276,587,588],{"class":538},"    \"password\": \"securePassword123\",\n",[276,590,591],{"class":278,"line":382},[276,592,593],{"class":538},"    \"companyName\": \"Acme Corp\"\n",[276,595,596,599],{"class":278,"line":397},[276,597,598],{"class":538},"  }",[276,600,601],{"class":282},"'\n",[520,603,605],{"id":604},"login","Login",[162,607,609],{"className":526,"code":608,"language":528,"meta":171,"style":171},"curl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fauth\u002Flogin \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"email\": \"john@company.com\", \"password\": \"securePassword123\" }'\n",[169,610,611,624,636],{"__ignoreMap":171},[276,612,613,615,617,619,622],{"class":278,"line":279},[276,614,535],{"class":333},[276,616,539],{"class":538},[276,618,542],{"class":538},[276,620,621],{"class":538}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fauth\u002Flogin",[276,623,548],{"class":305},[276,625,626,628,630,632,634],{"class":278,"line":286},[276,627,553],{"class":538},[276,629,556],{"class":282},[276,631,559],{"class":538},[276,633,296],{"class":282},[276,635,548],{"class":305},[276,637,638,640,642,645],{"class":278,"line":312},[276,639,568],{"class":538},[276,641,571],{"class":282},[276,643,644],{"class":538},"{ \"email\": \"john@company.com\", \"password\": \"securePassword123\" }",[276,646,601],{"class":282},[423,648],{},[157,650,652],{"id":651},"tenants","Tenants",[138,654,655],{},"Manage your tenant profile, API keys, SMTP settings, and usage statistics. Authenticated via JWT.",[188,657,658,668],{},[191,659,660],{},[194,661,662,664,666],{},[197,663,199],{},[197,665,442],{},[197,667,445],{},[207,669,670,685,699,713,727,740,755],{},[194,671,672,677,682],{},[212,673,674],{},[169,675,676],{},"GET",[212,678,679],{},[169,680,681],{},"\u002Ftenants\u002Fme",[212,683,684],{},"Get current tenant info",[194,686,687,692,696],{},[212,688,689],{},[169,690,691],{},"PATCH",[212,693,694],{},[169,695,681],{},[212,697,698],{},"Update tenant profile and settings",[194,700,701,705,710],{},[212,702,703],{},[169,704,676],{},[212,706,707],{},[169,708,709],{},"\u002Ftenants\u002Fme\u002Fusage",[212,711,712],{},"Get tenant usage statistics",[194,714,715,719,724],{},[212,716,717],{},[169,718,454],{},[212,720,721],{},[169,722,723],{},"\u002Ftenants\u002Fme\u002Fapi-keys",[212,725,726],{},"Generate a new API key",[194,728,729,733,737],{},[212,730,731],{},[169,732,676],{},[212,734,735],{},[169,736,723],{},[212,738,739],{},"List all API keys",[194,741,742,747,752],{},[212,743,744],{},[169,745,746],{},"DELETE",[212,748,749],{},[169,750,751],{},"\u002Ftenants\u002Fme\u002Fapi-keys\u002F:id",[212,753,754],{},"Revoke an API key",[194,756,757,761,766],{},[212,758,759],{},[169,760,454],{},[212,762,763],{},[169,764,765],{},"\u002Ftenants\u002Fme\u002Fsmtp\u002Ftest",[212,767,768],{},"Test SMTP configuration with a test email",[423,770],{},[157,772,53],{"id":773},"customers",[138,775,776],{},"CRUD operations for customers plus relationship queries for their subscriptions, invoices, and payments.",[188,778,779,789],{},[191,780,781],{},[194,782,783,785,787],{},[197,784,199],{},[197,786,442],{},[197,788,445],{},[207,790,791,805,819,832,845,858,872,886],{},[194,792,793,797,802],{},[212,794,795],{},[169,796,676],{},[212,798,799],{},[169,800,801],{},"\u002Fcustomers",[212,803,804],{},"List customers (paginated, searchable)",[194,806,807,811,816],{},[212,808,809],{},[169,810,676],{},[212,812,813],{},[169,814,815],{},"\u002Fcustomers\u002F:id",[212,817,818],{},"Get customer by ID",[194,820,821,825,829],{},[212,822,823],{},[169,824,454],{},[212,826,827],{},[169,828,801],{},[212,830,831],{},"Create a new customer",[194,833,834,838,842],{},[212,835,836],{},[169,837,691],{},[212,839,840],{},[169,841,815],{},[212,843,844],{},"Update a customer",[194,846,847,851,855],{},[212,848,849],{},[169,850,746],{},[212,852,853],{},[169,854,815],{},[212,856,857],{},"Delete a customer (fails if active subscriptions exist)",[194,859,860,864,869],{},[212,861,862],{},[169,863,676],{},[212,865,866],{},[169,867,868],{},"\u002Fcustomers\u002F:id\u002Fsubscriptions",[212,870,871],{},"List customer's subscriptions",[194,873,874,878,883],{},[212,875,876],{},[169,877,676],{},[212,879,880],{},[169,881,882],{},"\u002Fcustomers\u002F:id\u002Finvoices",[212,884,885],{},"List customer's invoices",[194,887,888,892,897],{},[212,889,890],{},[169,891,676],{},[212,893,894],{},[169,895,896],{},"\u002Fcustomers\u002F:id\u002Fpayments",[212,898,899],{},"List customer's payments",[520,901,903],{"id":902},"create-customer","Create Customer",[905,906,907,990,1122],"code-group",{},[162,908,911],{"className":526,"code":909,"filename":910,"language":528,"meta":171,"style":171},"curl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fcustomers \\\n  -H \"Authorization: Bearer sk_live_...\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"externalId\": \"cust_123\",\n    \"name\": \"Jane Smith\",\n    \"email\": \"jane@example.com\",\n    \"country\": \"US\",\n    \"currency\": \"USD\"\n  }'\n","REST",[169,912,913,926,938,950,958,963,968,973,978,983],{"__ignoreMap":171},[276,914,915,917,919,921,924],{"class":278,"line":279},[276,916,535],{"class":333},[276,918,539],{"class":538},[276,920,542],{"class":538},[276,922,923],{"class":538}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fcustomers",[276,925,548],{"class":305},[276,927,928,930,932,934,936],{"class":278,"line":286},[276,929,553],{"class":538},[276,931,556],{"class":282},[276,933,244],{"class":538},[276,935,296],{"class":282},[276,937,548],{"class":305},[276,939,940,942,944,946,948],{"class":278,"line":312},[276,941,553],{"class":538},[276,943,556],{"class":282},[276,945,559],{"class":538},[276,947,296],{"class":282},[276,949,548],{"class":305},[276,951,952,954,956],{"class":278,"line":327},[276,953,568],{"class":538},[276,955,571],{"class":282},[276,957,283],{"class":538},[276,959,960],{"class":278,"line":348},[276,961,962],{"class":538},"    \"externalId\": \"cust_123\",\n",[276,964,965],{"class":278,"line":365},[276,966,967],{"class":538},"    \"name\": \"Jane Smith\",\n",[276,969,970],{"class":278,"line":382},[276,971,972],{"class":538},"    \"email\": \"jane@example.com\",\n",[276,974,975],{"class":278,"line":397},[276,976,977],{"class":538},"    \"country\": \"US\",\n",[276,979,980],{"class":278,"line":403},[276,981,982],{"class":538},"    \"currency\": \"USD\"\n",[276,984,986,988],{"class":278,"line":985},10,[276,987,598],{"class":538},[276,989,601],{"class":282},[162,991,995],{"className":992,"code":993,"filename":36,"language":994,"meta":171,"style":171},"language-typescript shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","const customer = await client.customers.create({\n  externalId: \"cust_123\",\n  name: \"Jane Smith\",\n  email: \"jane@example.com\",\n  country: \"US\",\n  currency: \"USD\",\n});\n","typescript",[169,996,997,1031,1048,1064,1080,1096,1112],{"__ignoreMap":171},[276,998,999,1002,1005,1008,1012,1015,1018,1020,1022,1026,1029],{"class":278,"line":279},[276,1000,1001],{"class":292},"const",[276,1003,1004],{"class":305}," customer ",[276,1006,1007],{"class":282},"=",[276,1009,1011],{"class":1010},"s7zQu"," await",[276,1013,1014],{"class":305}," client",[276,1016,1017],{"class":282},".",[276,1019,773],{"class":305},[276,1021,1017],{"class":282},[276,1023,1025],{"class":1024},"s2Zo4","create",[276,1027,1028],{"class":305},"(",[276,1030,283],{"class":282},[276,1032,1033,1037,1039,1041,1044,1046],{"class":278,"line":286},[276,1034,1036],{"class":1035},"swJcz","  externalId",[276,1038,299],{"class":282},[276,1040,556],{"class":282},[276,1042,1043],{"class":538},"cust_123",[276,1045,296],{"class":282},[276,1047,345],{"class":282},[276,1049,1050,1053,1055,1057,1060,1062],{"class":278,"line":312},[276,1051,1052],{"class":1035},"  name",[276,1054,299],{"class":282},[276,1056,556],{"class":282},[276,1058,1059],{"class":538},"Jane Smith",[276,1061,296],{"class":282},[276,1063,345],{"class":282},[276,1065,1066,1069,1071,1073,1076,1078],{"class":278,"line":327},[276,1067,1068],{"class":1035},"  email",[276,1070,299],{"class":282},[276,1072,556],{"class":282},[276,1074,1075],{"class":538},"jane@example.com",[276,1077,296],{"class":282},[276,1079,345],{"class":282},[276,1081,1082,1085,1087,1089,1092,1094],{"class":278,"line":348},[276,1083,1084],{"class":1035},"  country",[276,1086,299],{"class":282},[276,1088,556],{"class":282},[276,1090,1091],{"class":538},"US",[276,1093,296],{"class":282},[276,1095,345],{"class":282},[276,1097,1098,1101,1103,1105,1108,1110],{"class":278,"line":365},[276,1099,1100],{"class":1035},"  currency",[276,1102,299],{"class":282},[276,1104,556],{"class":282},[276,1106,1107],{"class":538},"USD",[276,1109,296],{"class":282},[276,1111,345],{"class":282},[276,1113,1114,1117,1119],{"class":278,"line":382},[276,1115,1116],{"class":282},"}",[276,1118,232],{"class":305},[276,1120,1121],{"class":282},";\n",[162,1123,1127],{"className":1124,"code":1125,"filename":40,"language":1126,"meta":171,"style":171},"language-python shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","customer = client.customers.create(\n    external_id=\"cust_123\",\n    name=\"Jane Smith\",\n    email=\"jane@example.com\",\n    country=\"US\",\n    currency=\"USD\",\n)\n","python",[169,1128,1129,1134,1139,1144,1149,1154,1159],{"__ignoreMap":171},[276,1130,1131],{"class":278,"line":279},[276,1132,1133],{},"customer = client.customers.create(\n",[276,1135,1136],{"class":278,"line":286},[276,1137,1138],{},"    external_id=\"cust_123\",\n",[276,1140,1141],{"class":278,"line":312},[276,1142,1143],{},"    name=\"Jane Smith\",\n",[276,1145,1146],{"class":278,"line":327},[276,1147,1148],{},"    email=\"jane@example.com\",\n",[276,1150,1151],{"class":278,"line":348},[276,1152,1153],{},"    country=\"US\",\n",[276,1155,1156],{"class":278,"line":365},[276,1157,1158],{},"    currency=\"USD\",\n",[276,1160,1161],{"class":278,"line":382},[276,1162,1163],{},")\n",[423,1165],{},[157,1167,1169],{"id":1168},"plans","Plans",[138,1171,1172],{},"Manage billing plans with pricing, features, and billing configuration.",[188,1174,1175,1185],{},[191,1176,1177],{},[194,1178,1179,1181,1183],{},[197,1180,199],{},[197,1182,442],{},[197,1184,445],{},[207,1186,1187,1201,1215,1228,1241,1254,1268,1282],{},[194,1188,1189,1193,1198],{},[212,1190,1191],{},[169,1192,676],{},[212,1194,1195],{},[169,1196,1197],{},"\u002Fplans",[212,1199,1200],{},"List all plans",[194,1202,1203,1207,1212],{},[212,1204,1205],{},[169,1206,676],{},[212,1208,1209],{},[169,1210,1211],{},"\u002Fplans\u002F:id",[212,1213,1214],{},"Get plan by ID",[194,1216,1217,1221,1225],{},[212,1218,1219],{},[169,1220,454],{},[212,1222,1223],{},[169,1224,1197],{},[212,1226,1227],{},"Create a new plan",[194,1229,1230,1234,1238],{},[212,1231,1232],{},[169,1233,691],{},[212,1235,1236],{},[169,1237,1211],{},[212,1239,1240],{},"Update a plan",[194,1242,1243,1247,1251],{},[212,1244,1245],{},[169,1246,746],{},[212,1248,1249],{},[169,1250,1211],{},[212,1252,1253],{},"Delete a plan",[194,1255,1256,1260,1265],{},[212,1257,1258],{},[169,1259,454],{},[212,1261,1262],{},[169,1263,1264],{},"\u002Fplans\u002F:id\u002Fprices",[212,1266,1267],{},"Add a price to a plan",[194,1269,1270,1274,1279],{},[212,1271,1272],{},[169,1273,691],{},[212,1275,1276],{},[169,1277,1278],{},"\u002Fplans\u002F:id\u002Fprices\u002F:priceId",[212,1280,1281],{},"Update a plan price",[194,1283,1284,1288,1292],{},[212,1285,1286],{},[169,1287,746],{},[212,1289,1290],{},[169,1291,1278],{},[212,1293,1294],{},"Delete a plan price",[520,1296,1298],{"id":1297},"create-plan","Create Plan",[905,1300,1301,1388,1515],{},[162,1302,1304],{"className":526,"code":1303,"filename":910,"language":528,"meta":171,"style":171},"curl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fplans \\\n  -H \"Authorization: Bearer sk_live_...\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"Pro Plan\",\n    \"code\": \"pro\",\n    \"description\": \"For growing teams\",\n    \"billingInterval\": \"MONTHLY\",\n    \"features\": [\"Unlimited users\", \"Priority support\"],\n    \"prices\": [{ \"currency\": \"USD\", \"amount\": 49.99 }]\n  }'\n",[169,1305,1306,1319,1331,1343,1351,1356,1361,1366,1371,1376,1381],{"__ignoreMap":171},[276,1307,1308,1310,1312,1314,1317],{"class":278,"line":279},[276,1309,535],{"class":333},[276,1311,539],{"class":538},[276,1313,542],{"class":538},[276,1315,1316],{"class":538}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fplans",[276,1318,548],{"class":305},[276,1320,1321,1323,1325,1327,1329],{"class":278,"line":286},[276,1322,553],{"class":538},[276,1324,556],{"class":282},[276,1326,244],{"class":538},[276,1328,296],{"class":282},[276,1330,548],{"class":305},[276,1332,1333,1335,1337,1339,1341],{"class":278,"line":312},[276,1334,553],{"class":538},[276,1336,556],{"class":282},[276,1338,559],{"class":538},[276,1340,296],{"class":282},[276,1342,548],{"class":305},[276,1344,1345,1347,1349],{"class":278,"line":327},[276,1346,568],{"class":538},[276,1348,571],{"class":282},[276,1350,283],{"class":538},[276,1352,1353],{"class":278,"line":348},[276,1354,1355],{"class":538},"    \"name\": \"Pro Plan\",\n",[276,1357,1358],{"class":278,"line":365},[276,1359,1360],{"class":538},"    \"code\": \"pro\",\n",[276,1362,1363],{"class":278,"line":382},[276,1364,1365],{"class":538},"    \"description\": \"For growing teams\",\n",[276,1367,1368],{"class":278,"line":397},[276,1369,1370],{"class":538},"    \"billingInterval\": \"MONTHLY\",\n",[276,1372,1373],{"class":278,"line":403},[276,1374,1375],{"class":538},"    \"features\": [\"Unlimited users\", \"Priority support\"],\n",[276,1377,1378],{"class":278,"line":985},[276,1379,1380],{"class":538},"    \"prices\": [{ \"currency\": \"USD\", \"amount\": 49.99 }]\n",[276,1382,1384,1386],{"class":278,"line":1383},11,[276,1385,598],{"class":538},[276,1387,601],{"class":282},[162,1389,1391],{"className":992,"code":1390,"filename":36,"language":994,"meta":171,"style":171},"const plan = await client.plans.create({\n  name: \"Pro Plan\",\n  code: \"pro\",\n  billingInterval: \"MONTHLY\",\n  prices: [{ currency: \"USD\", amount: 49.99 }],\n});\n",[169,1392,1393,1418,1433,1449,1465,1507],{"__ignoreMap":171},[276,1394,1395,1397,1400,1402,1404,1406,1408,1410,1412,1414,1416],{"class":278,"line":279},[276,1396,1001],{"class":292},[276,1398,1399],{"class":305}," plan ",[276,1401,1007],{"class":282},[276,1403,1011],{"class":1010},[276,1405,1014],{"class":305},[276,1407,1017],{"class":282},[276,1409,1168],{"class":305},[276,1411,1017],{"class":282},[276,1413,1025],{"class":1024},[276,1415,1028],{"class":305},[276,1417,283],{"class":282},[276,1419,1420,1422,1424,1426,1429,1431],{"class":278,"line":286},[276,1421,1052],{"class":1035},[276,1423,299],{"class":282},[276,1425,556],{"class":282},[276,1427,1428],{"class":538},"Pro Plan",[276,1430,296],{"class":282},[276,1432,345],{"class":282},[276,1434,1435,1438,1440,1442,1445,1447],{"class":278,"line":312},[276,1436,1437],{"class":1035},"  code",[276,1439,299],{"class":282},[276,1441,556],{"class":282},[276,1443,1444],{"class":538},"pro",[276,1446,296],{"class":282},[276,1448,345],{"class":282},[276,1450,1451,1454,1456,1458,1461,1463],{"class":278,"line":327},[276,1452,1453],{"class":1035},"  billingInterval",[276,1455,299],{"class":282},[276,1457,556],{"class":282},[276,1459,1460],{"class":538},"MONTHLY",[276,1462,296],{"class":282},[276,1464,345],{"class":282},[276,1466,1467,1470,1472,1474,1477,1480,1482,1484,1486,1488,1491,1494,1496,1499,1502,1505],{"class":278,"line":348},[276,1468,1469],{"class":1035},"  prices",[276,1471,299],{"class":282},[276,1473,302],{"class":305},[276,1475,1476],{"class":282},"{",[276,1478,1479],{"class":1035}," currency",[276,1481,299],{"class":282},[276,1483,556],{"class":282},[276,1485,1107],{"class":538},[276,1487,296],{"class":282},[276,1489,1490],{"class":282},",",[276,1492,1493],{"class":1035}," amount",[276,1495,299],{"class":282},[276,1497,1498],{"class":341}," 49.99",[276,1500,1501],{"class":282}," }",[276,1503,1504],{"class":305},"]",[276,1506,345],{"class":282},[276,1508,1509,1511,1513],{"class":278,"line":365},[276,1510,1116],{"class":282},[276,1512,232],{"class":305},[276,1514,1121],{"class":282},[162,1516,1518],{"className":1124,"code":1517,"filename":40,"language":1126,"meta":171,"style":171},"from pimabill import CreatePlanPriceDto\n\nplan = client.plans.create(\n    name=\"Pro Plan\",\n    code=\"pro\",\n    billing_interval=\"MONTHLY\",\n    prices=[CreatePlanPriceDto(currency=\"USD\", amount=49.99)],\n)\n",[169,1519,1520,1525,1531,1536,1541,1546,1551,1556],{"__ignoreMap":171},[276,1521,1522],{"class":278,"line":279},[276,1523,1524],{},"from pimabill import CreatePlanPriceDto\n",[276,1526,1527],{"class":278,"line":286},[276,1528,1530],{"emptyLinePlaceholder":1529},true,"\n",[276,1532,1533],{"class":278,"line":312},[276,1534,1535],{},"plan = client.plans.create(\n",[276,1537,1538],{"class":278,"line":327},[276,1539,1540],{},"    name=\"Pro Plan\",\n",[276,1542,1543],{"class":278,"line":348},[276,1544,1545],{},"    code=\"pro\",\n",[276,1547,1548],{"class":278,"line":365},[276,1549,1550],{},"    billing_interval=\"MONTHLY\",\n",[276,1552,1553],{"class":278,"line":382},[276,1554,1555],{},"    prices=[CreatePlanPriceDto(currency=\"USD\", amount=49.99)],\n",[276,1557,1558],{"class":278,"line":397},[276,1559,1163],{},[423,1561],{},[157,1563,101],{"id":1564},"subscriptions",[138,1566,1567],{},"Create and manage customer subscriptions with support for cancellation, pausing, resuming, and mid-cycle plan changes with proration.",[188,1569,1570,1580],{},[191,1571,1572],{},[194,1573,1574,1576,1578],{},[197,1575,199],{},[197,1577,442],{},[197,1579,445],{},[207,1581,1582,1596,1610,1623,1636,1650,1664,1678],{},[194,1583,1584,1588,1593],{},[212,1585,1586],{},[169,1587,676],{},[212,1589,1590],{},[169,1591,1592],{},"\u002Fsubscriptions",[212,1594,1595],{},"List subscriptions (filterable by status, planId)",[194,1597,1598,1602,1607],{},[212,1599,1600],{},[169,1601,676],{},[212,1603,1604],{},[169,1605,1606],{},"\u002Fsubscriptions\u002F:id",[212,1608,1609],{},"Get subscription by ID",[194,1611,1612,1616,1620],{},[212,1613,1614],{},[169,1615,454],{},[212,1617,1618],{},[169,1619,1592],{},[212,1621,1622],{},"Create a new subscription",[194,1624,1625,1629,1633],{},[212,1626,1627],{},[169,1628,691],{},[212,1630,1631],{},[169,1632,1606],{},[212,1634,1635],{},"Update subscription metadata",[194,1637,1638,1642,1647],{},[212,1639,1640],{},[169,1641,454],{},[212,1643,1644],{},[169,1645,1646],{},"\u002Fsubscriptions\u002F:id\u002Fcancel",[212,1648,1649],{},"Cancel (immediate or end-of-period)",[194,1651,1652,1656,1661],{},[212,1653,1654],{},[169,1655,454],{},[212,1657,1658],{},[169,1659,1660],{},"\u002Fsubscriptions\u002F:id\u002Fpause",[212,1662,1663],{},"Pause a subscription",[194,1665,1666,1670,1675],{},[212,1667,1668],{},[169,1669,454],{},[212,1671,1672],{},[169,1673,1674],{},"\u002Fsubscriptions\u002F:id\u002Fresume",[212,1676,1677],{},"Resume a paused subscription",[194,1679,1680,1684,1689],{},[212,1681,1682],{},[169,1683,454],{},[212,1685,1686],{},[169,1687,1688],{},"\u002Fsubscriptions\u002F:id\u002Fchange-plan",[212,1690,1691],{},"Change plan (with proration)",[520,1693,1695],{"id":1694},"cancel-subscription","Cancel Subscription",[162,1697,1699],{"className":526,"code":1698,"language":528,"meta":171,"style":171},"# Immediate cancellation (issues pro-rated credit note)\ncurl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fsubscriptions\u002F:id\u002Fcancel \\\n  -H \"Authorization: Bearer sk_live_...\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"cancelAt\": \"now\" }'\n\n# Cancel at period end\ncurl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fsubscriptions\u002F:id\u002Fcancel \\\n  -H \"Authorization: Bearer sk_live_...\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"cancelAt\": \"period_end\" }'\n",[169,1700,1701,1707,1720,1732,1744,1755,1759,1764,1776,1788,1800],{"__ignoreMap":171},[276,1702,1703],{"class":278,"line":279},[276,1704,1706],{"class":1705},"sHwdD","# Immediate cancellation (issues pro-rated credit note)\n",[276,1708,1709,1711,1713,1715,1718],{"class":278,"line":286},[276,1710,535],{"class":333},[276,1712,539],{"class":538},[276,1714,542],{"class":538},[276,1716,1717],{"class":538}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fsubscriptions\u002F:id\u002Fcancel",[276,1719,548],{"class":305},[276,1721,1722,1724,1726,1728,1730],{"class":278,"line":312},[276,1723,553],{"class":538},[276,1725,556],{"class":282},[276,1727,244],{"class":538},[276,1729,296],{"class":282},[276,1731,548],{"class":305},[276,1733,1734,1736,1738,1740,1742],{"class":278,"line":327},[276,1735,553],{"class":538},[276,1737,556],{"class":282},[276,1739,559],{"class":538},[276,1741,296],{"class":282},[276,1743,548],{"class":305},[276,1745,1746,1748,1750,1753],{"class":278,"line":348},[276,1747,568],{"class":538},[276,1749,571],{"class":282},[276,1751,1752],{"class":538},"{ \"cancelAt\": \"now\" }",[276,1754,601],{"class":282},[276,1756,1757],{"class":278,"line":365},[276,1758,1530],{"emptyLinePlaceholder":1529},[276,1760,1761],{"class":278,"line":382},[276,1762,1763],{"class":1705},"# Cancel at period end\n",[276,1765,1766,1768,1770,1772,1774],{"class":278,"line":397},[276,1767,535],{"class":333},[276,1769,539],{"class":538},[276,1771,542],{"class":538},[276,1773,1717],{"class":538},[276,1775,548],{"class":305},[276,1777,1778,1780,1782,1784,1786],{"class":278,"line":403},[276,1779,553],{"class":538},[276,1781,556],{"class":282},[276,1783,244],{"class":538},[276,1785,296],{"class":282},[276,1787,548],{"class":305},[276,1789,1790,1792,1794,1796,1798],{"class":278,"line":985},[276,1791,553],{"class":538},[276,1793,556],{"class":282},[276,1795,559],{"class":538},[276,1797,296],{"class":282},[276,1799,548],{"class":305},[276,1801,1802,1804,1806,1809],{"class":278,"line":1383},[276,1803,568],{"class":538},[276,1805,571],{"class":282},[276,1807,1808],{"class":538},"{ \"cancelAt\": \"period_end\" }",[276,1810,601],{"class":282},[423,1812],{},[157,1814,1816],{"id":1815},"invoices","Invoices",[138,1818,1819],{},"Full invoice lifecycle: create, finalize, void, mark paid, generate checkout URLs, send emails, and download PDFs.",[188,1821,1822,1832],{},[191,1823,1824],{},[194,1825,1826,1828,1830],{},[197,1827,199],{},[197,1829,442],{},[197,1831,445],{},[207,1833,1834,1848,1862,1875,1889,1903,1917,1931,1945],{},[194,1835,1836,1840,1845],{},[212,1837,1838],{},[169,1839,676],{},[212,1841,1842],{},[169,1843,1844],{},"\u002Finvoices",[212,1846,1847],{},"List invoices (filterable by status)",[194,1849,1850,1854,1859],{},[212,1851,1852],{},[169,1853,676],{},[212,1855,1856],{},[169,1857,1858],{},"\u002Finvoices\u002F:id",[212,1860,1861],{},"Get invoice by ID",[194,1863,1864,1868,1872],{},[212,1865,1866],{},[169,1867,454],{},[212,1869,1870],{},[169,1871,1844],{},[212,1873,1874],{},"Create a new invoice",[194,1876,1877,1881,1886],{},[212,1878,1879],{},[169,1880,454],{},[212,1882,1883],{},[169,1884,1885],{},"\u002Finvoices\u002F:id\u002Ffinalize",[212,1887,1888],{},"Finalize a draft invoice",[194,1890,1891,1895,1900],{},[212,1892,1893],{},[169,1894,454],{},[212,1896,1897],{},[169,1898,1899],{},"\u002Finvoices\u002F:id\u002Fvoid",[212,1901,1902],{},"Void an invoice",[194,1904,1905,1909,1914],{},[212,1906,1907],{},[169,1908,454],{},[212,1910,1911],{},[169,1912,1913],{},"\u002Finvoices\u002F:id\u002Fmark-paid",[212,1915,1916],{},"Manually mark invoice as paid",[194,1918,1919,1923,1928],{},[212,1920,1921],{},[169,1922,454],{},[212,1924,1925],{},[169,1926,1927],{},"\u002Finvoices\u002F:id\u002Fcheckout",[212,1929,1930],{},"Generate a payment checkout URL",[194,1932,1933,1937,1942],{},[212,1934,1935],{},[169,1936,454],{},[212,1938,1939],{},[169,1940,1941],{},"\u002Finvoices\u002F:id\u002Fsend-email",[212,1943,1944],{},"Send invoice to customer via email",[194,1946,1947,1951,1956],{},[212,1948,1949],{},[169,1950,676],{},[212,1952,1953],{},[169,1954,1955],{},"\u002Finvoices\u002F:id\u002Fpdf",[212,1957,1958],{},"Download invoice as PDF",[423,1960],{},[157,1962,1964],{"id":1963},"payments","Payments",[138,1966,1967],{},"View payment history and process refunds.",[188,1969,1970,1980],{},[191,1971,1972],{},[194,1973,1974,1976,1978],{},[197,1975,199],{},[197,1977,442],{},[197,1979,445],{},[207,1981,1982,1996,2010],{},[194,1983,1984,1988,1993],{},[212,1985,1986],{},[169,1987,676],{},[212,1989,1990],{},[169,1991,1992],{},"\u002Fpayments",[212,1994,1995],{},"List payments (filterable by status, provider)",[194,1997,1998,2002,2007],{},[212,1999,2000],{},[169,2001,676],{},[212,2003,2004],{},[169,2005,2006],{},"\u002Fpayments\u002F:id",[212,2008,2009],{},"Get payment by ID",[194,2011,2012,2016,2021],{},[212,2013,2014],{},[169,2015,454],{},[212,2017,2018],{},[169,2019,2020],{},"\u002Fpayments\u002F:id\u002Frefund",[212,2022,2023],{},"Refund a payment (full or partial)",[520,2025,2027],{"id":2026},"refund-payment","Refund Payment",[162,2029,2031],{"className":526,"code":2030,"language":528,"meta":171,"style":171},"curl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fpayments\u002F:id\u002Frefund \\\n  -H \"Authorization: Bearer sk_live_...\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"amount\": 25.00, \"reason\": \"Customer request\" }'\n",[169,2032,2033,2046,2058,2070],{"__ignoreMap":171},[276,2034,2035,2037,2039,2041,2044],{"class":278,"line":279},[276,2036,535],{"class":333},[276,2038,539],{"class":538},[276,2040,542],{"class":538},[276,2042,2043],{"class":538}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fpayments\u002F:id\u002Frefund",[276,2045,548],{"class":305},[276,2047,2048,2050,2052,2054,2056],{"class":278,"line":286},[276,2049,553],{"class":538},[276,2051,556],{"class":282},[276,2053,244],{"class":538},[276,2055,296],{"class":282},[276,2057,548],{"class":305},[276,2059,2060,2062,2064,2066,2068],{"class":278,"line":312},[276,2061,553],{"class":538},[276,2063,556],{"class":282},[276,2065,559],{"class":538},[276,2067,296],{"class":282},[276,2069,548],{"class":305},[276,2071,2072,2074,2076,2079],{"class":278,"line":327},[276,2073,568],{"class":538},[276,2075,571],{"class":282},[276,2077,2078],{"class":538},"{ \"amount\": 25.00, \"reason\": \"Customer request\" }",[276,2080,601],{"class":282},[423,2082],{},[157,2084,109],{"id":2085},"payment-providers",[138,2087,2088],{},"Configure and manage payment provider integrations (Stripe, Paystack, Flutterwave, Pesapal, PayPal, PayU, DPO).",[188,2090,2091,2101],{},[191,2092,2093],{},[194,2094,2095,2097,2099],{},[197,2096,199],{},[197,2098,442],{},[197,2100,445],{},[207,2102,2103,2117,2131,2144,2157,2170],{},[194,2104,2105,2109,2114],{},[212,2106,2107],{},[169,2108,676],{},[212,2110,2111],{},[169,2112,2113],{},"\u002Fpayment-providers",[212,2115,2116],{},"List configured providers",[194,2118,2119,2123,2128],{},[212,2120,2121],{},[169,2122,676],{},[212,2124,2125],{},[169,2126,2127],{},"\u002Fpayment-providers\u002F:id",[212,2129,2130],{},"Get provider by ID",[194,2132,2133,2137,2141],{},[212,2134,2135],{},[169,2136,454],{},[212,2138,2139],{},[169,2140,2113],{},[212,2142,2143],{},"Configure a new provider",[194,2145,2146,2150,2154],{},[212,2147,2148],{},[169,2149,691],{},[212,2151,2152],{},[169,2153,2127],{},[212,2155,2156],{},"Update provider settings",[194,2158,2159,2163,2167],{},[212,2160,2161],{},[169,2162,746],{},[212,2164,2165],{},[169,2166,2127],{},[212,2168,2169],{},"Remove a provider",[194,2171,2172,2176,2181],{},[212,2173,2174],{},[169,2175,454],{},[212,2177,2178],{},[169,2179,2180],{},"\u002Fpayment-providers\u002F:id\u002Ftest",[212,2182,2183],{},"Test provider connection",[423,2185],{},[157,2187,2189],{"id":2188},"billable-metrics","Billable Metrics",[138,2191,2192],{},"Define event-based usage metrics for usage-based billing.",[188,2194,2195,2205],{},[191,2196,2197],{},[194,2198,2199,2201,2203],{},[197,2200,199],{},[197,2202,442],{},[197,2204,445],{},[207,2206,2207,2221,2235,2248,2261],{},[194,2208,2209,2213,2218],{},[212,2210,2211],{},[169,2212,676],{},[212,2214,2215],{},[169,2216,2217],{},"\u002Fbillable-metrics",[212,2219,2220],{},"List all billable metrics",[194,2222,2223,2227,2232],{},[212,2224,2225],{},[169,2226,676],{},[212,2228,2229],{},[169,2230,2231],{},"\u002Fbillable-metrics\u002F:id",[212,2233,2234],{},"Get metric by ID",[194,2236,2237,2241,2245],{},[212,2238,2239],{},[169,2240,454],{},[212,2242,2243],{},[169,2244,2217],{},[212,2246,2247],{},"Create a billable metric",[194,2249,2250,2254,2258],{},[212,2251,2252],{},[169,2253,691],{},[212,2255,2256],{},[169,2257,2231],{},[212,2259,2260],{},"Update a billable metric",[194,2262,2263,2267,2271],{},[212,2264,2265],{},[169,2266,746],{},[212,2268,2269],{},[169,2270,2231],{},[212,2272,2273],{},"Delete a billable metric",[138,2275,2276,2279,2280,228,2283,228,2286,228,2289,228,2292,228,2295],{},[145,2277,2278],{},"Aggregation Types:"," ",[169,2281,2282],{},"COUNT",[169,2284,2285],{},"SUM",[169,2287,2288],{},"MAX",[169,2290,2291],{},"UNIQUE_COUNT",[169,2293,2294],{},"LATEST",[169,2296,2297],{},"WEIGHTED_SUM",[520,2299,2301],{"id":2300},"create-billable-metric","Create Billable Metric",[162,2303,2305],{"className":526,"code":2304,"language":528,"meta":171,"style":171},"curl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fbillable-metrics \\\n  -H \"Authorization: Bearer sk_live_...\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"name\": \"API Calls\",\n    \"code\": \"api_calls\",\n    \"aggregationType\": \"COUNT\",\n    \"recurring\": false,\n    \"filters\": [\n      { \"key\": \"region\", \"values\": [\"us-east\", \"us-west\", \"eu\"] }\n    ]\n  }'\n",[169,2306,2307,2320,2332,2344,2352,2357,2362,2367,2372,2377,2382,2387],{"__ignoreMap":171},[276,2308,2309,2311,2313,2315,2318],{"class":278,"line":279},[276,2310,535],{"class":333},[276,2312,539],{"class":538},[276,2314,542],{"class":538},[276,2316,2317],{"class":538}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fbillable-metrics",[276,2319,548],{"class":305},[276,2321,2322,2324,2326,2328,2330],{"class":278,"line":286},[276,2323,553],{"class":538},[276,2325,556],{"class":282},[276,2327,244],{"class":538},[276,2329,296],{"class":282},[276,2331,548],{"class":305},[276,2333,2334,2336,2338,2340,2342],{"class":278,"line":312},[276,2335,553],{"class":538},[276,2337,556],{"class":282},[276,2339,559],{"class":538},[276,2341,296],{"class":282},[276,2343,548],{"class":305},[276,2345,2346,2348,2350],{"class":278,"line":327},[276,2347,568],{"class":538},[276,2349,571],{"class":282},[276,2351,283],{"class":538},[276,2353,2354],{"class":278,"line":348},[276,2355,2356],{"class":538},"    \"name\": \"API Calls\",\n",[276,2358,2359],{"class":278,"line":365},[276,2360,2361],{"class":538},"    \"code\": \"api_calls\",\n",[276,2363,2364],{"class":278,"line":382},[276,2365,2366],{"class":538},"    \"aggregationType\": \"COUNT\",\n",[276,2368,2369],{"class":278,"line":397},[276,2370,2371],{"class":538},"    \"recurring\": false,\n",[276,2373,2374],{"class":278,"line":403},[276,2375,2376],{"class":538},"    \"filters\": [\n",[276,2378,2379],{"class":278,"line":985},[276,2380,2381],{"class":538},"      { \"key\": \"region\", \"values\": [\"us-east\", \"us-west\", \"eu\"] }\n",[276,2383,2384],{"class":278,"line":1383},[276,2385,2386],{"class":538},"    ]\n",[276,2388,2390,2392],{"class":278,"line":2389},12,[276,2391,598],{"class":538},[276,2393,601],{"class":282},[423,2395],{},[157,2397,2399],{"id":2398},"usage-events","Usage Events",[138,2401,2402],{},"Ingest usage events for metered billing. Supports single and batch ingestion with idempotency.",[188,2404,2405,2415],{},[191,2406,2407],{},[194,2408,2409,2411,2413],{},[197,2410,199],{},[197,2412,442],{},[197,2414,445],{},[207,2416,2417,2431,2445,2459],{},[194,2418,2419,2423,2428],{},[212,2420,2421],{},[169,2422,454],{},[212,2424,2425],{},[169,2426,2427],{},"\u002Fevents",[212,2429,2430],{},"Ingest a single usage event",[194,2432,2433,2437,2442],{},[212,2434,2435],{},[169,2436,454],{},[212,2438,2439],{},[169,2440,2441],{},"\u002Fevents\u002Fbatch",[212,2443,2444],{},"Ingest a batch of usage events",[194,2446,2447,2451,2456],{},[212,2448,2449],{},[169,2450,676],{},[212,2452,2453],{},[169,2454,2455],{},"\u002Fevents\u002F:id",[212,2457,2458],{},"Get event by ID",[194,2460,2461,2465,2470],{},[212,2462,2463],{},[169,2464,676],{},[212,2466,2467],{},[169,2468,2469],{},"\u002Fevents\u002Fsubscription\u002F:subscriptionId",[212,2471,2472],{},"List events for a subscription",[520,2474,2476],{"id":2475},"ingest-event","Ingest Event",[162,2478,2480],{"className":526,"code":2479,"language":528,"meta":171,"style":171},"curl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fevents \\\n  -H \"Authorization: Bearer sk_live_...\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"transactionId\": \"txn_unique_123\",\n    \"subscriptionId\": \"sub_abc\",\n    \"code\": \"api_calls\",\n    \"timestamp\": \"2026-02-12T10:00:00Z\",\n    \"properties\": { \"region\": \"us-east\", \"bytes\": 1024 }\n  }'\n",[169,2481,2482,2495,2507,2519,2527,2532,2537,2541,2546,2551],{"__ignoreMap":171},[276,2483,2484,2486,2488,2490,2493],{"class":278,"line":279},[276,2485,535],{"class":333},[276,2487,539],{"class":538},[276,2489,542],{"class":538},[276,2491,2492],{"class":538}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fevents",[276,2494,548],{"class":305},[276,2496,2497,2499,2501,2503,2505],{"class":278,"line":286},[276,2498,553],{"class":538},[276,2500,556],{"class":282},[276,2502,244],{"class":538},[276,2504,296],{"class":282},[276,2506,548],{"class":305},[276,2508,2509,2511,2513,2515,2517],{"class":278,"line":312},[276,2510,553],{"class":538},[276,2512,556],{"class":282},[276,2514,559],{"class":538},[276,2516,296],{"class":282},[276,2518,548],{"class":305},[276,2520,2521,2523,2525],{"class":278,"line":327},[276,2522,568],{"class":538},[276,2524,571],{"class":282},[276,2526,283],{"class":538},[276,2528,2529],{"class":278,"line":348},[276,2530,2531],{"class":538},"    \"transactionId\": \"txn_unique_123\",\n",[276,2533,2534],{"class":278,"line":365},[276,2535,2536],{"class":538},"    \"subscriptionId\": \"sub_abc\",\n",[276,2538,2539],{"class":278,"line":382},[276,2540,2361],{"class":538},[276,2542,2543],{"class":278,"line":397},[276,2544,2545],{"class":538},"    \"timestamp\": \"2026-02-12T10:00:00Z\",\n",[276,2547,2548],{"class":278,"line":403},[276,2549,2550],{"class":538},"    \"properties\": { \"region\": \"us-east\", \"bytes\": 1024 }\n",[276,2552,2553,2555],{"class":278,"line":985},[276,2554,598],{"class":538},[276,2556,601],{"class":282},[423,2558],{},[157,2560,2562],{"id":2561},"charges","Charges",[138,2564,2565],{},"Define pricing models attached to plans and billable metrics.",[188,2567,2568,2578],{},[191,2569,2570],{},[194,2571,2572,2574,2576],{},[197,2573,199],{},[197,2575,442],{},[197,2577,445],{},[207,2579,2580,2594,2608,2622,2635,2648],{},[194,2581,2582,2586,2591],{},[212,2583,2584],{},[169,2585,676],{},[212,2587,2588],{},[169,2589,2590],{},"\u002Fcharges",[212,2592,2593],{},"List all charges",[194,2595,2596,2600,2605],{},[212,2597,2598],{},[169,2599,676],{},[212,2601,2602],{},[169,2603,2604],{},"\u002Fcharges\u002F:id",[212,2606,2607],{},"Get charge by ID",[194,2609,2610,2614,2619],{},[212,2611,2612],{},[169,2613,676],{},[212,2615,2616],{},[169,2617,2618],{},"\u002Fcharges\u002Fplan\u002F:planId",[212,2620,2621],{},"List charges for a specific plan",[194,2623,2624,2628,2632],{},[212,2625,2626],{},[169,2627,454],{},[212,2629,2630],{},[169,2631,2590],{},[212,2633,2634],{},"Create a charge",[194,2636,2637,2641,2645],{},[212,2638,2639],{},[169,2640,691],{},[212,2642,2643],{},[169,2644,2604],{},[212,2646,2647],{},"Update a charge",[194,2649,2650,2654,2658],{},[212,2651,2652],{},[169,2653,746],{},[212,2655,2656],{},[169,2657,2604],{},[212,2659,2660],{},"Delete a charge",[138,2662,2663,2279,2666,228,2669,228,2672,228,2675,228,2678],{},[145,2664,2665],{},"Charge Models:",[169,2667,2668],{},"STANDARD",[169,2670,2671],{},"GRADUATED",[169,2673,2674],{},"VOLUME",[169,2676,2677],{},"PACKAGE",[169,2679,2680],{},"PERCENTAGE",[520,2682,2684],{"id":2683},"create-graduated-charge","Create Graduated Charge",[162,2686,2688],{"className":526,"code":2687,"language":528,"meta":171,"style":171},"curl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fcharges \\\n  -H \"Authorization: Bearer sk_live_...\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"planId\": \"plan_abc\",\n    \"billableMetricId\": \"bm_api_calls\",\n    \"chargeModel\": \"GRADUATED\",\n    \"billingTiming\": \"IN_ARREARS\",\n    \"graduatedRanges\": [\n      { \"fromValue\": 0, \"toValue\": 1000, \"perUnitAmount\": 0, \"flatAmount\": 0 },\n      { \"fromValue\": 1001, \"toValue\": 10000, \"perUnitAmount\": 0.01, \"flatAmount\": 0 },\n      { \"fromValue\": 10001, \"perUnitAmount\": 0.005, \"flatAmount\": 0 }\n    ]\n  }'\n",[169,2689,2690,2703,2715,2727,2735,2740,2745,2750,2755,2760,2765,2770,2775,2780],{"__ignoreMap":171},[276,2691,2692,2694,2696,2698,2701],{"class":278,"line":279},[276,2693,535],{"class":333},[276,2695,539],{"class":538},[276,2697,542],{"class":538},[276,2699,2700],{"class":538}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fcharges",[276,2702,548],{"class":305},[276,2704,2705,2707,2709,2711,2713],{"class":278,"line":286},[276,2706,553],{"class":538},[276,2708,556],{"class":282},[276,2710,244],{"class":538},[276,2712,296],{"class":282},[276,2714,548],{"class":305},[276,2716,2717,2719,2721,2723,2725],{"class":278,"line":312},[276,2718,553],{"class":538},[276,2720,556],{"class":282},[276,2722,559],{"class":538},[276,2724,296],{"class":282},[276,2726,548],{"class":305},[276,2728,2729,2731,2733],{"class":278,"line":327},[276,2730,568],{"class":538},[276,2732,571],{"class":282},[276,2734,283],{"class":538},[276,2736,2737],{"class":278,"line":348},[276,2738,2739],{"class":538},"    \"planId\": \"plan_abc\",\n",[276,2741,2742],{"class":278,"line":365},[276,2743,2744],{"class":538},"    \"billableMetricId\": \"bm_api_calls\",\n",[276,2746,2747],{"class":278,"line":382},[276,2748,2749],{"class":538},"    \"chargeModel\": \"GRADUATED\",\n",[276,2751,2752],{"class":278,"line":397},[276,2753,2754],{"class":538},"    \"billingTiming\": \"IN_ARREARS\",\n",[276,2756,2757],{"class":278,"line":403},[276,2758,2759],{"class":538},"    \"graduatedRanges\": [\n",[276,2761,2762],{"class":278,"line":985},[276,2763,2764],{"class":538},"      { \"fromValue\": 0, \"toValue\": 1000, \"perUnitAmount\": 0, \"flatAmount\": 0 },\n",[276,2766,2767],{"class":278,"line":1383},[276,2768,2769],{"class":538},"      { \"fromValue\": 1001, \"toValue\": 10000, \"perUnitAmount\": 0.01, \"flatAmount\": 0 },\n",[276,2771,2772],{"class":278,"line":2389},[276,2773,2774],{"class":538},"      { \"fromValue\": 10001, \"perUnitAmount\": 0.005, \"flatAmount\": 0 }\n",[276,2776,2778],{"class":278,"line":2777},13,[276,2779,2386],{"class":538},[276,2781,2783,2785],{"class":278,"line":2782},14,[276,2784,598],{"class":538},[276,2786,601],{"class":282},[423,2788],{},[157,2790,2792],{"id":2791},"coupons","Coupons",[138,2794,2795],{},"Create and manage discount coupons that can be applied to customers or subscriptions.",[188,2797,2798,2808],{},[191,2799,2800],{},[194,2801,2802,2804,2806],{},[197,2803,199],{},[197,2805,442],{},[197,2807,445],{},[207,2809,2810,2824,2838,2851,2864,2877,2891],{},[194,2811,2812,2816,2821],{},[212,2813,2814],{},[169,2815,676],{},[212,2817,2818],{},[169,2819,2820],{},"\u002Fcoupons",[212,2822,2823],{},"List coupons (filterable by isActive)",[194,2825,2826,2830,2835],{},[212,2827,2828],{},[169,2829,676],{},[212,2831,2832],{},[169,2833,2834],{},"\u002Fcoupons\u002F:id",[212,2836,2837],{},"Get coupon by ID",[194,2839,2840,2844,2848],{},[212,2841,2842],{},[169,2843,454],{},[212,2845,2846],{},[169,2847,2820],{},[212,2849,2850],{},"Create a coupon",[194,2852,2853,2857,2861],{},[212,2854,2855],{},[169,2856,691],{},[212,2858,2859],{},[169,2860,2834],{},[212,2862,2863],{},"Update a coupon",[194,2865,2866,2870,2874],{},[212,2867,2868],{},[169,2869,746],{},[212,2871,2872],{},[169,2873,2834],{},[212,2875,2876],{},"Delete a coupon",[194,2878,2879,2883,2888],{},[212,2880,2881],{},[169,2882,454],{},[212,2884,2885],{},[169,2886,2887],{},"\u002Fcoupons\u002Fapply",[212,2889,2890],{},"Apply coupon to a customer",[194,2892,2893,2897,2902],{},[212,2894,2895],{},[169,2896,746],{},[212,2898,2899],{},[169,2900,2901],{},"\u002Fcoupons\u002Fapplied\u002F:id",[212,2903,2904],{},"Remove an applied coupon",[423,2906],{},[157,2908,2910],{"id":2909},"add-ons","Add-Ons",[138,2912,2913],{},"One-time or recurring add-on charges that can be applied to customer subscriptions.",[188,2915,2916,2926],{},[191,2917,2918],{},[194,2919,2920,2922,2924],{},[197,2921,199],{},[197,2923,442],{},[197,2925,445],{},[207,2927,2928,2942,2956,2969,2982,2995,3009,3023],{},[194,2929,2930,2934,2939],{},[212,2931,2932],{},[169,2933,676],{},[212,2935,2936],{},[169,2937,2938],{},"\u002Fadd-ons",[212,2940,2941],{},"List add-ons",[194,2943,2944,2948,2953],{},[212,2945,2946],{},[169,2947,676],{},[212,2949,2950],{},[169,2951,2952],{},"\u002Fadd-ons\u002F:id",[212,2954,2955],{},"Get add-on by ID",[194,2957,2958,2962,2966],{},[212,2959,2960],{},[169,2961,454],{},[212,2963,2964],{},[169,2965,2938],{},[212,2967,2968],{},"Create an add-on",[194,2970,2971,2975,2979],{},[212,2972,2973],{},[169,2974,691],{},[212,2976,2977],{},[169,2978,2952],{},[212,2980,2981],{},"Update an add-on",[194,2983,2984,2988,2992],{},[212,2985,2986],{},[169,2987,746],{},[212,2989,2990],{},[169,2991,2952],{},[212,2993,2994],{},"Delete an add-on",[194,2996,2997,3001,3006],{},[212,2998,2999],{},[169,3000,454],{},[212,3002,3003],{},[169,3004,3005],{},"\u002Fadd-ons\u002Fapply",[212,3007,3008],{},"Apply add-on to a customer",[194,3010,3011,3015,3020],{},[212,3012,3013],{},[169,3014,676],{},[212,3016,3017],{},[169,3018,3019],{},"\u002Fadd-ons\u002Fapplied\u002Flist",[212,3021,3022],{},"List applied add-ons",[194,3024,3025,3029,3034],{},[212,3026,3027],{},[169,3028,746],{},[212,3030,3031],{},[169,3032,3033],{},"\u002Fadd-ons\u002Fapplied\u002F:id",[212,3035,3036],{},"Remove an applied add-on",[423,3038],{},[157,3040,3042],{"id":3041},"credit-notes","Credit Notes",[138,3044,3045],{},"Issue credit notes against invoices for refunds, adjustments, or order changes.",[188,3047,3048,3058],{},[191,3049,3050],{},[194,3051,3052,3054,3056],{},[197,3053,199],{},[197,3055,442],{},[197,3057,445],{},[207,3059,3060,3074,3088,3101,3114,3128],{},[194,3061,3062,3066,3071],{},[212,3063,3064],{},[169,3065,676],{},[212,3067,3068],{},[169,3069,3070],{},"\u002Fcredit-notes",[212,3072,3073],{},"List credit notes (filterable by customerId, invoiceId, status)",[194,3075,3076,3080,3085],{},[212,3077,3078],{},[169,3079,676],{},[212,3081,3082],{},[169,3083,3084],{},"\u002Fcredit-notes\u002F:id",[212,3086,3087],{},"Get credit note by ID",[194,3089,3090,3094,3098],{},[212,3091,3092],{},[169,3093,454],{},[212,3095,3096],{},[169,3097,3070],{},[212,3099,3100],{},"Create a credit note",[194,3102,3103,3107,3111],{},[212,3104,3105],{},[169,3106,691],{},[212,3108,3109],{},[169,3110,3084],{},[212,3112,3113],{},"Update a draft credit note",[194,3115,3116,3120,3125],{},[212,3117,3118],{},[169,3119,454],{},[212,3121,3122],{},[169,3123,3124],{},"\u002Fcredit-notes\u002F:id\u002Ffinalize",[212,3126,3127],{},"Finalize a credit note",[194,3129,3130,3134,3139],{},[212,3131,3132],{},[169,3133,454],{},[212,3135,3136],{},[169,3137,3138],{},"\u002Fcredit-notes\u002F:id\u002Fvoid",[212,3140,3141],{},"Void a credit note",[138,3143,3144,2279,3147,228,3150,228,3153,228,3156],{},[145,3145,3146],{},"Reasons:",[169,3148,3149],{},"DUPLICATE",[169,3151,3152],{},"PRODUCT_UNSATISFACTORY",[169,3154,3155],{},"ORDER_CHANGE",[169,3157,3158],{},"OTHER",[423,3160],{},[157,3162,3164],{"id":3163},"wallets-prepaid-credits","Wallets \u002F Prepaid Credits",[138,3166,3167],{},"Manage customer prepaid credit wallets with top-ups, voiding, and automatic invoice deduction.",[188,3169,3170,3180],{},[191,3171,3172],{},[194,3173,3174,3176,3178],{},[197,3175,199],{},[197,3177,442],{},[197,3179,445],{},[207,3181,3182,3196,3209,3223,3236,3249,3263],{},[194,3183,3184,3188,3193],{},[212,3185,3186],{},[169,3187,454],{},[212,3189,3190],{},[169,3191,3192],{},"\u002Fwallets",[212,3194,3195],{},"Create a wallet for a customer",[194,3197,3198,3202,3206],{},[212,3199,3200],{},[169,3201,676],{},[212,3203,3204],{},[169,3205,3192],{},[212,3207,3208],{},"List wallets (filterable by customerId, status)",[194,3210,3211,3215,3220],{},[212,3212,3213],{},[169,3214,676],{},[212,3216,3217],{},[169,3218,3219],{},"\u002Fwallets\u002F:id",[212,3221,3222],{},"Get wallet by ID",[194,3224,3225,3229,3233],{},[212,3226,3227],{},[169,3228,691],{},[212,3230,3231],{},[169,3232,3219],{},[212,3234,3235],{},"Update wallet (name, expiration)",[194,3237,3238,3242,3246],{},[212,3239,3240],{},[169,3241,746],{},[212,3243,3244],{},[169,3245,3219],{},[212,3247,3248],{},"Terminate a wallet (voids remaining credits)",[194,3250,3251,3255,3260],{},[212,3252,3253],{},[169,3254,454],{},[212,3256,3257],{},[169,3258,3259],{},"\u002Fwallets\u002Ftransactions",[212,3261,3262],{},"Top up or void credits",[194,3264,3265,3269,3274],{},[212,3266,3267],{},[169,3268,676],{},[212,3270,3271],{},[169,3272,3273],{},"\u002Fwallets\u002F:id\u002Ftransactions",[212,3275,3276],{},"List wallet transactions",[520,3278,3280],{"id":3279},"create-wallet","Create Wallet",[162,3282,3284],{"className":526,"code":3283,"language":528,"meta":171,"style":171},"curl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fwallets \\\n  -H \"Authorization: Bearer sk_live_...\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"customerId\": \"cust_abc\",\n    \"name\": \"Main Wallet\",\n    \"currency\": \"USD\",\n    \"rateAmount\": 1.0,\n    \"paidCredits\": 100,\n    \"grantedCredits\": 10,\n    \"expirationAt\": \"2027-01-01T00:00:00Z\"\n  }'\n",[169,3285,3286,3299,3311,3323,3331,3336,3341,3346,3351,3356,3361,3366],{"__ignoreMap":171},[276,3287,3288,3290,3292,3294,3297],{"class":278,"line":279},[276,3289,535],{"class":333},[276,3291,539],{"class":538},[276,3293,542],{"class":538},[276,3295,3296],{"class":538}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fwallets",[276,3298,548],{"class":305},[276,3300,3301,3303,3305,3307,3309],{"class":278,"line":286},[276,3302,553],{"class":538},[276,3304,556],{"class":282},[276,3306,244],{"class":538},[276,3308,296],{"class":282},[276,3310,548],{"class":305},[276,3312,3313,3315,3317,3319,3321],{"class":278,"line":312},[276,3314,553],{"class":538},[276,3316,556],{"class":282},[276,3318,559],{"class":538},[276,3320,296],{"class":282},[276,3322,548],{"class":305},[276,3324,3325,3327,3329],{"class":278,"line":327},[276,3326,568],{"class":538},[276,3328,571],{"class":282},[276,3330,283],{"class":538},[276,3332,3333],{"class":278,"line":348},[276,3334,3335],{"class":538},"    \"customerId\": \"cust_abc\",\n",[276,3337,3338],{"class":278,"line":365},[276,3339,3340],{"class":538},"    \"name\": \"Main Wallet\",\n",[276,3342,3343],{"class":278,"line":382},[276,3344,3345],{"class":538},"    \"currency\": \"USD\",\n",[276,3347,3348],{"class":278,"line":397},[276,3349,3350],{"class":538},"    \"rateAmount\": 1.0,\n",[276,3352,3353],{"class":278,"line":403},[276,3354,3355],{"class":538},"    \"paidCredits\": 100,\n",[276,3357,3358],{"class":278,"line":985},[276,3359,3360],{"class":538},"    \"grantedCredits\": 10,\n",[276,3362,3363],{"class":278,"line":1383},[276,3364,3365],{"class":538},"    \"expirationAt\": \"2027-01-01T00:00:00Z\"\n",[276,3367,3368,3370],{"class":278,"line":2389},[276,3369,598],{"class":538},[276,3371,601],{"class":282},[520,3373,3375],{"id":3374},"top-up-credits","Top Up Credits",[162,3377,3379],{"className":526,"code":3378,"language":528,"meta":171,"style":171},"curl -X POST http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fwallets\u002Ftransactions \\\n  -H \"Authorization: Bearer sk_live_...\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{\n    \"walletId\": \"wallet_abc\",\n    \"paidCredits\": 50,\n    \"grantedCredits\": 5\n  }'\n",[169,3380,3381,3394,3406,3418,3426,3431,3436,3441],{"__ignoreMap":171},[276,3382,3383,3385,3387,3389,3392],{"class":278,"line":279},[276,3384,535],{"class":333},[276,3386,539],{"class":538},[276,3388,542],{"class":538},[276,3390,3391],{"class":538}," http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fwallets\u002Ftransactions",[276,3393,548],{"class":305},[276,3395,3396,3398,3400,3402,3404],{"class":278,"line":286},[276,3397,553],{"class":538},[276,3399,556],{"class":282},[276,3401,244],{"class":538},[276,3403,296],{"class":282},[276,3405,548],{"class":305},[276,3407,3408,3410,3412,3414,3416],{"class":278,"line":312},[276,3409,553],{"class":538},[276,3411,556],{"class":282},[276,3413,559],{"class":538},[276,3415,296],{"class":282},[276,3417,548],{"class":305},[276,3419,3420,3422,3424],{"class":278,"line":327},[276,3421,568],{"class":538},[276,3423,571],{"class":282},[276,3425,283],{"class":538},[276,3427,3428],{"class":278,"line":348},[276,3429,3430],{"class":538},"    \"walletId\": \"wallet_abc\",\n",[276,3432,3433],{"class":278,"line":365},[276,3434,3435],{"class":538},"    \"paidCredits\": 50,\n",[276,3437,3438],{"class":278,"line":382},[276,3439,3440],{"class":538},"    \"grantedCredits\": 5\n",[276,3442,3443,3445],{"class":278,"line":397},[276,3444,598],{"class":538},[276,3446,601],{"class":282},[423,3448],{},[157,3450,113],{"id":3451},"analytics",[138,3453,3454],{},"Revenue, subscription, customer, and payment analytics with optional date range filtering.",[188,3456,3457,3467],{},[191,3458,3459],{},[194,3460,3461,3463,3465],{},[197,3462,199],{},[197,3464,442],{},[197,3466,445],{},[207,3468,3469,3483,3497,3511],{},[194,3470,3471,3475,3480],{},[212,3472,3473],{},[169,3474,676],{},[212,3476,3477],{},[169,3478,3479],{},"\u002Fanalytics\u002Frevenue",[212,3481,3482],{},"Revenue analytics (totalRevenue, MRR)",[194,3484,3485,3489,3494],{},[212,3486,3487],{},[169,3488,676],{},[212,3490,3491],{},[169,3492,3493],{},"\u002Fanalytics\u002Fsubscriptions",[212,3495,3496],{},"Subscription breakdown (active, canceled, etc.)",[194,3498,3499,3503,3508],{},[212,3500,3501],{},[169,3502,676],{},[212,3504,3505],{},[169,3506,3507],{},"\u002Fanalytics\u002Fcustomers",[212,3509,3510],{},"Customer analytics (total, new, churned)",[194,3512,3513,3517,3522],{},[212,3514,3515],{},[169,3516,676],{},[212,3518,3519],{},[169,3520,3521],{},"\u002Fanalytics\u002Fpayments",[212,3523,3524],{},"Payment analytics (success rate, volume)",[138,3526,3527,3528,3531,3532,3535],{},"All analytics endpoints accept optional ",[169,3529,3530],{},"dateFrom"," and ",[169,3533,3534],{},"dateTo"," query parameters for date-range filtering.",[423,3537],{},[157,3539,73],{"id":3540},"customer-portal",[138,3542,3543],{},"Public-facing endpoints for customer self-service billing (authenticated via API key).",[188,3545,3546,3556],{},[191,3547,3548],{},[194,3549,3550,3552,3554],{},[197,3551,199],{},[197,3553,442],{},[197,3555,445],{},[207,3557,3558,3572,3586,3600,3614],{},[194,3559,3560,3564,3569],{},[212,3561,3562],{},[169,3563,676],{},[212,3565,3566],{},[169,3567,3568],{},"\u002Fportal\u002Fcustomers\u002F:externalId\u002Fbilling",[212,3570,3571],{},"Customer billing overview",[194,3573,3574,3578,3583],{},[212,3575,3576],{},[169,3577,676],{},[212,3579,3580],{},[169,3581,3582],{},"\u002Fportal\u002Fcustomers\u002F:externalId\u002Fsubscriptions",[212,3584,3585],{},"List customer subscriptions",[194,3587,3588,3592,3597],{},[212,3589,3590],{},[169,3591,676],{},[212,3593,3594],{},[169,3595,3596],{},"\u002Fportal\u002Fcustomers\u002F:externalId\u002Finvoices",[212,3598,3599],{},"List customer invoices",[194,3601,3602,3606,3611],{},[212,3603,3604],{},[169,3605,454],{},[212,3607,3608],{},[169,3609,3610],{},"\u002Fportal\u002Fcustomers\u002F:externalId\u002Finvoices\u002F:invoiceId\u002Fcheckout",[212,3612,3613],{},"Create checkout for an invoice",[194,3615,3616,3620,3625],{},[212,3617,3618],{},[169,3619,676],{},[212,3621,3622],{},[169,3623,3624],{},"\u002Fportal\u002Fcustomers\u002F:externalId\u002Fpayments",[212,3626,3627],{},"List customer payments",[423,3629],{},[157,3631,3633],{"id":3632},"webhooks-inbound","Webhooks (Inbound)",[138,3635,3636],{},"Endpoints that receive payment provider webhook notifications. These are public and use provider-specific signature verification.",[188,3638,3639,3649],{},[191,3640,3641],{},[194,3642,3643,3645,3647],{},[197,3644,199],{},[197,3646,442],{},[197,3648,445],{},[207,3650,3651,3665,3679,3693,3707],{},[194,3652,3653,3657,3662],{},[212,3654,3655],{},[169,3656,454],{},[212,3658,3659],{},[169,3660,3661],{},"\u002Fwebhooks\u002Fstripe",[212,3663,3664],{},"Stripe webhook receiver",[194,3666,3667,3671,3676],{},[212,3668,3669],{},[169,3670,454],{},[212,3672,3673],{},[169,3674,3675],{},"\u002Fwebhooks\u002Fpaystack",[212,3677,3678],{},"Paystack webhook receiver",[194,3680,3681,3685,3690],{},[212,3682,3683],{},[169,3684,454],{},[212,3686,3687],{},[169,3688,3689],{},"\u002Fwebhooks\u002Fflutterwave",[212,3691,3692],{},"Flutterwave webhook receiver",[194,3694,3695,3699,3704],{},[212,3696,3697],{},[169,3698,454],{},[212,3700,3701],{},[169,3702,3703],{},"\u002Fwebhooks\u002Fpaypal",[212,3705,3706],{},"PayPal webhook receiver",[194,3708,3709,3713,3718],{},[212,3710,3711],{},[169,3712,454],{},[212,3714,3715],{},[169,3716,3717],{},"\u002Fwebhooks\u002Fpesapal",[212,3719,3720],{},"Pesapal notification receiver",[423,3722],{},[157,3724,3726],{"id":3725},"openapi-spec","OpenAPI Spec",[138,3728,3729],{},"The raw OpenAPI 3.0 specification is available at:",[162,3731,3734],{"className":3732,"code":3733,"language":167},[165],"GET http:\u002F\u002Flocalhost:4000\u002Fapi\u002Fopenapi.json\n",[169,3735,3733],{"__ignoreMap":171},[3737,3738,3739],"style",{},"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 .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 .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .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}",{"title":171,"searchDepth":286,"depth":286,"links":3741},[3742,3743,3744,3745,3746,3750,3751,3754,3757,3760,3761,3764,3765,3768,3771,3774,3775,3776,3777,3781,3782,3783,3784],{"id":159,"depth":286,"text":160},{"id":183,"depth":286,"text":18},{"id":263,"depth":286,"text":264},{"id":409,"depth":286,"text":410},{"id":427,"depth":286,"text":428,"children":3747},[3748,3749],{"id":522,"depth":312,"text":523},{"id":604,"depth":312,"text":605},{"id":651,"depth":286,"text":652},{"id":773,"depth":286,"text":53,"children":3752},[3753],{"id":902,"depth":312,"text":903},{"id":1168,"depth":286,"text":1169,"children":3755},[3756],{"id":1297,"depth":312,"text":1298},{"id":1564,"depth":286,"text":101,"children":3758},[3759],{"id":1694,"depth":312,"text":1695},{"id":1815,"depth":286,"text":1816},{"id":1963,"depth":286,"text":1964,"children":3762},[3763],{"id":2026,"depth":312,"text":2027},{"id":2085,"depth":286,"text":109},{"id":2188,"depth":286,"text":2189,"children":3766},[3767],{"id":2300,"depth":312,"text":2301},{"id":2398,"depth":286,"text":2399,"children":3769},[3770],{"id":2475,"depth":312,"text":2476},{"id":2561,"depth":286,"text":2562,"children":3772},[3773],{"id":2683,"depth":312,"text":2684},{"id":2791,"depth":286,"text":2792},{"id":2909,"depth":286,"text":2910},{"id":3041,"depth":286,"text":3042},{"id":3163,"depth":286,"text":3164,"children":3778},[3779,3780],{"id":3279,"depth":312,"text":3280},{"id":3374,"depth":312,"text":3375},{"id":3451,"depth":286,"text":113},{"id":3540,"depth":286,"text":73},{"id":3632,"depth":286,"text":3633},{"id":3725,"depth":286,"text":3726},"Complete API documentation for PimaBill — 107 endpoints across 18 controllers.","md",null,{},{"title":129,"description":3785},"YOlwM2ybE3iqZ_BT03Qc--3_fx8f4_X1brLbGyrtHM8",[3792,3787],{"title":125,"path":126,"stem":127,"description":3793,"children":-1},"Collect one-time payments, send payouts, move money between wallets, and use managed payments when you have no provider account.",1793401244507]