[{"data":1,"prerenderedAt":1237},["ShallowReactive",2],{"navigation-docs_v2":3,"\u002Fv2\u002Fgeneral\u002Fcustomer-portal":148,"\u002Fv2\u002Fgeneral\u002Fcustomer-portal-surround":1232},[4],{"title":5,"path":6,"stem":7,"children":8,"page":68},"V2","\u002Fv2","v2",[9,27,69,106,123,140],{"title":10,"path":11,"stem":12,"children":13},"Introduction","\u002Fv2\u002Foverview","v2\u002F1.overview\u002F1.index",[14,15,19,23],{"title":10,"path":11,"stem":12},{"title":16,"path":17,"stem":18},"Test Details","\u002Fv2\u002Foverview\u002Ftest-details","v2\u002F1.overview\u002F2.test-details",{"title":20,"path":21,"stem":22},"Errors","\u002Fv2\u002Foverview\u002Ferror-handling","v2\u002F1.overview\u002F3.error-handling",{"title":24,"path":25,"stem":26},"Migrate from V1","\u002Fv2\u002Foverview\u002Fmigrate-from-v1","v2\u002F1.overview\u002F4.migrate-from-v1",{"title":28,"path":29,"stem":30,"children":31,"page":68},"General","\u002Fv2\u002Fgeneral","v2\u002F2.general",[32,36,40,44,48,52,56,60,64],{"title":33,"path":34,"stem":35},"Lookups","\u002Fv2\u002Fgeneral\u002Flookups","v2\u002F2.general\u002F1.lookups",{"title":37,"path":38,"stem":39},"Customer Portal","\u002Fv2\u002Fgeneral\u002Fcustomer-portal","v2\u002F2.general\u002F11.customer-portal",{"title":41,"path":42,"stem":43},"Payment Methods","\u002Fv2\u002Fgeneral\u002Fpayment-methods","v2\u002F2.general\u002F2.payment-methods",{"title":45,"path":46,"stem":47},"Customers","\u002Fv2\u002Fgeneral\u002Fcustomers","v2\u002F2.general\u002F3.customers",{"title":49,"path":50,"stem":51},"Bank Accounts","\u002Fv2\u002Fgeneral\u002Fbank-accounts","v2\u002F2.general\u002F4.bank-accounts",{"title":53,"path":54,"stem":55},"Cards","\u002Fv2\u002Fgeneral\u002Fcards","v2\u002F2.general\u002F5.cards",{"title":57,"path":58,"stem":59},"Mandates","\u002Fv2\u002Fgeneral\u002Fmandates","v2\u002F2.general\u002F6.mandates",{"title":61,"path":62,"stem":63},"Products","\u002Fv2\u002Fgeneral\u002Fproducts","v2\u002F2.general\u002F8.products",{"title":65,"path":66,"stem":67},"Transactions","\u002Fv2\u002Fgeneral\u002Ftransactions","v2\u002F2.general\u002F9.transactions",false,{"title":70,"path":71,"stem":72,"children":73,"page":68},"Money In","\u002Fv2\u002Fmoney-in","v2\u002F3.money-in",[74,78,82,86,90,94,98,102],{"title":75,"path":76,"stem":77},"Collections","\u002Fv2\u002Fmoney-in\u002Fcollections","v2\u002F3.money-in\u002F1.collections",{"title":79,"path":80,"stem":81},"Electronic Mandates","\u002Fv2\u002Fmoney-in\u002Felectronic-mandates","v2\u002F3.money-in\u002F2.electronic-mandates",{"title":83,"path":84,"stem":85},"Subscriptions","\u002Fv2\u002Fmoney-in\u002Fsubscriptions","v2\u002F3.money-in\u002F3.subscriptions",{"title":87,"path":88,"stem":89},"Checkout Link","\u002Fv2\u002Fmoney-in\u002Fcheckout-link","v2\u002F3.money-in\u002F4.checkout-link",{"title":91,"path":92,"stem":93},"Checkout Form","\u002Fv2\u002Fmoney-in\u002Fcheckout-form","v2\u002F3.money-in\u002F5.checkout-form",{"title":95,"path":96,"stem":97},"Card Vault Link","\u002Fv2\u002Fmoney-in\u002Fcard-vault-link","v2\u002F3.money-in\u002F6.card-vault-link",{"title":99,"path":100,"stem":101},"Card Vault Charge","\u002Fv2\u002Fmoney-in\u002Fcard-vault-charge","v2\u002F3.money-in\u002F7.card-vault-charge",{"title":103,"path":104,"stem":105},"Card Vault Pre-Auth","\u002Fv2\u002Fmoney-in\u002Fcard-vault-pre-auth","v2\u002F3.money-in\u002F8.card-vault-pre-auth",{"title":107,"path":108,"stem":109,"children":110,"page":68},"Money Out","\u002Fv2\u002Fmoney-out","v2\u002F4.money-out",[111,115,119],{"title":112,"path":113,"stem":114},"Payouts","\u002Fv2\u002Fmoney-out\u002Fpayouts","v2\u002F4.money-out\u002F1.payouts",{"title":116,"path":117,"stem":118},"Recipients","\u002Fv2\u002Fmoney-out\u002Frecipients","v2\u002F4.money-out\u002F2.recipients",{"title":120,"path":121,"stem":122},"Refunds","\u002Fv2\u002Fmoney-out\u002Frefunds","v2\u002F4.money-out\u002F3.refunds",{"title":124,"path":125,"stem":126,"children":127,"page":68},"Verification","\u002Fv2\u002Fverification","v2\u002F5.verification",[128,132,136],{"title":129,"path":130,"stem":131},"CDV","\u002Fv2\u002Fverification\u002Fcdv","v2\u002F5.verification\u002F1.cdv",{"title":133,"path":134,"stem":135},"AVS-R","\u002Fv2\u002Fverification\u002Favs-r","v2\u002F5.verification\u002F2.avs-r",{"title":137,"path":138,"stem":139},"SDO","\u002Fv2\u002Fverification\u002Fsdo","v2\u002F5.verification\u002F3.sdo",{"title":141,"path":142,"stem":143,"children":144,"page":68},"Webhooks","\u002Fv2\u002Fwebhooks","v2\u002F6.webhooks",[145],{"title":141,"path":146,"stem":147},"\u002Fv2\u002Fwebhooks\u002Fwebhooks","v2\u002F6.webhooks\u002F1.webhooks",{"id":149,"title":37,"body":150,"description":1225,"extension":1226,"links":1227,"meta":1228,"navigation":1229,"path":38,"seo":1230,"stem":39,"__hash__":1231},"docs_v2\u002Fv2\u002F2.general\u002F11.customer-portal.md",{"type":151,"value":152,"toc":1214},"minimark",[153,159,164,168,173,183,187,198,249,253,262,313,317,320,323,569,573,589,813,816,850,852,885,887,927,931,1092,1096,1210],[154,155],"img",{"src":156,"alt":157,"width":158},"\u002Fimg\u002Fcustomer-portal-link.png","Customer portal link",400,[160,161,163],"h2",{"id":162},"request","Request",[165,166,167],"p",{},"Request to generate a customer postal page session URL.",[169,170,172],"h3",{"id":171},"path","Path",[165,174,175,179,180],{},[176,177,178],"code",{},"POST"," ",[176,181,182],{},"\u002Fcustomer-portal\u002Flink",[169,184,186],{"id":185},"example-no-subscription","Example (No Subscription)",[165,188,189,190,193,194,197],{},"The example below only includes the ",[176,191,192],{},"customer_id",". When no ",[176,195,196],{},"subscription_id"," is provided, the customer will be presented with the available packages and can create a new subscription.",[199,200,205],"pre",{"className":201,"code":202,"language":203,"meta":204,"style":204},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"customer_id\": \"cus_abc123...\",\n}\n","json","",[176,206,207,216,243],{"__ignoreMap":204},[208,209,212],"span",{"class":210,"line":211},"line",1,[208,213,215],{"class":214},"sMK4o","{\n",[208,217,219,222,225,228,231,234,238,240],{"class":210,"line":218},2,[208,220,221],{"class":214},"  \"",[208,223,192],{"class":224},"spNyl",[208,226,227],{"class":214},"\"",[208,229,230],{"class":214},":",[208,232,233],{"class":214}," \"",[208,235,237],{"class":236},"sfazB","cus_abc123...",[208,239,227],{"class":214},[208,241,242],{"class":214},",\n",[208,244,246],{"class":210,"line":245},3,[208,247,248],{"class":214},"}\n",[169,250,252],{"id":251},"example-subscription","Example (Subscription)",[165,254,255,256,258,259,261],{},"The example below includes both the ",[176,257,192],{}," and ",[176,260,196],{},". This allows the customer to manage a specific subscription. If the subscription is inactive, the customer will have the option to reactivate it.",[199,263,265],{"className":201,"code":264,"language":203,"meta":204,"style":204},"{\n  \"customer_id\": \"cus_abc123...\",\n  \"subscription_id\": \"sub_abc123...\",\n}\n",[176,266,267,271,289,308],{"__ignoreMap":204},[208,268,269],{"class":210,"line":211},[208,270,215],{"class":214},[208,272,273,275,277,279,281,283,285,287],{"class":210,"line":218},[208,274,221],{"class":214},[208,276,192],{"class":224},[208,278,227],{"class":214},[208,280,230],{"class":214},[208,282,233],{"class":214},[208,284,237],{"class":236},[208,286,227],{"class":214},[208,288,242],{"class":214},[208,290,291,293,295,297,299,301,304,306],{"class":210,"line":245},[208,292,221],{"class":214},[208,294,196],{"class":224},[208,296,227],{"class":214},[208,298,230],{"class":214},[208,300,233],{"class":214},[208,302,303],{"class":236},"sub_abc123...",[208,305,227],{"class":214},[208,307,242],{"class":214},[208,309,311],{"class":210,"line":310},4,[208,312,248],{"class":214},[169,314,316],{"id":315},"example-advanced-settings","Example (Advanced settings)",[165,318,319],{},"The example below demonstrates how to override the default settings configured in the dashboard. This can be useful when you need to disable specific features for certain customers or subscriptions, or when different products should be displayed for a particular subscription.",[165,321,322],{},"Note that the default settings can be updated on the portal under Settings -> Customer Portal.",[199,324,326],{"className":201,"code":325,"language":203,"meta":204,"style":204},"{\n  \"customer_id\": \"cus_abc123...\",\n  \"subscription_id\": \"sub_abc123...\",\n  \"settings\": {\n    \"show_invoices\": true, \u002F\u002F allow the user to view the invoices\n    \"billing_info_type\": \"UPDATE\", \u002F\u002F Allow the user to update billing info on page\n    \"cancel_type\": \"END_OF_PERIOD\", \u002F\u002F The plan will be scheduled to be canceled at the end of the billing period\n    \"plan_change_type\": \"SMART\", \u002F\u002F When a plan is changed, how should the calculations be handled\n    \"available_product_ids\": [\"pro_abc123...\", \"pro_abc123...\"], \u002F\u002F Specify available products that the user can select as a plan. This will be grouped by interval and ordered from the smallest amount to largest\n    \"redirect_url\": \"https:\u002F\u002Fmy-portal.site.com\", \u002F\u002F Back to site link\n    \"page_title\": \"My SaaS business\" \u002F\u002F Specify the left side page title\n  }\n}\n",[176,327,328,332,350,368,382,403,428,452,476,512,536,558,564],{"__ignoreMap":204},[208,329,330],{"class":210,"line":211},[208,331,215],{"class":214},[208,333,334,336,338,340,342,344,346,348],{"class":210,"line":218},[208,335,221],{"class":214},[208,337,192],{"class":224},[208,339,227],{"class":214},[208,341,230],{"class":214},[208,343,233],{"class":214},[208,345,237],{"class":236},[208,347,227],{"class":214},[208,349,242],{"class":214},[208,351,352,354,356,358,360,362,364,366],{"class":210,"line":245},[208,353,221],{"class":214},[208,355,196],{"class":224},[208,357,227],{"class":214},[208,359,230],{"class":214},[208,361,233],{"class":214},[208,363,303],{"class":236},[208,365,227],{"class":214},[208,367,242],{"class":214},[208,369,370,372,375,377,379],{"class":210,"line":310},[208,371,221],{"class":214},[208,373,374],{"class":224},"settings",[208,376,227],{"class":214},[208,378,230],{"class":214},[208,380,381],{"class":214}," {\n",[208,383,385,388,392,394,396,399],{"class":210,"line":384},5,[208,386,387],{"class":214},"    \"",[208,389,391],{"class":390},"sBMFI","show_invoices",[208,393,227],{"class":214},[208,395,230],{"class":214},[208,397,398],{"class":214}," true,",[208,400,402],{"class":401},"sHwdD"," \u002F\u002F allow the user to view the invoices\n",[208,404,406,408,411,413,415,417,420,422,425],{"class":210,"line":405},6,[208,407,387],{"class":214},[208,409,410],{"class":390},"billing_info_type",[208,412,227],{"class":214},[208,414,230],{"class":214},[208,416,233],{"class":214},[208,418,419],{"class":236},"UPDATE",[208,421,227],{"class":214},[208,423,424],{"class":214},",",[208,426,427],{"class":401}," \u002F\u002F Allow the user to update billing info on page\n",[208,429,431,433,436,438,440,442,445,447,449],{"class":210,"line":430},7,[208,432,387],{"class":214},[208,434,435],{"class":390},"cancel_type",[208,437,227],{"class":214},[208,439,230],{"class":214},[208,441,233],{"class":214},[208,443,444],{"class":236},"END_OF_PERIOD",[208,446,227],{"class":214},[208,448,424],{"class":214},[208,450,451],{"class":401}," \u002F\u002F The plan will be scheduled to be canceled at the end of the billing period\n",[208,453,455,457,460,462,464,466,469,471,473],{"class":210,"line":454},8,[208,456,387],{"class":214},[208,458,459],{"class":390},"plan_change_type",[208,461,227],{"class":214},[208,463,230],{"class":214},[208,465,233],{"class":214},[208,467,468],{"class":236},"SMART",[208,470,227],{"class":214},[208,472,424],{"class":214},[208,474,475],{"class":401}," \u002F\u002F When a plan is changed, how should the calculations be handled\n",[208,477,479,481,484,486,488,491,493,496,498,500,502,504,506,509],{"class":210,"line":478},9,[208,480,387],{"class":214},[208,482,483],{"class":390},"available_product_ids",[208,485,227],{"class":214},[208,487,230],{"class":214},[208,489,490],{"class":214}," [",[208,492,227],{"class":214},[208,494,495],{"class":236},"pro_abc123...",[208,497,227],{"class":214},[208,499,424],{"class":214},[208,501,233],{"class":214},[208,503,495],{"class":236},[208,505,227],{"class":214},[208,507,508],{"class":214},"],",[208,510,511],{"class":401}," \u002F\u002F Specify available products that the user can select as a plan. This will be grouped by interval and ordered from the smallest amount to largest\n",[208,513,515,517,520,522,524,526,529,531,533],{"class":210,"line":514},10,[208,516,387],{"class":214},[208,518,519],{"class":390},"redirect_url",[208,521,227],{"class":214},[208,523,230],{"class":214},[208,525,233],{"class":214},[208,527,528],{"class":236},"https:\u002F\u002Fmy-portal.site.com",[208,530,227],{"class":214},[208,532,424],{"class":214},[208,534,535],{"class":401}," \u002F\u002F Back to site link\n",[208,537,539,541,544,546,548,550,553,555],{"class":210,"line":538},11,[208,540,387],{"class":214},[208,542,543],{"class":390},"page_title",[208,545,227],{"class":214},[208,547,230],{"class":214},[208,549,233],{"class":214},[208,551,552],{"class":236},"My SaaS business",[208,554,227],{"class":214},[208,556,557],{"class":401}," \u002F\u002F Specify the left side page title\n",[208,559,561],{"class":210,"line":560},12,[208,562,563],{"class":214},"  }\n",[208,565,567],{"class":210,"line":566},13,[208,568,248],{"class":214},[169,570,572],{"id":571},"request-parameters","Request Parameters",[165,574,575,576,580,581,584,585,588],{},"Request field details. ",[577,578,579],"strong",{},"Y"," = always required, ",[577,582,583],{},"C"," = conditional, ",[577,586,587],{},"N"," = optional.",[590,591,592,622],"table",{},[593,594,595],"thead",{},[596,597,598,607,610,613,619],"tr",{},[599,600,602],"th",{"align":601},"left",[603,604,606],"div",{"style":605},"width:120px","Field",[599,608,609],{"align":601},"Required",[599,611,612],{"align":601},"Type",[599,614,615],{"align":601},[603,616,618],{"style":617},"width:350px","Description",[599,620,621],{"align":601},"Example",[623,624,625,640,653,668,684,711,734,758,776,799],"tbody",{},[596,626,627,630,632,635,638],{},[628,629,192],"td",{"align":601},[628,631,579],{"align":601},[628,633,634],{"align":601},"String",[628,636,637],{"align":601},"The customer the portal link is generated for",[628,639,237],{"align":601},[596,641,642,644,646,648,651],{},[628,643,196],{"align":601},[628,645,587],{"align":601},[628,647,634],{"align":601},[628,649,650],{"align":601},"Manage a specific subscription. If omitted, the customer can select a package to create a new subscription. If the subscription is inactive, the user can reactivate it.",[628,652,303],{"align":601},[596,654,655,657,659,662,665],{},[628,656,374],{"align":601},[628,658,587],{"align":601},[628,660,661],{"align":601},"Object",[628,663,664],{"align":601},"Override the default portal settings. Omit to use your account defaults.",[628,666,667],{"align":601},"See advanced example",[596,669,670,673,675,678,681],{},[628,671,672],{"align":601},"settings.show_invoices",[628,674,587],{"align":601},[628,676,677],{"align":601},"Boolean",[628,679,680],{"align":601},"Allow the user to view their invoices",[628,682,683],{"align":601},"true",[596,685,686,689,691,694,707],{},[628,687,688],{"align":601},"settings.billing_info_type",[628,690,587],{"align":601},[628,692,693],{"align":601},"ENUM",[628,695,696,697,700,701,700,704,706],{"align":601},"Controls access to billing information. Available values: ",[176,698,699],{},"NONE",", ",[176,702,703],{},"VIEW",[176,705,419],{},".",[628,708,709],{"align":601},[176,710,419],{},[596,712,713,716,718,720,730],{},[628,714,715],{"align":601},"settings.cancel_type",[628,717,587],{"align":601},[628,719,693],{"align":601},[628,721,722,723,700,725,700,728,706],{"align":601},"Controls subscription cancellation. Available values: ",[176,724,699],{},[176,726,727],{},"IMMEDIATE",[176,729,444],{},[628,731,732],{"align":601},[176,733,444],{},[596,735,736,739,741,743,754],{},[628,737,738],{"align":601},"settings.plan_change_type",[628,740,587],{"align":601},[628,742,693],{"align":601},[628,744,745,746,700,748,700,750,700,752,706],{"align":601},"Controls how subscription plan changes are handled. Available values: ",[176,747,699],{},[176,749,727],{},[176,751,444],{},[176,753,468],{},[628,755,756],{"align":601},[176,757,468],{},[596,759,760,763,765,768,771],{},[628,761,762],{"align":601},"settings.available_product_ids",[628,764,587],{"align":601},[628,766,767],{"align":601},"Array",[628,769,770],{"align":601},"Product IDs available for selection. Products are grouped by billing interval and ordered from the lowest price to the highest price.",[628,772,773],{"align":601},[208,774,775],{},"\"pro_abc123...\", \"pro_def456...\"",[596,777,778,781,783,785,792],{},[628,779,780],{"align":601},"settings.redirect_url",[628,782,587],{"align":601},[628,784,634],{"align":601},[628,786,787,788,791],{"align":601},"Where the user is redirected when they select ",[577,789,790],{},"Back to Site"," or close the portal.",[628,793,794],{"align":601},[795,796,528],"a",{"href":528,"rel":797},[798],"nofollow",[596,800,801,804,806,808,811],{},[628,802,803],{"align":601},"settings.page_title",[628,805,587],{"align":601},[628,807,634],{"align":601},[628,809,810],{"align":601},"Override the page title displayed on the left side of the portal.",[628,812,552],{"align":601},[814,815,410],"h4",{"id":410},[590,817,818,827],{},[593,819,820],{},[596,821,822,825],{},[599,823,824],{"align":601},"Value",[599,826,618],{"align":601},[623,828,829,836,843],{},[596,830,831,833],{},[628,832,699],{"align":601},[628,834,835],{"align":601},"Hide billing information",[596,837,838,840],{},[628,839,703],{"align":601},[628,841,842],{"align":601},"Allow the user to view billing information",[596,844,845,847],{},[628,846,419],{"align":601},[628,848,849],{"align":601},"Allow the user to view and update billing information",[814,851,435],{"id":435},[590,853,854,862],{},[593,855,856],{},[596,857,858,860],{},[599,859,824],{"align":601},[599,861,618],{"align":601},[623,863,864,871,878],{},[596,865,866,868],{},[628,867,699],{"align":601},[628,869,870],{"align":601},"Subscription cannot be cancelled",[596,872,873,875],{},[628,874,727],{"align":601},[628,876,877],{"align":601},"Cancel the subscription immediately",[596,879,880,882],{},[628,881,444],{"align":601},[628,883,884],{"align":601},"Cancel the subscription when the current billing period ends",[814,886,459],{"id":459},[590,888,889,897],{},[593,890,891],{},[596,892,893,895],{},[599,894,824],{"align":601},[599,896,618],{"align":601},[623,898,899,906,913,920],{},[596,900,901,903],{},[628,902,699],{"align":601},[628,904,905],{"align":601},"Subscription plan cannot be changed",[596,907,908,910],{},[628,909,727],{"align":601},[628,911,912],{"align":601},"Any plan change takes effect immediately",[596,914,915,917],{},[628,916,444],{"align":601},[628,918,919],{"align":601},"Any plan change takes effect when the current billing period ends",[596,921,922,924],{},[628,923,468],{"align":601},[628,925,926],{"align":601},"Upgrades take effect immediately with prorated billing. Downgrades take effect when the current billing period ends.",[169,928,930],{"id":929},"response-body","Response Body",[199,932,934],{"className":201,"code":933,"language":203,"meta":204,"style":204},"{\n    \"status\": true,\n    \"result\": {\n      \"id\": \"cpl_HVpCeoNys1f22X7QcuWHY\",\n      \"session_id\": \"ses_G-xkVKoxHgEBrY8suKgR3\",\n      \"customer_id\": \"cus_abc123...\",\n      \"subscription_id\": \"sub_abc123...\",\n      \"link_url\": \"https:\u002F\u002Fpay.kwik.co.za\u002Fportal\u002Fa0oDxntJxWlA8LjfOR9bgck9C4w....\",\n      \"expires_at\": \"2026-03-13T12:30:00Z\"\n    }\n}\n",[176,935,936,940,954,967,988,1008,1026,1044,1064,1083,1088],{"__ignoreMap":204},[208,937,938],{"class":210,"line":211},[208,939,215],{"class":214},[208,941,942,944,947,949,951],{"class":210,"line":218},[208,943,387],{"class":214},[208,945,946],{"class":224},"status",[208,948,227],{"class":214},[208,950,230],{"class":214},[208,952,953],{"class":214}," true,\n",[208,955,956,958,961,963,965],{"class":210,"line":245},[208,957,387],{"class":214},[208,959,960],{"class":224},"result",[208,962,227],{"class":214},[208,964,230],{"class":214},[208,966,381],{"class":214},[208,968,969,972,975,977,979,981,984,986],{"class":210,"line":310},[208,970,971],{"class":214},"      \"",[208,973,974],{"class":390},"id",[208,976,227],{"class":214},[208,978,230],{"class":214},[208,980,233],{"class":214},[208,982,983],{"class":236},"cpl_HVpCeoNys1f22X7QcuWHY",[208,985,227],{"class":214},[208,987,242],{"class":214},[208,989,990,992,995,997,999,1001,1004,1006],{"class":210,"line":384},[208,991,971],{"class":214},[208,993,994],{"class":390},"session_id",[208,996,227],{"class":214},[208,998,230],{"class":214},[208,1000,233],{"class":214},[208,1002,1003],{"class":236},"ses_G-xkVKoxHgEBrY8suKgR3",[208,1005,227],{"class":214},[208,1007,242],{"class":214},[208,1009,1010,1012,1014,1016,1018,1020,1022,1024],{"class":210,"line":405},[208,1011,971],{"class":214},[208,1013,192],{"class":390},[208,1015,227],{"class":214},[208,1017,230],{"class":214},[208,1019,233],{"class":214},[208,1021,237],{"class":236},[208,1023,227],{"class":214},[208,1025,242],{"class":214},[208,1027,1028,1030,1032,1034,1036,1038,1040,1042],{"class":210,"line":430},[208,1029,971],{"class":214},[208,1031,196],{"class":390},[208,1033,227],{"class":214},[208,1035,230],{"class":214},[208,1037,233],{"class":214},[208,1039,303],{"class":236},[208,1041,227],{"class":214},[208,1043,242],{"class":214},[208,1045,1046,1048,1051,1053,1055,1057,1060,1062],{"class":210,"line":454},[208,1047,971],{"class":214},[208,1049,1050],{"class":390},"link_url",[208,1052,227],{"class":214},[208,1054,230],{"class":214},[208,1056,233],{"class":214},[208,1058,1059],{"class":236},"https:\u002F\u002Fpay.kwik.co.za\u002Fportal\u002Fa0oDxntJxWlA8LjfOR9bgck9C4w....",[208,1061,227],{"class":214},[208,1063,242],{"class":214},[208,1065,1066,1068,1071,1073,1075,1077,1080],{"class":210,"line":478},[208,1067,971],{"class":214},[208,1069,1070],{"class":390},"expires_at",[208,1072,227],{"class":214},[208,1074,230],{"class":214},[208,1076,233],{"class":214},[208,1078,1079],{"class":236},"2026-03-13T12:30:00Z",[208,1081,1082],{"class":214},"\"\n",[208,1084,1085],{"class":210,"line":514},[208,1086,1087],{"class":214},"    }\n",[208,1089,1090],{"class":210,"line":538},[208,1091,248],{"class":214},[169,1093,1095],{"id":1094},"response-parameters","Response Parameters",[590,1097,1098,1116],{},[593,1099,1100],{},[596,1101,1102,1107,1109,1114],{},[599,1103,1104],{"align":601},[603,1105,606],{"style":1106},"width:100px",[599,1108,612],{"align":601},[599,1110,1111],{"align":601},[603,1112,618],{"style":1113},"width:300px",[599,1115,621],{"align":601},[623,1117,1118,1129,1141,1154,1166,1181,1198],{},[596,1119,1120,1122,1124,1127],{},[628,1121,946],{"align":601},[628,1123,677],{"align":601},[628,1125,1126],{"align":601},"Indicates if the request was successful",[628,1128,683],{"align":601},[596,1130,1131,1134,1136,1139],{},[628,1132,1133],{"align":601},"result.id",[628,1135,634],{"align":601},[628,1137,1138],{"align":601},"Unique customer portal link identifier",[628,1140,983],{"align":601},[596,1142,1143,1146,1149,1152],{},[628,1144,1145],{"align":601},"result.session_id",[628,1147,1148],{"align":601},"String(32)",[628,1150,1151],{"align":601},"Session identifier for the portal link",[628,1153,1003],{"align":601},[596,1155,1156,1159,1161,1164],{},[628,1157,1158],{"align":601},"result.customer_id",[628,1160,1148],{"align":601},[628,1162,1163],{"align":601},"Associated customer ID",[628,1165,237],{"align":601},[596,1167,1168,1171,1173,1179],{},[628,1169,1170],{"align":601},"result.subscription_id",[628,1172,1148],{"align":601},[628,1174,1175,1176,1178],{"align":601},"Associated subscription ID, when a ",[176,1177,196],{}," was supplied",[628,1180,303],{"align":601},[596,1182,1183,1186,1188,1191],{},[628,1184,1185],{"align":601},"result.link_url",[628,1187,634],{"align":601},[628,1189,1190],{"align":601},"URL to redirect the user to the customer portal",[628,1192,1193,1197],{"align":601},[795,1194,1195],{"href":1195,"rel":1196},"https:\u002F\u002Fpay.kwik.co.za\u002Fportal\u002Fa0oDxntJxWlA8LjfOR9bgck9C4w",[798],"....",[596,1199,1200,1203,1205,1208],{},[628,1201,1202],{"align":601},"result.expires_at",[628,1204,634],{"align":601},[628,1206,1207],{"align":601},"ISO timestamp when the portal link expires",[628,1209,1079],{"align":601},[1211,1212,1213],"style",{},"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 .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}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":204,"searchDepth":211,"depth":218,"links":1215},[1216],{"id":162,"depth":218,"text":163,"children":1217},[1218,1219,1220,1221,1222,1223,1224],{"id":171,"depth":245,"text":172},{"id":185,"depth":245,"text":186},{"id":251,"depth":245,"text":252},{"id":315,"depth":245,"text":316},{"id":571,"depth":245,"text":572},{"id":929,"depth":245,"text":930},{"id":1094,"depth":245,"text":1095},"Create a link for a customer so that they can manage their subscriptions, billing details, invoices and payment methods.","md",null,{},true,{"title":37,"description":1225},"q5X5v5ymObaY-XFXAEEwyPIisJmUHPqj0ryQDVXs_0E",[1233,1235],{"title":33,"path":34,"stem":35,"description":1234,"children":-1},"Retrieve reference data and validation values used across the API including bank names, account types, countries, provinces, client types, and ID types. Essential for populating dropdown lists and validating form inputs.",{"title":41,"path":42,"stem":43,"description":1236,"children":-1},"Retrieve available payment methods including EFT Debit Orders, DebiCheck, Registered Mandates, Card payments, and Pay-in methods. Essential for determining supported banks and payment options for your customers.",1784196440614]