[{"data":1,"prerenderedAt":5503},["ShallowReactive",2],{"navigation-docs_v2":3,"\u002Fv2\u002Fmoney-in\u002Fsubscriptions":148,"\u002Fv2\u002Fmoney-in\u002Fsubscriptions-surround":5498},[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 Link","\u002Fv2\u002Fgeneral\u002Fcustomer-portal-link","v2\u002F2.general\u002F10.customer-portal-link",{"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":83,"body":150,"description":5492,"extension":5493,"links":5494,"meta":5495,"navigation":729,"path":84,"seo":5496,"stem":85,"__hash__":5497},"docs_v2\u002Fv2\u002F3.money-in\u002F3.subscriptions.md",{"type":151,"value":152,"toc":5448},"minimark",[153,158,171,189,209,231,236,245,290,294,297,428,432,438,578,582,585,1355,1359,1375,1887,1891,1921,1930,2477,2481,2824,2828,2842,2856,2859,2866,2894,2897,3006,3009,3078,3081,3266,3269,3377,3381,3394,3397,3404,3431,3434,3441,3472,3475,3600,3604,3614,3617,3624,3651,3654,3658,3704,3707,3838,3842,3848,3851,3858,3885,3888,3892,3965,3968,4030,4033,4179,4182,4299,4303,4324,4328,4339,4343,4349,4369,4373,4878,4882,5221,5225,5401,5405,5408,5433,5437,5444],[154,155,157],"h2",{"id":156},"create-request","Create Request",[159,160,161,162,165,166,170],"p",{},"Request to create a subscription that bills a customer on a recurring schedule. On each billing date the customer's vaulted card(s) are charged automatically — the default card is attempted first, cascading through the remaining active cards in priority order (see ",[163,164,99],"a",{"href":100},"). Pass ",[167,168,169],"code",{},"card_id"," to bill a specific card only (no cascade).",[159,172,173,174,176,177,180,181,184,185,188],{},"Recurring charges are processed as merchant-initiated transactions (MIT) — no 3DS challenge is presented. The 3DS authentication from the original card storage (see ",[163,175,95],{"href":96},") provides the authentication reference for scheme compliance. The customer must therefore have at least one ",[167,178,179],{},"ACTIVE"," vaulted card, unless ",[167,182,183],{},"collection_method"," is ",[167,186,187],{},"REQUEST_PAYMENT",".",[159,190,191,192,196,197,200,201,204,205,208],{},"Line items come from your product catalog — see ",[163,193,195],{"href":194},"\u002Freference\u002Fproducts","products",". Pass a single ",[167,198,199],{},"items"," array; each product's pricing type determines how it is stored and billed: ",[167,202,203],{},"RECURRING"," products bill on every cycle, while ",[167,206,207],{},"ONE_TIME"," products (e.g. a setup fee) are billed on the first cycle only.",[159,210,211,215,216,219,220,223,224,227,228,230],{},[212,213,214],"strong",{},"The billing schedule is determined by the products."," Each recurring product carries its own billing interval (e.g. monthly, yearly, or a custom interval such as every 6 weeks), which populates the subscription's ",[167,217,218],{},"billing.period"," — and ",[167,221,222],{},"billing.custom_interval"," \u002F ",[167,225,226],{},"billing.custom_period"," for custom intervals. You do not pass a period on the request; all ",[167,229,203],{}," products in one subscription must share the same billing interval, otherwise the request is rejected.",[232,233,235],"h3",{"id":234},"path","Path",[159,237,238,241,242],{},[167,239,240],{},"POST"," ",[167,243,244],{},"\u002Fsubscriptions\u002F{customer_id}",[246,247,248,268],"table",{},[249,250,251],"thead",{},[252,253,254,259,262,265],"tr",{},[255,256,258],"th",{"align":257},"left","Path Parameter",[255,260,261],{"align":257},"Type",[255,263,264],{"align":257},"Description",[255,266,267],{"align":257},"Example",[269,270,271],"tbody",{},[252,272,273,277,280,287],{},[274,275,276],"td",{"align":257},"customer_id",[274,278,279],{"align":257},"String(32)",[274,281,282,283],{"align":257},"The customer to subscribe — see ",[163,284,286],{"href":285},"\u002Freference\u002Fcustomers","customers",[274,288,289],{"align":257},"cus_abc123...",[232,291,293],{"id":292},"example-basic","Example (Basic)",[159,295,296],{},"Basic example of a subscription starting today. The billing period comes from the product — a monthly product bills monthly. The customer's default card is charged on each billing date, cascading through fallback cards on decline.",[298,299,304],"pre",{"className":300,"code":301,"language":302,"meta":303,"style":303},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"items\": [\n    {\n      \"product_id\": \"pro_abc123...\", \u002F\u002F RECURRING catalog product; its interval sets the billing period\n      \"qty\": 1 \u002F\u002F default 1 when omitted\n    }\n  ],\n  \"reference\": \"SUB-2026-00042\" \u002F\u002F your reference; appears on statements and reporting\n}\n","json","",[167,305,306,315,333,339,369,388,394,400,422],{"__ignoreMap":303},[307,308,311],"span",{"class":309,"line":310},"line",1,[307,312,314],{"class":313},"sMK4o","{\n",[307,316,318,321,324,327,330],{"class":309,"line":317},2,[307,319,320],{"class":313},"  \"",[307,322,199],{"class":323},"spNyl",[307,325,326],{"class":313},"\"",[307,328,329],{"class":313},":",[307,331,332],{"class":313}," [\n",[307,334,336],{"class":309,"line":335},3,[307,337,338],{"class":313},"    {\n",[307,340,342,345,349,351,353,356,360,362,365],{"class":309,"line":341},4,[307,343,344],{"class":313},"      \"",[307,346,348],{"class":347},"sBMFI","product_id",[307,350,326],{"class":313},[307,352,329],{"class":313},[307,354,355],{"class":313}," \"",[307,357,359],{"class":358},"sfazB","pro_abc123...",[307,361,326],{"class":313},[307,363,364],{"class":313},",",[307,366,368],{"class":367},"sHwdD"," \u002F\u002F RECURRING catalog product; its interval sets the billing period\n",[307,370,372,374,377,379,381,385],{"class":309,"line":371},5,[307,373,344],{"class":313},[307,375,376],{"class":347},"qty",[307,378,326],{"class":313},[307,380,329],{"class":313},[307,382,384],{"class":383},"sbssI"," 1",[307,386,387],{"class":367}," \u002F\u002F default 1 when omitted\n",[307,389,391],{"class":309,"line":390},6,[307,392,393],{"class":313},"    }\n",[307,395,397],{"class":309,"line":396},7,[307,398,399],{"class":313},"  ],\n",[307,401,403,405,408,410,412,414,417,419],{"class":309,"line":402},8,[307,404,320],{"class":313},[307,406,407],{"class":323},"reference",[307,409,326],{"class":313},[307,411,329],{"class":313},[307,413,355],{"class":313},[307,415,416],{"class":358},"SUB-2026-00042",[307,418,326],{"class":313},[307,420,421],{"class":367}," \u002F\u002F your reference; appears on statements and reporting\n",[307,423,425],{"class":309,"line":424},9,[307,426,427],{"class":313},"}\n",[232,429,431],{"id":430},"example-trial-and-setup-fee","Example (Trial and setup fee)",[159,433,434,435,437],{},"Start with a 14-day trial. The ",[167,436,207],{}," setup fee product is automatically billed on the first cycle only, together with the first recurring cycle when the trial ends.",[298,439,441],{"className":300,"code":440,"language":302,"meta":303,"style":303},"{\n  \"items\": [\n    {\n      \"product_id\": \"pro_abc123...\", \u002F\u002F RECURRING — billed every cycle\n      \"qty\": 1\n    },\n    {\n      \"product_id\": \"pro_setup1...\" \u002F\u002F ONE_TIME — billed on the first cycle only\n    }\n  ],\n  \"trial_days\": 14, \u002F\u002F subscription starts in TRIAL; first charge when the trial ends\n  \"reference\": \"SUB-2026-00042\"\n}\n",[167,442,443,447,459,463,484,497,502,506,526,530,535,555,573],{"__ignoreMap":303},[307,444,445],{"class":309,"line":310},[307,446,314],{"class":313},[307,448,449,451,453,455,457],{"class":309,"line":317},[307,450,320],{"class":313},[307,452,199],{"class":323},[307,454,326],{"class":313},[307,456,329],{"class":313},[307,458,332],{"class":313},[307,460,461],{"class":309,"line":335},[307,462,338],{"class":313},[307,464,465,467,469,471,473,475,477,479,481],{"class":309,"line":341},[307,466,344],{"class":313},[307,468,348],{"class":347},[307,470,326],{"class":313},[307,472,329],{"class":313},[307,474,355],{"class":313},[307,476,359],{"class":358},[307,478,326],{"class":313},[307,480,364],{"class":313},[307,482,483],{"class":367}," \u002F\u002F RECURRING — billed every cycle\n",[307,485,486,488,490,492,494],{"class":309,"line":371},[307,487,344],{"class":313},[307,489,376],{"class":347},[307,491,326],{"class":313},[307,493,329],{"class":313},[307,495,496],{"class":383}," 1\n",[307,498,499],{"class":309,"line":390},[307,500,501],{"class":313},"    },\n",[307,503,504],{"class":309,"line":396},[307,505,338],{"class":313},[307,507,508,510,512,514,516,518,521,523],{"class":309,"line":402},[307,509,344],{"class":313},[307,511,348],{"class":347},[307,513,326],{"class":313},[307,515,329],{"class":313},[307,517,355],{"class":313},[307,519,520],{"class":358},"pro_setup1...",[307,522,326],{"class":313},[307,524,525],{"class":367}," \u002F\u002F ONE_TIME — billed on the first cycle only\n",[307,527,528],{"class":309,"line":424},[307,529,393],{"class":313},[307,531,533],{"class":309,"line":532},10,[307,534,399],{"class":313},[307,536,538,540,543,545,547,550,552],{"class":309,"line":537},11,[307,539,320],{"class":313},[307,541,542],{"class":323},"trial_days",[307,544,326],{"class":313},[307,546,329],{"class":313},[307,548,549],{"class":383}," 14",[307,551,364],{"class":313},[307,553,554],{"class":367}," \u002F\u002F subscription starts in TRIAL; first charge when the trial ends\n",[307,556,558,560,562,564,566,568,570],{"class":309,"line":557},12,[307,559,320],{"class":313},[307,561,407],{"class":323},[307,563,326],{"class":313},[307,565,329],{"class":313},[307,567,355],{"class":313},[307,569,416],{"class":358},[307,571,572],{"class":313},"\"\n",[307,574,576],{"class":309,"line":575},13,[307,577,427],{"class":313},[232,579,581],{"id":580},"example-advanced","Example (Advanced)",[159,583,584],{},"Advanced example with all options, including billing anchoring, invoicing, cascade controls, and a fixed end date.",[298,586,588],{"className":300,"code":587,"language":302,"meta":303,"style":303},"{\n  \"items\": [\n    {\n      \"product_id\": \"pro_abc123...\",\n      \"qty\": 2 \u002F\u002F default 1 when omitted\n    },\n    {\n      \"product_id\": \"pro_xyz789...\",\n      \"price_excl\": 300.23 \u002F\u002F override the default product amount\n    },\n    {\n      \"product_id\": \"pro_setup1...\" \u002F\u002F ONE_TIME product — billed on the first cycle only\n    }\n  ],\n\n  \"currency\": \"ZAR\", \u002F\u002F [optional] default \"ZAR\"\n\n  \"reference\": \"SUB-2026-00042\", \u002F\u002F your reference; appears on statements and reporting\n\n  \"signature\": \"secret-key-for-payload\", \u002F\u002F [optional] shared-secret signature for the payload, see the signature section below\n\n  \u002F\u002F Billing schedule — the period itself comes from the recurring product's interval and cannot be set here\n  \"billing\": {\n    \"billing_day\": 1, \u002F\u002F [optional] anchor day of the month (1–31) for MONTHLY and longer periods; defaults to the day of date_start\n    \"date_start\": \"2026-08-01\", \u002F\u002F [optional] default today; first billing date (after any trial)\n    \"date_end\": \"2027-07-31\" \u002F\u002F [optional] subscription expires after this date; omit to run until cancelled\n  },\n\n  \"trial_days\": 14, \u002F\u002F [optional] trial period before the first charge\n\n  \"collection_method\": \"AUTOCHARGE\", \u002F\u002F [optional] default AUTOCHARGE — charge the vaulted card(s); REQUEST_PAYMENT sends the customer a payment request instead\n  \"due_days\": 7, \u002F\u002F [optional] REQUEST_PAYMENT only — days after each billing date before the payment request is overdue\n\n  \"card_id\": \"crd_SFq2E9LskQimPkf2mRqnV\", \u002F\u002F [optional] bill this card only; the cascade is disabled. Omit to use the default card with cascade\n\n  \u002F\u002F Cascade behaviour on each billing date — ignored when card_id is passed\n  \"cascade\": {\n    \"is_enabled\": true, \u002F\u002F [optional] default true — when false, only the default card is attempted\n    \"max_attempts\": 3, \u002F\u002F [optional] cap on the number of cards tried; defaults to all ACTIVE cards\n    \"skip_codes\": [\"DO_NOT_HONOUR\"] \u002F\u002F [optional] additional decline codes that abort the cascade; hard declines (e.g. SUSPECTED_FRAUD, STOLEN_CARD, PICKUP_CARD) always abort and cannot be overridden\n  },\n\n  \"is_tax\": true, \u002F\u002F [optional] default true — apply tax to line items\n\n  \u002F\u002F Issue and optionally email an invoice on each billing cycle\n  \"invoice\": {\n    \"is_generate\": true,\n    \"is_send\": true, \u002F\u002F email each invoice to the customer when true\n    \"memo\": \"Thank you for subscribing\", \u002F\u002F [optional] shown above the invoice lines\n    \"footer\": \"VAT No. 4123456789\" \u002F\u002F [optional] shown below the invoice lines\n  },\n\n  \"notification\": {\n    \"email\": \"me@my-email.co.za\", \u002F\u002F [optional] email notification on subscription lifecycle events\n    \"webhook_url\": \"https:\u002F\u002Fmerchant.example\u002Fwebhooks\u002Fsubscriptions\" \u002F\u002F webhook on subscription lifecycle events\n  },\n\n  \"metadata\": {\n    \"order_id\": \"ord_98765\" \u002F\u002F [optional] custom key\u002Fvalue pairs returned on the subscription and webhooks\n  }\n}\n",[167,589,590,594,606,610,629,644,648,652,671,688,692,696,715,719,724,731,755,760,781,786,810,815,821,836,856,880,902,908,913,931,936,959,979,984,1007,1012,1018,1032,1050,1070,1098,1103,1108,1125,1130,1136,1150,1165,1182,1206,1228,1233,1238,1252,1276,1298,1303,1308,1322,1344,1350],{"__ignoreMap":303},[307,591,592],{"class":309,"line":310},[307,593,314],{"class":313},[307,595,596,598,600,602,604],{"class":309,"line":317},[307,597,320],{"class":313},[307,599,199],{"class":323},[307,601,326],{"class":313},[307,603,329],{"class":313},[307,605,332],{"class":313},[307,607,608],{"class":309,"line":335},[307,609,338],{"class":313},[307,611,612,614,616,618,620,622,624,626],{"class":309,"line":341},[307,613,344],{"class":313},[307,615,348],{"class":347},[307,617,326],{"class":313},[307,619,329],{"class":313},[307,621,355],{"class":313},[307,623,359],{"class":358},[307,625,326],{"class":313},[307,627,628],{"class":313},",\n",[307,630,631,633,635,637,639,642],{"class":309,"line":371},[307,632,344],{"class":313},[307,634,376],{"class":347},[307,636,326],{"class":313},[307,638,329],{"class":313},[307,640,641],{"class":383}," 2",[307,643,387],{"class":367},[307,645,646],{"class":309,"line":390},[307,647,501],{"class":313},[307,649,650],{"class":309,"line":396},[307,651,338],{"class":313},[307,653,654,656,658,660,662,664,667,669],{"class":309,"line":402},[307,655,344],{"class":313},[307,657,348],{"class":347},[307,659,326],{"class":313},[307,661,329],{"class":313},[307,663,355],{"class":313},[307,665,666],{"class":358},"pro_xyz789...",[307,668,326],{"class":313},[307,670,628],{"class":313},[307,672,673,675,678,680,682,685],{"class":309,"line":424},[307,674,344],{"class":313},[307,676,677],{"class":347},"price_excl",[307,679,326],{"class":313},[307,681,329],{"class":313},[307,683,684],{"class":383}," 300.23",[307,686,687],{"class":367}," \u002F\u002F override the default product amount\n",[307,689,690],{"class":309,"line":532},[307,691,501],{"class":313},[307,693,694],{"class":309,"line":537},[307,695,338],{"class":313},[307,697,698,700,702,704,706,708,710,712],{"class":309,"line":557},[307,699,344],{"class":313},[307,701,348],{"class":347},[307,703,326],{"class":313},[307,705,329],{"class":313},[307,707,355],{"class":313},[307,709,520],{"class":358},[307,711,326],{"class":313},[307,713,714],{"class":367}," \u002F\u002F ONE_TIME product — billed on the first cycle only\n",[307,716,717],{"class":309,"line":575},[307,718,393],{"class":313},[307,720,722],{"class":309,"line":721},14,[307,723,399],{"class":313},[307,725,727],{"class":309,"line":726},15,[307,728,730],{"emptyLinePlaceholder":729},true,"\n",[307,732,734,736,739,741,743,745,748,750,752],{"class":309,"line":733},16,[307,735,320],{"class":313},[307,737,738],{"class":323},"currency",[307,740,326],{"class":313},[307,742,329],{"class":313},[307,744,355],{"class":313},[307,746,747],{"class":358},"ZAR",[307,749,326],{"class":313},[307,751,364],{"class":313},[307,753,754],{"class":367}," \u002F\u002F [optional] default \"ZAR\"\n",[307,756,758],{"class":309,"line":757},17,[307,759,730],{"emptyLinePlaceholder":729},[307,761,763,765,767,769,771,773,775,777,779],{"class":309,"line":762},18,[307,764,320],{"class":313},[307,766,407],{"class":323},[307,768,326],{"class":313},[307,770,329],{"class":313},[307,772,355],{"class":313},[307,774,416],{"class":358},[307,776,326],{"class":313},[307,778,364],{"class":313},[307,780,421],{"class":367},[307,782,784],{"class":309,"line":783},19,[307,785,730],{"emptyLinePlaceholder":729},[307,787,789,791,794,796,798,800,803,805,807],{"class":309,"line":788},20,[307,790,320],{"class":313},[307,792,793],{"class":323},"signature",[307,795,326],{"class":313},[307,797,329],{"class":313},[307,799,355],{"class":313},[307,801,802],{"class":358},"secret-key-for-payload",[307,804,326],{"class":313},[307,806,364],{"class":313},[307,808,809],{"class":367}," \u002F\u002F [optional] shared-secret signature for the payload, see the signature section below\n",[307,811,813],{"class":309,"line":812},21,[307,814,730],{"emptyLinePlaceholder":729},[307,816,818],{"class":309,"line":817},22,[307,819,820],{"class":367},"  \u002F\u002F Billing schedule — the period itself comes from the recurring product's interval and cannot be set here\n",[307,822,824,826,829,831,833],{"class":309,"line":823},23,[307,825,320],{"class":313},[307,827,828],{"class":323},"billing",[307,830,326],{"class":313},[307,832,329],{"class":313},[307,834,835],{"class":313}," {\n",[307,837,839,842,845,847,849,851,853],{"class":309,"line":838},24,[307,840,841],{"class":313},"    \"",[307,843,844],{"class":347},"billing_day",[307,846,326],{"class":313},[307,848,329],{"class":313},[307,850,384],{"class":383},[307,852,364],{"class":313},[307,854,855],{"class":367}," \u002F\u002F [optional] anchor day of the month (1–31) for MONTHLY and longer periods; defaults to the day of date_start\n",[307,857,859,861,864,866,868,870,873,875,877],{"class":309,"line":858},25,[307,860,841],{"class":313},[307,862,863],{"class":347},"date_start",[307,865,326],{"class":313},[307,867,329],{"class":313},[307,869,355],{"class":313},[307,871,872],{"class":358},"2026-08-01",[307,874,326],{"class":313},[307,876,364],{"class":313},[307,878,879],{"class":367}," \u002F\u002F [optional] default today; first billing date (after any trial)\n",[307,881,883,885,888,890,892,894,897,899],{"class":309,"line":882},26,[307,884,841],{"class":313},[307,886,887],{"class":347},"date_end",[307,889,326],{"class":313},[307,891,329],{"class":313},[307,893,355],{"class":313},[307,895,896],{"class":358},"2027-07-31",[307,898,326],{"class":313},[307,900,901],{"class":367}," \u002F\u002F [optional] subscription expires after this date; omit to run until cancelled\n",[307,903,905],{"class":309,"line":904},27,[307,906,907],{"class":313},"  },\n",[307,909,911],{"class":309,"line":910},28,[307,912,730],{"emptyLinePlaceholder":729},[307,914,916,918,920,922,924,926,928],{"class":309,"line":915},29,[307,917,320],{"class":313},[307,919,542],{"class":323},[307,921,326],{"class":313},[307,923,329],{"class":313},[307,925,549],{"class":383},[307,927,364],{"class":313},[307,929,930],{"class":367}," \u002F\u002F [optional] trial period before the first charge\n",[307,932,934],{"class":309,"line":933},30,[307,935,730],{"emptyLinePlaceholder":729},[307,937,939,941,943,945,947,949,952,954,956],{"class":309,"line":938},31,[307,940,320],{"class":313},[307,942,183],{"class":323},[307,944,326],{"class":313},[307,946,329],{"class":313},[307,948,355],{"class":313},[307,950,951],{"class":358},"AUTOCHARGE",[307,953,326],{"class":313},[307,955,364],{"class":313},[307,957,958],{"class":367}," \u002F\u002F [optional] default AUTOCHARGE — charge the vaulted card(s); REQUEST_PAYMENT sends the customer a payment request instead\n",[307,960,962,964,967,969,971,974,976],{"class":309,"line":961},32,[307,963,320],{"class":313},[307,965,966],{"class":323},"due_days",[307,968,326],{"class":313},[307,970,329],{"class":313},[307,972,973],{"class":383}," 7",[307,975,364],{"class":313},[307,977,978],{"class":367}," \u002F\u002F [optional] REQUEST_PAYMENT only — days after each billing date before the payment request is overdue\n",[307,980,982],{"class":309,"line":981},33,[307,983,730],{"emptyLinePlaceholder":729},[307,985,987,989,991,993,995,997,1000,1002,1004],{"class":309,"line":986},34,[307,988,320],{"class":313},[307,990,169],{"class":323},[307,992,326],{"class":313},[307,994,329],{"class":313},[307,996,355],{"class":313},[307,998,999],{"class":358},"crd_SFq2E9LskQimPkf2mRqnV",[307,1001,326],{"class":313},[307,1003,364],{"class":313},[307,1005,1006],{"class":367}," \u002F\u002F [optional] bill this card only; the cascade is disabled. Omit to use the default card with cascade\n",[307,1008,1010],{"class":309,"line":1009},35,[307,1011,730],{"emptyLinePlaceholder":729},[307,1013,1015],{"class":309,"line":1014},36,[307,1016,1017],{"class":367},"  \u002F\u002F Cascade behaviour on each billing date — ignored when card_id is passed\n",[307,1019,1021,1023,1026,1028,1030],{"class":309,"line":1020},37,[307,1022,320],{"class":313},[307,1024,1025],{"class":323},"cascade",[307,1027,326],{"class":313},[307,1029,329],{"class":313},[307,1031,835],{"class":313},[307,1033,1035,1037,1040,1042,1044,1047],{"class":309,"line":1034},38,[307,1036,841],{"class":313},[307,1038,1039],{"class":347},"is_enabled",[307,1041,326],{"class":313},[307,1043,329],{"class":313},[307,1045,1046],{"class":313}," true,",[307,1048,1049],{"class":367}," \u002F\u002F [optional] default true — when false, only the default card is attempted\n",[307,1051,1053,1055,1058,1060,1062,1065,1067],{"class":309,"line":1052},39,[307,1054,841],{"class":313},[307,1056,1057],{"class":347},"max_attempts",[307,1059,326],{"class":313},[307,1061,329],{"class":313},[307,1063,1064],{"class":383}," 3",[307,1066,364],{"class":313},[307,1068,1069],{"class":367}," \u002F\u002F [optional] cap on the number of cards tried; defaults to all ACTIVE cards\n",[307,1071,1073,1075,1078,1080,1082,1085,1087,1090,1092,1095],{"class":309,"line":1072},40,[307,1074,841],{"class":313},[307,1076,1077],{"class":347},"skip_codes",[307,1079,326],{"class":313},[307,1081,329],{"class":313},[307,1083,1084],{"class":313}," [",[307,1086,326],{"class":313},[307,1088,1089],{"class":358},"DO_NOT_HONOUR",[307,1091,326],{"class":313},[307,1093,1094],{"class":313},"]",[307,1096,1097],{"class":367}," \u002F\u002F [optional] additional decline codes that abort the cascade; hard declines (e.g. SUSPECTED_FRAUD, STOLEN_CARD, PICKUP_CARD) always abort and cannot be overridden\n",[307,1099,1101],{"class":309,"line":1100},41,[307,1102,907],{"class":313},[307,1104,1106],{"class":309,"line":1105},42,[307,1107,730],{"emptyLinePlaceholder":729},[307,1109,1111,1113,1116,1118,1120,1122],{"class":309,"line":1110},43,[307,1112,320],{"class":313},[307,1114,1115],{"class":323},"is_tax",[307,1117,326],{"class":313},[307,1119,329],{"class":313},[307,1121,1046],{"class":313},[307,1123,1124],{"class":367}," \u002F\u002F [optional] default true — apply tax to line items\n",[307,1126,1128],{"class":309,"line":1127},44,[307,1129,730],{"emptyLinePlaceholder":729},[307,1131,1133],{"class":309,"line":1132},45,[307,1134,1135],{"class":367},"  \u002F\u002F Issue and optionally email an invoice on each billing cycle\n",[307,1137,1139,1141,1144,1146,1148],{"class":309,"line":1138},46,[307,1140,320],{"class":313},[307,1142,1143],{"class":323},"invoice",[307,1145,326],{"class":313},[307,1147,329],{"class":313},[307,1149,835],{"class":313},[307,1151,1153,1155,1158,1160,1162],{"class":309,"line":1152},47,[307,1154,841],{"class":313},[307,1156,1157],{"class":347},"is_generate",[307,1159,326],{"class":313},[307,1161,329],{"class":313},[307,1163,1164],{"class":313}," true,\n",[307,1166,1168,1170,1173,1175,1177,1179],{"class":309,"line":1167},48,[307,1169,841],{"class":313},[307,1171,1172],{"class":347},"is_send",[307,1174,326],{"class":313},[307,1176,329],{"class":313},[307,1178,1046],{"class":313},[307,1180,1181],{"class":367}," \u002F\u002F email each invoice to the customer when true\n",[307,1183,1185,1187,1190,1192,1194,1196,1199,1201,1203],{"class":309,"line":1184},49,[307,1186,841],{"class":313},[307,1188,1189],{"class":347},"memo",[307,1191,326],{"class":313},[307,1193,329],{"class":313},[307,1195,355],{"class":313},[307,1197,1198],{"class":358},"Thank you for subscribing",[307,1200,326],{"class":313},[307,1202,364],{"class":313},[307,1204,1205],{"class":367}," \u002F\u002F [optional] shown above the invoice lines\n",[307,1207,1209,1211,1214,1216,1218,1220,1223,1225],{"class":309,"line":1208},50,[307,1210,841],{"class":313},[307,1212,1213],{"class":347},"footer",[307,1215,326],{"class":313},[307,1217,329],{"class":313},[307,1219,355],{"class":313},[307,1221,1222],{"class":358},"VAT No. 4123456789",[307,1224,326],{"class":313},[307,1226,1227],{"class":367}," \u002F\u002F [optional] shown below the invoice lines\n",[307,1229,1231],{"class":309,"line":1230},51,[307,1232,907],{"class":313},[307,1234,1236],{"class":309,"line":1235},52,[307,1237,730],{"emptyLinePlaceholder":729},[307,1239,1241,1243,1246,1248,1250],{"class":309,"line":1240},53,[307,1242,320],{"class":313},[307,1244,1245],{"class":323},"notification",[307,1247,326],{"class":313},[307,1249,329],{"class":313},[307,1251,835],{"class":313},[307,1253,1255,1257,1260,1262,1264,1266,1269,1271,1273],{"class":309,"line":1254},54,[307,1256,841],{"class":313},[307,1258,1259],{"class":347},"email",[307,1261,326],{"class":313},[307,1263,329],{"class":313},[307,1265,355],{"class":313},[307,1267,1268],{"class":358},"me@my-email.co.za",[307,1270,326],{"class":313},[307,1272,364],{"class":313},[307,1274,1275],{"class":367}," \u002F\u002F [optional] email notification on subscription lifecycle events\n",[307,1277,1279,1281,1284,1286,1288,1290,1293,1295],{"class":309,"line":1278},55,[307,1280,841],{"class":313},[307,1282,1283],{"class":347},"webhook_url",[307,1285,326],{"class":313},[307,1287,329],{"class":313},[307,1289,355],{"class":313},[307,1291,1292],{"class":358},"https:\u002F\u002Fmerchant.example\u002Fwebhooks\u002Fsubscriptions",[307,1294,326],{"class":313},[307,1296,1297],{"class":367}," \u002F\u002F webhook on subscription lifecycle events\n",[307,1299,1301],{"class":309,"line":1300},56,[307,1302,907],{"class":313},[307,1304,1306],{"class":309,"line":1305},57,[307,1307,730],{"emptyLinePlaceholder":729},[307,1309,1311,1313,1316,1318,1320],{"class":309,"line":1310},58,[307,1312,320],{"class":313},[307,1314,1315],{"class":323},"metadata",[307,1317,326],{"class":313},[307,1319,329],{"class":313},[307,1321,835],{"class":313},[307,1323,1325,1327,1330,1332,1334,1336,1339,1341],{"class":309,"line":1324},59,[307,1326,841],{"class":313},[307,1328,1329],{"class":347},"order_id",[307,1331,326],{"class":313},[307,1333,329],{"class":313},[307,1335,355],{"class":313},[307,1337,1338],{"class":358},"ord_98765",[307,1340,326],{"class":313},[307,1342,1343],{"class":367}," \u002F\u002F [optional] custom key\u002Fvalue pairs returned on the subscription and webhooks\n",[307,1345,1347],{"class":309,"line":1346},60,[307,1348,1349],{"class":313},"  }\n",[307,1351,1353],{"class":309,"line":1352},61,[307,1354,427],{"class":313},[232,1356,1358],{"id":1357},"request-parameters","Request Parameters",[159,1360,1361,1362,1366,1367,1370,1371,1374],{},"Fields below appear in the ",[163,1363,1365],{"href":1364},"#example-basic","request body examples"," on this page. ",[212,1368,1369],{},"Y"," = required for all requests, ",[212,1372,1373],{},"C"," = required or applicable depending on usage.",[246,1376,1377,1400],{},[249,1378,1379],{},[252,1380,1381,1388,1391,1393,1398],{},[255,1382,1383],{"align":257},[1384,1385,1387],"div",{"style":1386},"width:100px","Field",[255,1389,1390],{"align":257},"Required",[255,1392,261],{"align":257},[255,1394,1395],{"align":257},[1384,1396,264],{"style":1397},"width:300px",[255,1399,267],{"align":257},[269,1401,1402,1431,1448,1471,1489,1517,1535,1553,1570,1595,1611,1624,1644,1666,1684,1714,1739,1753,1768,1781,1795,1809,1823,1837,1854,1871],{},[252,1403,1404,1406,1408,1411,1428],{},[274,1405,199],{"align":257},[274,1407,1369],{"align":257},[274,1409,1410],{"align":257},"Array",[274,1412,1413,1414,1416,1417,1419,1420,1422,1423,1425,1426],{"align":257},"Line items from your catalog. Each product's pricing type determines how it is billed: ",[167,1415,203],{}," products bill on every cycle, ",[167,1418,207],{}," products on the first cycle only. At least one ",[167,1421,203],{}," product is required, and all ",[167,1424,203],{}," products must share the same billing interval — see ",[163,1427,195],{"href":194},[274,1429,1430],{"align":257},"See basic example",[252,1432,1433,1438,1440,1443,1446],{},[274,1434,199,1435,1437],{"align":257},[307,1436],{},".product_id",[274,1439,1369],{"align":257},[274,1441,1442],{"align":257},"String",[274,1444,1445],{"align":257},"Catalog product for this line",[274,1447,359],{"align":257},[252,1449,1450,1455,1458,1461,1468],{},[274,1451,199,1452,1454],{"align":257},[307,1453],{},".qty",[274,1456,1457],{"align":257},"N",[274,1459,1460],{"align":257},"Integer",[274,1462,1463,1464,1467],{"align":257},"Quantity for this line item (default ",[167,1465,1466],{},"1",")",[274,1469,1470],{"align":257},"2",[252,1472,1473,1478,1480,1483,1486],{},[274,1474,199,1475,1477],{"align":257},[307,1476],{},".price_excl",[274,1479,1457],{"align":257},[274,1481,1482],{"align":257},"Number",[274,1484,1485],{"align":257},"Override the default product amount (excluding tax)",[274,1487,1488],{"align":257},"300.23",[252,1490,1491,1494,1496,1498,1515],{},[274,1492,1493],{"align":257},"billing.billing_day",[274,1495,1457],{"align":257},[274,1497,1460],{"align":257},[274,1499,1500,1501,1503,1504,1507,1508,1511,1512,1514],{"align":257},"Anchor day of the month (",[167,1502,1466],{},"–",[167,1505,1506],{},"31",") for ",[167,1509,1510],{},"MONTHLY"," and longer periods; months with fewer days bill on the last day. Defaults to the day of ",[167,1513,863],{},". The billing period itself is derived from the recurring product's interval and cannot be set here",[274,1516,1466],{"align":257},[252,1518,1519,1522,1524,1526,1533],{},[274,1520,1521],{"align":257},"billing.date_start",[274,1523,1457],{"align":257},[274,1525,1442],{"align":257},[274,1527,1528,1529,1532],{"align":257},"First billing date (",[167,1530,1531],{},"YYYY-MM-DD","), after any trial. Default today",[274,1534,872],{"align":257},[252,1536,1537,1540,1542,1544,1551],{},[274,1538,1539],{"align":257},"billing.date_end",[274,1541,1457],{"align":257},[274,1543,1442],{"align":257},[274,1545,1546,1547,1550],{"align":257},"Date after which the subscription expires with status ",[167,1548,1549],{},"EXPIRED",". Omit to run until cancelled",[274,1552,896],{"align":257},[252,1554,1555,1557,1559,1561,1567],{},[274,1556,542],{"align":257},[274,1558,1457],{"align":257},[274,1560,1460],{"align":257},[274,1562,1563,1564],{"align":257},"Trial period in days before the first charge; the subscription starts in ",[167,1565,1566],{},"TRIAL",[274,1568,1569],{"align":257},"14",[252,1571,1572,1574,1576,1579,1591],{},[274,1573,183],{"align":257},[274,1575,1457],{"align":257},[274,1577,1578],{"align":257},"ENUM",[274,1580,1581,1583,1584,1586,1587],{"align":257},[167,1582,951],{}," (default) charges the vaulted card(s) on each billing date; ",[167,1585,187],{}," emails the customer a payment request instead, see ",[163,1588,1590],{"href":1589},"\u002Freference\u002Flookups","lookups",[274,1592,1593],{"align":257},[167,1594,951],{},[252,1596,1597,1599,1601,1603,1608],{},[274,1598,966],{"align":257},[274,1600,1373],{"align":257},[274,1602,1460],{"align":257},[274,1604,1605,1607],{"align":257},[167,1606,187],{}," only — days after each billing date before the payment request is overdue",[274,1609,1610],{"align":257},"7",[252,1612,1613,1615,1617,1619,1622],{},[274,1614,169],{"align":257},[274,1616,1373],{"align":257},[274,1618,279],{"align":257},[274,1620,1621],{"align":257},"Bill this specific card only; the cascade is disabled. Omit to bill the default card with cascade",[274,1623,999],{"align":257},[252,1625,1626,1628,1630,1633,1641],{},[274,1627,1025],{"align":257},[274,1629,1457],{"align":257},[274,1631,1632],{"align":257},"Object",[274,1634,1635,1636,1638,1639],{"align":257},"Cascade behaviour on each billing date; ignored when ",[167,1637,169],{}," is passed — see ",[163,1640,99],{"href":100},[274,1642,1643],{"align":257},"See advanced example",[252,1645,1646,1649,1651,1654,1664],{},[274,1647,1648],{"align":257},"cascade.is_enabled",[274,1650,1457],{"align":257},[274,1652,1653],{"align":257},"Boolean",[274,1655,1656,1657,1660,1661],{"align":257},"When ",[167,1658,1659],{},"false",", only the default card is attempted. Default ",[167,1662,1663],{},"true",[274,1665,1663],{"align":257},[252,1667,1668,1671,1673,1675,1681],{},[274,1669,1670],{"align":257},"cascade.max_attempts",[274,1672,1457],{"align":257},[274,1674,1460],{"align":257},[274,1676,1677,1678,1680],{"align":257},"Cap on the number of cards tried; defaults to all ",[167,1679,179],{}," cards",[274,1682,1683],{"align":257},"3",[252,1685,1686,1689,1691,1693,1709],{},[274,1687,1688],{"align":257},"cascade.skip_codes",[274,1690,1457],{"align":257},[274,1692,1410],{"align":257},[274,1694,1695,1696,1699,1700,1699,1703,1706,1707],{"align":257},"Additional decline codes that abort the cascade instead of trying the next card. Hard declines (",[167,1697,1698],{},"SUSPECTED_FRAUD",", ",[167,1701,1702],{},"STOLEN_CARD",[167,1704,1705],{},"PICKUP_CARD",") always abort and cannot be overridden — see ",[163,1708,1590],{"href":1589},[274,1710,1711,1712,1094],{"align":257},"[",[167,1713,1089],{},[252,1715,1716,1718,1720,1723,1735],{},[274,1717,738],{"align":257},[274,1719,1457],{"align":257},[274,1721,1722],{"align":257},"String(3)",[274,1724,1725,1732,1733],{"align":257},[163,1726,1731],{"href":1727,"rel":1728,":target":1730},"https:\u002F\u002Fen.wikipedia.org\u002Fwiki\u002FISO_4217",[1729],"nofollow","_blank","ISO 4217"," currency code. Default ",[167,1734,747],{},[274,1736,1737],{"align":257},[167,1738,747],{},[252,1740,1741,1743,1745,1748,1751],{},[274,1742,407],{"align":257},[274,1744,1369],{"align":257},[274,1746,1747],{"align":257},"String(35)",[274,1749,1750],{"align":257},"Your reference for this subscription; appears on statements and reporting",[274,1752,416],{"align":257},[252,1754,1755,1757,1759,1761,1766],{},[274,1756,1115],{"align":257},[274,1758,1457],{"align":257},[274,1760,1653],{"align":257},[274,1762,1763,1764],{"align":257},"Apply tax to line items. Default ",[167,1765,1663],{},[274,1767,1663],{"align":257},[252,1769,1770,1772,1774,1776,1779],{},[274,1771,793],{"align":257},[274,1773,1457],{"align":257},[274,1775,1442],{"align":257},[274,1777,1778],{"align":257},"Optional passphrase signature for verifying the payload",[274,1780,802],{"align":257},[252,1782,1783,1786,1788,1790,1793],{},[274,1784,1785],{"align":257},"invoice.is_generate",[274,1787,1457],{"align":257},[274,1789,1653],{"align":257},[274,1791,1792],{"align":257},"Whether to generate an invoice on each billing cycle",[274,1794,1663],{"align":257},[252,1796,1797,1800,1802,1804,1807],{},[274,1798,1799],{"align":257},"invoice.is_send",[274,1801,1457],{"align":257},[274,1803,1653],{"align":257},[274,1805,1806],{"align":257},"Whether to email each invoice to the customer",[274,1808,1663],{"align":257},[252,1810,1811,1814,1816,1818,1821],{},[274,1812,1813],{"align":257},"invoice.memo",[274,1815,1457],{"align":257},[274,1817,1442],{"align":257},[274,1819,1820],{"align":257},"Memo shown above the invoice lines",[274,1822,1198],{"align":257},[252,1824,1825,1828,1830,1832,1835],{},[274,1826,1827],{"align":257},"invoice.footer",[274,1829,1457],{"align":257},[274,1831,1442],{"align":257},[274,1833,1834],{"align":257},"Footer shown below the invoice lines",[274,1836,1222],{"align":257},[252,1838,1839,1842,1844,1846,1849],{},[274,1840,1841],{"align":257},"notification.email",[274,1843,1457],{"align":257},[274,1845,1442],{"align":257},[274,1847,1848],{"align":257},"Email address to notify on subscription lifecycle events",[274,1850,1851],{"align":257},[163,1852,1268],{"href":1853},"mailto:me@my-email.co.za",[252,1855,1856,1859,1861,1863,1866],{},[274,1857,1858],{"align":257},"notification.webhook_url",[274,1860,1457],{"align":257},[274,1862,1442],{"align":257},[274,1864,1865],{"align":257},"Webhook URL for subscription lifecycle events",[274,1867,1868],{"align":257},[163,1869,1292],{"href":1292,"rel":1870},[1729],[252,1872,1873,1875,1877,1879,1882],{},[274,1874,1315],{"align":257},[274,1876,1457],{"align":257},[274,1878,1632],{"align":257},[274,1880,1881],{"align":257},"Custom key\u002Fvalue metadata returned on the subscription and webhooks",[274,1883,1884],{"align":257},[167,1885,1886],{},"{\"order_id\": \"ord_98765\"}",[232,1888,1890],{"id":1889},"response-body","Response Body",[159,1892,1893,1894,1897,1898,1900,1901,1903,1904,1906,1907,1909,1910,1913,1914,219,1916,223,1918,1920],{},"A subscription (",[167,1895,1896],{},"sub_",") is returned with its resolved billing schedule and totals. The ",[167,1899,199],{}," array you passed is split by each product's pricing type: ",[167,1902,203],{}," products are stored under ",[167,1905,199],{}," and ",[167,1908,207],{}," products under ",[167,1911,1912],{},"items_one_time",". The recurring product's interval populates ",[167,1915,218],{},[167,1917,222],{},[167,1919,226],{}," when the product bills on a custom interval.",[159,1922,1923,1924,1906,1927,188],{},"Each billing cycle produces a charge on the customer's card(s) — the latest outcome is reflected in ",[167,1925,1926],{},"last_transaction_id",[167,1928,1929],{},"last_invoice_id",[298,1931,1933],{"className":300,"code":1932,"language":302,"meta":303,"style":303},"{\n    \"status\": true,\n    \"result\": {\n      \"id\": \"sub_Wt5RmK2xPqLv9nYcE7aBz\",\n      \"customer_id\": \"cus_abc123...\",\n      \"reference\": \"SUB-2026-00042\",\n      \"subscription_status\": \"TRIAL\",\n      \"collection_method\": \"AUTOCHARGE\",\n      \"card_id\": null,\n      \"items\": [\n        {\n          \"product_id\": \"pro_abc123...\",\n          \"qty\": 2,\n          \"price_excl\": 300.23\n        }\n      ],\n      \"items_one_time\": [\n        {\n          \"product_id\": \"pro_setup1...\",\n          \"qty\": 1\n        }\n      ],\n      \"billing\": {\n        \"period\": \"MONTHLY\",\n        \"billing_day\": 1,\n        \"date_start\": \"2026-08-01\",\n        \"date_end\": \"2027-07-31\"\n      },\n      \"trial_days\": 14,\n      \"total_recurring_excl\": \"600.46\",\n      \"total_recurring_incl\": \"690.53\",\n      \"total_one_time_excl\": \"150.00\",\n      \"total_one_time_incl\": \"172.50\",\n      \"currency\": \"ZAR\",\n      \"date_next_billing\": \"2026-08-01\",\n      \"date_last_billing\": null,\n      \"last_transaction_id\": null,\n      \"last_invoice_id\": null,\n      \"created_at\": \"2026-07-06T10:15:30Z\"\n    }\n}\n",[167,1934,1935,1939,1952,1965,1985,2003,2021,2040,2058,2071,2083,2088,2107,2121,2134,2139,2144,2156,2160,2178,2190,2194,2198,2210,2230,2244,2262,2278,2283,2297,2317,2337,2357,2377,2395,2414,2427,2439,2451,2469,2473],{"__ignoreMap":303},[307,1936,1937],{"class":309,"line":310},[307,1938,314],{"class":313},[307,1940,1941,1943,1946,1948,1950],{"class":309,"line":317},[307,1942,841],{"class":313},[307,1944,1945],{"class":323},"status",[307,1947,326],{"class":313},[307,1949,329],{"class":313},[307,1951,1164],{"class":313},[307,1953,1954,1956,1959,1961,1963],{"class":309,"line":335},[307,1955,841],{"class":313},[307,1957,1958],{"class":323},"result",[307,1960,326],{"class":313},[307,1962,329],{"class":313},[307,1964,835],{"class":313},[307,1966,1967,1969,1972,1974,1976,1978,1981,1983],{"class":309,"line":341},[307,1968,344],{"class":313},[307,1970,1971],{"class":347},"id",[307,1973,326],{"class":313},[307,1975,329],{"class":313},[307,1977,355],{"class":313},[307,1979,1980],{"class":358},"sub_Wt5RmK2xPqLv9nYcE7aBz",[307,1982,326],{"class":313},[307,1984,628],{"class":313},[307,1986,1987,1989,1991,1993,1995,1997,1999,2001],{"class":309,"line":371},[307,1988,344],{"class":313},[307,1990,276],{"class":347},[307,1992,326],{"class":313},[307,1994,329],{"class":313},[307,1996,355],{"class":313},[307,1998,289],{"class":358},[307,2000,326],{"class":313},[307,2002,628],{"class":313},[307,2004,2005,2007,2009,2011,2013,2015,2017,2019],{"class":309,"line":390},[307,2006,344],{"class":313},[307,2008,407],{"class":347},[307,2010,326],{"class":313},[307,2012,329],{"class":313},[307,2014,355],{"class":313},[307,2016,416],{"class":358},[307,2018,326],{"class":313},[307,2020,628],{"class":313},[307,2022,2023,2025,2028,2030,2032,2034,2036,2038],{"class":309,"line":396},[307,2024,344],{"class":313},[307,2026,2027],{"class":347},"subscription_status",[307,2029,326],{"class":313},[307,2031,329],{"class":313},[307,2033,355],{"class":313},[307,2035,1566],{"class":358},[307,2037,326],{"class":313},[307,2039,628],{"class":313},[307,2041,2042,2044,2046,2048,2050,2052,2054,2056],{"class":309,"line":402},[307,2043,344],{"class":313},[307,2045,183],{"class":347},[307,2047,326],{"class":313},[307,2049,329],{"class":313},[307,2051,355],{"class":313},[307,2053,951],{"class":358},[307,2055,326],{"class":313},[307,2057,628],{"class":313},[307,2059,2060,2062,2064,2066,2068],{"class":309,"line":424},[307,2061,344],{"class":313},[307,2063,169],{"class":347},[307,2065,326],{"class":313},[307,2067,329],{"class":313},[307,2069,2070],{"class":313}," null,\n",[307,2072,2073,2075,2077,2079,2081],{"class":309,"line":532},[307,2074,344],{"class":313},[307,2076,199],{"class":347},[307,2078,326],{"class":313},[307,2080,329],{"class":313},[307,2082,332],{"class":313},[307,2084,2085],{"class":309,"line":537},[307,2086,2087],{"class":313},"        {\n",[307,2089,2090,2093,2095,2097,2099,2101,2103,2105],{"class":309,"line":557},[307,2091,2092],{"class":313},"          \"",[307,2094,348],{"class":383},[307,2096,326],{"class":313},[307,2098,329],{"class":313},[307,2100,355],{"class":313},[307,2102,359],{"class":358},[307,2104,326],{"class":313},[307,2106,628],{"class":313},[307,2108,2109,2111,2113,2115,2117,2119],{"class":309,"line":575},[307,2110,2092],{"class":313},[307,2112,376],{"class":383},[307,2114,326],{"class":313},[307,2116,329],{"class":313},[307,2118,641],{"class":383},[307,2120,628],{"class":313},[307,2122,2123,2125,2127,2129,2131],{"class":309,"line":721},[307,2124,2092],{"class":313},[307,2126,677],{"class":383},[307,2128,326],{"class":313},[307,2130,329],{"class":313},[307,2132,2133],{"class":383}," 300.23\n",[307,2135,2136],{"class":309,"line":726},[307,2137,2138],{"class":313},"        }\n",[307,2140,2141],{"class":309,"line":733},[307,2142,2143],{"class":313},"      ],\n",[307,2145,2146,2148,2150,2152,2154],{"class":309,"line":757},[307,2147,344],{"class":313},[307,2149,1912],{"class":347},[307,2151,326],{"class":313},[307,2153,329],{"class":313},[307,2155,332],{"class":313},[307,2157,2158],{"class":309,"line":762},[307,2159,2087],{"class":313},[307,2161,2162,2164,2166,2168,2170,2172,2174,2176],{"class":309,"line":783},[307,2163,2092],{"class":313},[307,2165,348],{"class":383},[307,2167,326],{"class":313},[307,2169,329],{"class":313},[307,2171,355],{"class":313},[307,2173,520],{"class":358},[307,2175,326],{"class":313},[307,2177,628],{"class":313},[307,2179,2180,2182,2184,2186,2188],{"class":309,"line":788},[307,2181,2092],{"class":313},[307,2183,376],{"class":383},[307,2185,326],{"class":313},[307,2187,329],{"class":313},[307,2189,496],{"class":383},[307,2191,2192],{"class":309,"line":812},[307,2193,2138],{"class":313},[307,2195,2196],{"class":309,"line":817},[307,2197,2143],{"class":313},[307,2199,2200,2202,2204,2206,2208],{"class":309,"line":823},[307,2201,344],{"class":313},[307,2203,828],{"class":347},[307,2205,326],{"class":313},[307,2207,329],{"class":313},[307,2209,835],{"class":313},[307,2211,2212,2215,2218,2220,2222,2224,2226,2228],{"class":309,"line":838},[307,2213,2214],{"class":313},"        \"",[307,2216,2217],{"class":383},"period",[307,2219,326],{"class":313},[307,2221,329],{"class":313},[307,2223,355],{"class":313},[307,2225,1510],{"class":358},[307,2227,326],{"class":313},[307,2229,628],{"class":313},[307,2231,2232,2234,2236,2238,2240,2242],{"class":309,"line":858},[307,2233,2214],{"class":313},[307,2235,844],{"class":383},[307,2237,326],{"class":313},[307,2239,329],{"class":313},[307,2241,384],{"class":383},[307,2243,628],{"class":313},[307,2245,2246,2248,2250,2252,2254,2256,2258,2260],{"class":309,"line":882},[307,2247,2214],{"class":313},[307,2249,863],{"class":383},[307,2251,326],{"class":313},[307,2253,329],{"class":313},[307,2255,355],{"class":313},[307,2257,872],{"class":358},[307,2259,326],{"class":313},[307,2261,628],{"class":313},[307,2263,2264,2266,2268,2270,2272,2274,2276],{"class":309,"line":904},[307,2265,2214],{"class":313},[307,2267,887],{"class":383},[307,2269,326],{"class":313},[307,2271,329],{"class":313},[307,2273,355],{"class":313},[307,2275,896],{"class":358},[307,2277,572],{"class":313},[307,2279,2280],{"class":309,"line":910},[307,2281,2282],{"class":313},"      },\n",[307,2284,2285,2287,2289,2291,2293,2295],{"class":309,"line":915},[307,2286,344],{"class":313},[307,2288,542],{"class":347},[307,2290,326],{"class":313},[307,2292,329],{"class":313},[307,2294,549],{"class":383},[307,2296,628],{"class":313},[307,2298,2299,2301,2304,2306,2308,2310,2313,2315],{"class":309,"line":933},[307,2300,344],{"class":313},[307,2302,2303],{"class":347},"total_recurring_excl",[307,2305,326],{"class":313},[307,2307,329],{"class":313},[307,2309,355],{"class":313},[307,2311,2312],{"class":358},"600.46",[307,2314,326],{"class":313},[307,2316,628],{"class":313},[307,2318,2319,2321,2324,2326,2328,2330,2333,2335],{"class":309,"line":938},[307,2320,344],{"class":313},[307,2322,2323],{"class":347},"total_recurring_incl",[307,2325,326],{"class":313},[307,2327,329],{"class":313},[307,2329,355],{"class":313},[307,2331,2332],{"class":358},"690.53",[307,2334,326],{"class":313},[307,2336,628],{"class":313},[307,2338,2339,2341,2344,2346,2348,2350,2353,2355],{"class":309,"line":961},[307,2340,344],{"class":313},[307,2342,2343],{"class":347},"total_one_time_excl",[307,2345,326],{"class":313},[307,2347,329],{"class":313},[307,2349,355],{"class":313},[307,2351,2352],{"class":358},"150.00",[307,2354,326],{"class":313},[307,2356,628],{"class":313},[307,2358,2359,2361,2364,2366,2368,2370,2373,2375],{"class":309,"line":981},[307,2360,344],{"class":313},[307,2362,2363],{"class":347},"total_one_time_incl",[307,2365,326],{"class":313},[307,2367,329],{"class":313},[307,2369,355],{"class":313},[307,2371,2372],{"class":358},"172.50",[307,2374,326],{"class":313},[307,2376,628],{"class":313},[307,2378,2379,2381,2383,2385,2387,2389,2391,2393],{"class":309,"line":986},[307,2380,344],{"class":313},[307,2382,738],{"class":347},[307,2384,326],{"class":313},[307,2386,329],{"class":313},[307,2388,355],{"class":313},[307,2390,747],{"class":358},[307,2392,326],{"class":313},[307,2394,628],{"class":313},[307,2396,2397,2399,2402,2404,2406,2408,2410,2412],{"class":309,"line":1009},[307,2398,344],{"class":313},[307,2400,2401],{"class":347},"date_next_billing",[307,2403,326],{"class":313},[307,2405,329],{"class":313},[307,2407,355],{"class":313},[307,2409,872],{"class":358},[307,2411,326],{"class":313},[307,2413,628],{"class":313},[307,2415,2416,2418,2421,2423,2425],{"class":309,"line":1014},[307,2417,344],{"class":313},[307,2419,2420],{"class":347},"date_last_billing",[307,2422,326],{"class":313},[307,2424,329],{"class":313},[307,2426,2070],{"class":313},[307,2428,2429,2431,2433,2435,2437],{"class":309,"line":1020},[307,2430,344],{"class":313},[307,2432,1926],{"class":347},[307,2434,326],{"class":313},[307,2436,329],{"class":313},[307,2438,2070],{"class":313},[307,2440,2441,2443,2445,2447,2449],{"class":309,"line":1034},[307,2442,344],{"class":313},[307,2444,1929],{"class":347},[307,2446,326],{"class":313},[307,2448,329],{"class":313},[307,2450,2070],{"class":313},[307,2452,2453,2455,2458,2460,2462,2464,2467],{"class":309,"line":1052},[307,2454,344],{"class":313},[307,2456,2457],{"class":347},"created_at",[307,2459,326],{"class":313},[307,2461,329],{"class":313},[307,2463,355],{"class":313},[307,2465,2466],{"class":358},"2026-07-06T10:15:30Z",[307,2468,572],{"class":313},[307,2470,2471],{"class":309,"line":1072},[307,2472,393],{"class":313},[307,2474,2475],{"class":309,"line":1100},[307,2476,427],{"class":313},[232,2478,2480],{"id":2479},"response-parameters","Response Parameters",[246,2482,2483,2499],{},[249,2484,2485],{},[252,2486,2487,2491,2493,2497],{},[255,2488,2489],{"align":257},[1384,2490,1387],{"style":1386},[255,2492,261],{"align":257},[255,2494,2495],{"align":257},[1384,2496,264],{"style":1397},[255,2498,267],{"align":257},[269,2500,2501,2512,2524,2536,2548,2584,2600,2616,2633,2649,2674,2689,2701,2713,2725,2737,2754,2766,2781,2796,2812],{},[252,2502,2503,2505,2507,2510],{},[274,2504,1945],{"align":257},[274,2506,1653],{"align":257},[274,2508,2509],{"align":257},"Whether the request succeeded",[274,2511,1663],{"align":257},[252,2513,2514,2517,2519,2522],{},[274,2515,2516],{"align":257},"result.id",[274,2518,279],{"align":257},[274,2520,2521],{"align":257},"Unique subscription identifier",[274,2523,1980],{"align":257},[252,2525,2526,2529,2531,2534],{},[274,2527,2528],{"align":257},"result.customer_id",[274,2530,279],{"align":257},[274,2532,2533],{"align":257},"Associated customer ID",[274,2535,289],{"align":257},[252,2537,2538,2541,2543,2546],{},[274,2539,2540],{"align":257},"result.reference",[274,2542,1747],{"align":257},[274,2544,2545],{"align":257},"Your reference for this subscription",[274,2547,416],{"align":257},[252,2549,2550,2553,2555,2580],{},[274,2551,2552],{"align":257},"result.subscription_status",[274,2554,1578],{"align":257},[274,2556,2557,2558,1699,2560,1699,2562,1699,2565,1699,2568,1699,2570,2573,2574,2577,2578],{"align":257},"Subscription state: ",[167,2559,1566],{},[167,2561,179],{},[167,2563,2564],{},"PAUSED",[167,2566,2567],{},"CANCELLED",[167,2569,1549],{},[167,2571,2572],{},"FAILED",", or ",[167,2575,2576],{},"DISABLED",", see ",[163,2579,1590],{"href":1589},[274,2581,2582],{"align":257},[167,2583,1566],{},[252,2585,2586,2589,2591,2596],{},[274,2587,2588],{"align":257},"result.collection_method",[274,2590,1578],{"align":257},[274,2592,2593,2594],{"align":257},"How each cycle is collected, see ",[163,2595,1590],{"href":1589},[274,2597,2598],{"align":257},[167,2599,951],{},[252,2601,2602,2605,2607,2614],{},[274,2603,2604],{"align":257},"result.card_id",[274,2606,279],{"align":257},[274,2608,2609,2610,2613],{"align":257},"The specific card billed each cycle; ",[167,2611,2612],{},"null"," when using the default card with cascade",[274,2615,999],{"align":257},[252,2617,2618,2621,2623,2628],{},[274,2619,2620],{"align":257},"result.items",[274,2622,1410],{"align":257},[274,2624,2625,2627],{"align":257},[167,2626,203],{}," line items, billed on every cycle",[274,2629,2630],{"align":257},[307,2631,2632],{},"...",[252,2634,2635,2638,2640,2645],{},[274,2636,2637],{"align":257},"result.items_one_time",[274,2639,1410],{"align":257},[274,2641,2642,2644],{"align":257},[167,2643,207],{}," line items, billed on the first cycle only",[274,2646,2647],{"align":257},[307,2648,2632],{},[252,2650,2651,2654,2656,2671],{},[274,2652,2653],{"align":257},"result.billing",[274,2655,1632],{"align":257},[274,2657,2658,2659,2661,2662,1906,2665,2668,2669],{"align":257},"Resolved billing schedule. ",[167,2660,2217],{}," is populated from the recurring product's interval; ",[167,2663,2664],{},"custom_interval",[167,2666,2667],{},"custom_period"," are included when the product bills on a custom interval, see ",[163,2670,1590],{"href":1589},[274,2672,2673],{"align":257},"See response body",[252,2675,2676,2679,2681,2687],{},[274,2677,2678],{"align":257},"result.trial_days",[274,2680,1460],{"align":257},[274,2682,2683,2684,2686],{"align":257},"Trial period in days; ",[167,2685,2612],{}," when no trial",[274,2688,1569],{"align":257},[252,2690,2691,2694,2696,2699],{},[274,2692,2693],{"align":257},"result.total_recurring_excl",[274,2695,1442],{"align":257},[274,2697,2698],{"align":257},"Recurring total per cycle, excluding tax",[274,2700,2312],{"align":257},[252,2702,2703,2706,2708,2711],{},[274,2704,2705],{"align":257},"result.total_recurring_incl",[274,2707,1442],{"align":257},[274,2709,2710],{"align":257},"Recurring total per cycle, including tax",[274,2712,2332],{"align":257},[252,2714,2715,2718,2720,2723],{},[274,2716,2717],{"align":257},"result.total_one_time_excl",[274,2719,1442],{"align":257},[274,2721,2722],{"align":257},"One-time total billed on the first cycle, excluding tax",[274,2724,2352],{"align":257},[252,2726,2727,2730,2732,2735],{},[274,2728,2729],{"align":257},"result.total_one_time_incl",[274,2731,1442],{"align":257},[274,2733,2734],{"align":257},"One-time total billed on the first cycle, including tax",[274,2736,2372],{"align":257},[252,2738,2739,2742,2744,2750],{},[274,2740,2741],{"align":257},"result.currency",[274,2743,1722],{"align":257},[274,2745,2746,2749],{"align":257},[163,2747,1731],{"href":1727,"rel":2748,":target":1730},[1729]," currency code",[274,2751,2752],{"align":257},[167,2753,747],{},[252,2755,2756,2759,2761,2764],{},[274,2757,2758],{"align":257},"result.date_next_billing",[274,2760,1442],{"align":257},[274,2762,2763],{"align":257},"Next billing date",[274,2765,872],{"align":257},[252,2767,2768,2771,2773,2779],{},[274,2769,2770],{"align":257},"result.date_last_billing",[274,2772,1442],{"align":257},[274,2774,2775,2776,2778],{"align":257},"Most recent billing date; ",[167,2777,2612],{}," before the first cycle",[274,2780,872],{"align":257},[252,2782,2783,2786,2788,2793],{},[274,2784,2785],{"align":257},"result.last_transaction_id",[274,2787,279],{"align":257},[274,2789,2790,2791,2778],{"align":257},"Transaction from the most recent billing cycle; ",[167,2792,2612],{},[274,2794,2795],{"align":257},"tra_pr6CvR_4pvWwmgQ4y3dtY",[252,2797,2798,2801,2803,2809],{},[274,2799,2800],{"align":257},"result.last_invoice_id",[274,2802,279],{"align":257},[274,2804,2805,2806,2808],{"align":257},"Invoice from the most recent billing cycle; ",[167,2807,2612],{}," before the first cycle or when invoicing is disabled",[274,2810,2811],{"align":257},"inv_k2Jd8sLqPz...",[252,2813,2814,2817,2819,2822],{},[274,2815,2816],{"align":257},"result.created_at",[274,2818,1442],{"align":257},[274,2820,2821],{"align":257},"ISO timestamp when the subscription was created",[274,2823,2466],{"align":257},[154,2825,2827],{"id":2826},"change-plan-request","Change Plan Request",[159,2829,2830,2831,2835,2836,2838,2839,2841],{},"Change the recurring line items of a subscription. As on ",[163,2832,2834],{"href":2833},"#create-request","create",", the billing period is determined by the products — passing products with a different interval (e.g. moving from monthly to yearly) updates the subscription's ",[167,2837,218],{}," when the plan change takes effect. ",[167,2840,207],{}," products are not allowed here; they are only billed on the first cycle of a new subscription.",[159,2843,2844,2845,2848,2849,1906,2852,2855],{},"By default the new plan takes effect on the next billing date; pass ",[167,2846,2847],{},"is_immediate"," to bill the new plan right away and reset the billing anchor to today. The pending plan is visible on the subscription as ",[167,2850,2851],{},"change_plan_items",[167,2853,2854],{},"change_plan_at"," until it takes effect.",[232,2857,235],{"id":2858},"path-1",[159,2860,2861,241,2863],{},[167,2862,240],{},[167,2864,2865],{},"\u002Fsubscriptions\u002F{subscription_id}\u002Fchange-plan",[246,2867,2868,2880],{},[249,2869,2870],{},[252,2871,2872,2874,2876,2878],{},[255,2873,258],{"align":257},[255,2875,261],{"align":257},[255,2877,264],{"align":257},[255,2879,267],{"align":257},[269,2881,2882],{},[252,2883,2884,2887,2889,2892],{},[274,2885,2886],{"align":257},"subscription_id",[274,2888,279],{"align":257},[274,2890,2891],{"align":257},"The subscription to change",[274,2893,1980],{"align":257},[232,2895,267],{"id":2896},"example",[298,2898,2900],{"className":300,"code":2899,"language":302,"meta":303,"style":303},"{\n  \"items\": [\n    {\n      \"product_id\": \"pro_premium1...\", \u002F\u002F replaces the current recurring lines\n      \"qty\": 1\n    }\n  ],\n  \"is_immediate\": false, \u002F\u002F [optional] default false — apply on the next billing date; true bills the new plan now and resets the billing anchor\n\n  \"signature\": \"secret-key-for-payload\" \u002F\u002F [optional] shared-secret signature for the payload, see the signature section below\n}\n",[167,2901,2902,2906,2918,2922,2944,2956,2960,2964,2980,2984,3002],{"__ignoreMap":303},[307,2903,2904],{"class":309,"line":310},[307,2905,314],{"class":313},[307,2907,2908,2910,2912,2914,2916],{"class":309,"line":317},[307,2909,320],{"class":313},[307,2911,199],{"class":323},[307,2913,326],{"class":313},[307,2915,329],{"class":313},[307,2917,332],{"class":313},[307,2919,2920],{"class":309,"line":335},[307,2921,338],{"class":313},[307,2923,2924,2926,2928,2930,2932,2934,2937,2939,2941],{"class":309,"line":341},[307,2925,344],{"class":313},[307,2927,348],{"class":347},[307,2929,326],{"class":313},[307,2931,329],{"class":313},[307,2933,355],{"class":313},[307,2935,2936],{"class":358},"pro_premium1...",[307,2938,326],{"class":313},[307,2940,364],{"class":313},[307,2942,2943],{"class":367}," \u002F\u002F replaces the current recurring lines\n",[307,2945,2946,2948,2950,2952,2954],{"class":309,"line":371},[307,2947,344],{"class":313},[307,2949,376],{"class":347},[307,2951,326],{"class":313},[307,2953,329],{"class":313},[307,2955,496],{"class":383},[307,2957,2958],{"class":309,"line":390},[307,2959,393],{"class":313},[307,2961,2962],{"class":309,"line":396},[307,2963,399],{"class":313},[307,2965,2966,2968,2970,2972,2974,2977],{"class":309,"line":402},[307,2967,320],{"class":313},[307,2969,2847],{"class":323},[307,2971,326],{"class":313},[307,2973,329],{"class":313},[307,2975,2976],{"class":313}," false,",[307,2978,2979],{"class":367}," \u002F\u002F [optional] default false — apply on the next billing date; true bills the new plan now and resets the billing anchor\n",[307,2981,2982],{"class":309,"line":424},[307,2983,730],{"emptyLinePlaceholder":729},[307,2985,2986,2988,2990,2992,2994,2996,2998,3000],{"class":309,"line":532},[307,2987,320],{"class":313},[307,2989,793],{"class":323},[307,2991,326],{"class":313},[307,2993,329],{"class":313},[307,2995,355],{"class":313},[307,2997,802],{"class":358},[307,2999,326],{"class":313},[307,3001,809],{"class":367},[307,3003,3004],{"class":309,"line":537},[307,3005,427],{"class":313},[232,3007,1358],{"id":3008},"request-parameters-1",[246,3010,3011,3029],{},[249,3012,3013],{},[252,3014,3015,3019,3021,3023,3027],{},[255,3016,3017],{"align":257},[1384,3018,1387],{"style":1386},[255,3020,1390],{"align":257},[255,3022,261],{"align":257},[255,3024,3025],{"align":257},[1384,3026,264],{"style":1397},[255,3028,267],{"align":257},[269,3030,3031,3050,3066],{},[252,3032,3033,3035,3037,3039,3047],{},[274,3034,199],{"align":257},[274,3036,1369],{"align":257},[274,3038,1410],{"align":257},[274,3040,3041,3042,3044,3045],{"align":257},"New ",[167,3043,203],{}," line items; replaces the current lines and re-derives the billing period from the products — same shape as on ",[163,3046,2834],{"href":2833},[274,3048,3049],{"align":257},"See example",[252,3051,3052,3054,3056,3058,3064],{},[274,3053,2847],{"align":257},[274,3055,1457],{"align":257},[274,3057,1653],{"align":257},[274,3059,3060,3061,3063],{"align":257},"Bill the new plan immediately and reset the billing anchor to today. Default ",[167,3062,1659],{}," — the new plan takes effect on the next billing date",[274,3065,1659],{"align":257},[252,3067,3068,3070,3072,3074,3076],{},[274,3069,793],{"align":257},[274,3071,1457],{"align":257},[274,3073,1442],{"align":257},[274,3075,1778],{"align":257},[274,3077,802],{"align":257},[232,3079,1890],{"id":3080},"response-body-1",[298,3082,3084],{"className":300,"code":3083,"language":302,"meta":303,"style":303},"{\n    \"status\": true,\n    \"result\": {\n      \"id\": \"sub_Wt5RmK2xPqLv9nYcE7aBz\",\n      \"customer_id\": \"cus_abc123...\",\n      \"subscription_status\": \"ACTIVE\",\n      \"change_plan_at\": \"2026-09-01T00:00:00Z\",\n      \"change_plan_items\": [\n        {\n          \"product_id\": \"pro_premium1...\",\n          \"qty\": 1\n        }\n      ],\n      \"date_next_billing\": \"2026-09-01\"\n    }\n}\n",[167,3085,3086,3090,3102,3114,3132,3150,3168,3187,3199,3203,3221,3233,3237,3241,3258,3262],{"__ignoreMap":303},[307,3087,3088],{"class":309,"line":310},[307,3089,314],{"class":313},[307,3091,3092,3094,3096,3098,3100],{"class":309,"line":317},[307,3093,841],{"class":313},[307,3095,1945],{"class":323},[307,3097,326],{"class":313},[307,3099,329],{"class":313},[307,3101,1164],{"class":313},[307,3103,3104,3106,3108,3110,3112],{"class":309,"line":335},[307,3105,841],{"class":313},[307,3107,1958],{"class":323},[307,3109,326],{"class":313},[307,3111,329],{"class":313},[307,3113,835],{"class":313},[307,3115,3116,3118,3120,3122,3124,3126,3128,3130],{"class":309,"line":341},[307,3117,344],{"class":313},[307,3119,1971],{"class":347},[307,3121,326],{"class":313},[307,3123,329],{"class":313},[307,3125,355],{"class":313},[307,3127,1980],{"class":358},[307,3129,326],{"class":313},[307,3131,628],{"class":313},[307,3133,3134,3136,3138,3140,3142,3144,3146,3148],{"class":309,"line":371},[307,3135,344],{"class":313},[307,3137,276],{"class":347},[307,3139,326],{"class":313},[307,3141,329],{"class":313},[307,3143,355],{"class":313},[307,3145,289],{"class":358},[307,3147,326],{"class":313},[307,3149,628],{"class":313},[307,3151,3152,3154,3156,3158,3160,3162,3164,3166],{"class":309,"line":390},[307,3153,344],{"class":313},[307,3155,2027],{"class":347},[307,3157,326],{"class":313},[307,3159,329],{"class":313},[307,3161,355],{"class":313},[307,3163,179],{"class":358},[307,3165,326],{"class":313},[307,3167,628],{"class":313},[307,3169,3170,3172,3174,3176,3178,3180,3183,3185],{"class":309,"line":396},[307,3171,344],{"class":313},[307,3173,2854],{"class":347},[307,3175,326],{"class":313},[307,3177,329],{"class":313},[307,3179,355],{"class":313},[307,3181,3182],{"class":358},"2026-09-01T00:00:00Z",[307,3184,326],{"class":313},[307,3186,628],{"class":313},[307,3188,3189,3191,3193,3195,3197],{"class":309,"line":402},[307,3190,344],{"class":313},[307,3192,2851],{"class":347},[307,3194,326],{"class":313},[307,3196,329],{"class":313},[307,3198,332],{"class":313},[307,3200,3201],{"class":309,"line":424},[307,3202,2087],{"class":313},[307,3204,3205,3207,3209,3211,3213,3215,3217,3219],{"class":309,"line":532},[307,3206,2092],{"class":313},[307,3208,348],{"class":383},[307,3210,326],{"class":313},[307,3212,329],{"class":313},[307,3214,355],{"class":313},[307,3216,2936],{"class":358},[307,3218,326],{"class":313},[307,3220,628],{"class":313},[307,3222,3223,3225,3227,3229,3231],{"class":309,"line":537},[307,3224,2092],{"class":313},[307,3226,376],{"class":383},[307,3228,326],{"class":313},[307,3230,329],{"class":313},[307,3232,496],{"class":383},[307,3234,3235],{"class":309,"line":557},[307,3236,2138],{"class":313},[307,3238,3239],{"class":309,"line":575},[307,3240,2143],{"class":313},[307,3242,3243,3245,3247,3249,3251,3253,3256],{"class":309,"line":721},[307,3244,344],{"class":313},[307,3246,2401],{"class":347},[307,3248,326],{"class":313},[307,3250,329],{"class":313},[307,3252,355],{"class":313},[307,3254,3255],{"class":358},"2026-09-01",[307,3257,572],{"class":313},[307,3259,3260],{"class":309,"line":726},[307,3261,393],{"class":313},[307,3263,3264],{"class":309,"line":733},[307,3265,427],{"class":313},[232,3267,2480],{"id":3268},"response-parameters-1",[246,3270,3271,3287],{},[249,3272,3273],{},[252,3274,3275,3279,3281,3285],{},[255,3276,3277],{"align":257},[1384,3278,1387],{"style":1386},[255,3280,261],{"align":257},[255,3282,3283],{"align":257},[1384,3284,264],{"style":1397},[255,3286,267],{"align":257},[269,3288,3289,3300,3311,3321,3336,3351,3367],{},[252,3290,3291,3293,3295,3298],{},[274,3292,1945],{"align":257},[274,3294,1653],{"align":257},[274,3296,3297],{"align":257},"Whether the plan change was scheduled or applied",[274,3299,1663],{"align":257},[252,3301,3302,3304,3306,3309],{},[274,3303,2516],{"align":257},[274,3305,279],{"align":257},[274,3307,3308],{"align":257},"The subscription the plan change belongs to",[274,3310,1980],{"align":257},[252,3312,3313,3315,3317,3319],{},[274,3314,2528],{"align":257},[274,3316,279],{"align":257},[274,3318,2533],{"align":257},[274,3320,289],{"align":257},[252,3322,3323,3325,3327,3332],{},[274,3324,2552],{"align":257},[274,3326,1578],{"align":257},[274,3328,3329,3330],{"align":257},"Subscription state, see ",[163,3331,1590],{"href":1589},[274,3333,3334],{"align":257},[167,3335,179],{},[252,3337,3338,3341,3343,3349],{},[274,3339,3340],{"align":257},"result.change_plan_at",[274,3342,1442],{"align":257},[274,3344,3345,3346,3348],{"align":257},"ISO timestamp when the new plan takes effect; ",[167,3347,2612],{}," once applied",[274,3350,3182],{"align":257},[252,3352,3353,3356,3358,3363],{},[274,3354,3355],{"align":257},"result.change_plan_items",[274,3357,1410],{"align":257},[274,3359,3360,3361,3348],{"align":257},"The pending recurring line items; ",[167,3362,2612],{},[274,3364,3365],{"align":257},[307,3366,2632],{},[252,3368,3369,3371,3373,3375],{},[274,3370,2758],{"align":257},[274,3372,1442],{"align":257},[274,3374,2763],{"align":257},[274,3376,3255],{"align":257},[154,3378,3380],{"id":3379},"pause-request","Pause Request",[159,3382,3383,3384,3386,3387,3389,3390,188],{},"Pause an ",[167,3385,179],{}," or ",[167,3388,1566],{}," subscription. No charges occur while paused and the billing schedule is suspended. Resume at any time with the ",[163,3391,3393],{"href":3392},"#resume-request","resume request",[232,3395,235],{"id":3396},"path-2",[159,3398,3399,241,3401],{},[167,3400,240],{},[167,3402,3403],{},"\u002Fsubscriptions\u002F{subscription_id}\u002Fpause",[246,3405,3406,3418],{},[249,3407,3408],{},[252,3409,3410,3412,3414,3416],{},[255,3411,258],{"align":257},[255,3413,261],{"align":257},[255,3415,264],{"align":257},[255,3417,267],{"align":257},[269,3419,3420],{},[252,3421,3422,3424,3426,3429],{},[274,3423,2886],{"align":257},[274,3425,279],{"align":257},[274,3427,3428],{"align":257},"The subscription to pause",[274,3430,1980],{"align":257},[232,3432,267],{"id":3433},"example-1",[159,3435,3436,3437,3440],{},"An empty body (or ",[167,3438,3439],{},"{}",") is valid.",[298,3442,3444],{"className":300,"code":3443,"language":302,"meta":303,"style":303},"{\n  \"signature\": \"secret-key-for-payload\" \u002F\u002F [optional] shared-secret signature for the payload, see the signature section below\n}\n",[167,3445,3446,3450,3468],{"__ignoreMap":303},[307,3447,3448],{"class":309,"line":310},[307,3449,314],{"class":313},[307,3451,3452,3454,3456,3458,3460,3462,3464,3466],{"class":309,"line":317},[307,3453,320],{"class":313},[307,3455,793],{"class":323},[307,3457,326],{"class":313},[307,3459,329],{"class":313},[307,3461,355],{"class":313},[307,3463,802],{"class":358},[307,3465,326],{"class":313},[307,3467,809],{"class":367},[307,3469,3470],{"class":309,"line":335},[307,3471,427],{"class":313},[232,3473,1890],{"id":3474},"response-body-2",[298,3476,3478],{"className":300,"code":3477,"language":302,"meta":303,"style":303},"{\n    \"status\": true,\n    \"result\": {\n      \"id\": \"sub_Wt5RmK2xPqLv9nYcE7aBz\",\n      \"customer_id\": \"cus_abc123...\",\n      \"subscription_status\": \"PAUSED\",\n      \"date_next_billing\": null,\n      \"paused_at\": \"2026-08-15T09:20:00Z\"\n    }\n}\n",[167,3479,3480,3484,3496,3508,3526,3544,3562,3574,3592,3596],{"__ignoreMap":303},[307,3481,3482],{"class":309,"line":310},[307,3483,314],{"class":313},[307,3485,3486,3488,3490,3492,3494],{"class":309,"line":317},[307,3487,841],{"class":313},[307,3489,1945],{"class":323},[307,3491,326],{"class":313},[307,3493,329],{"class":313},[307,3495,1164],{"class":313},[307,3497,3498,3500,3502,3504,3506],{"class":309,"line":335},[307,3499,841],{"class":313},[307,3501,1958],{"class":323},[307,3503,326],{"class":313},[307,3505,329],{"class":313},[307,3507,835],{"class":313},[307,3509,3510,3512,3514,3516,3518,3520,3522,3524],{"class":309,"line":341},[307,3511,344],{"class":313},[307,3513,1971],{"class":347},[307,3515,326],{"class":313},[307,3517,329],{"class":313},[307,3519,355],{"class":313},[307,3521,1980],{"class":358},[307,3523,326],{"class":313},[307,3525,628],{"class":313},[307,3527,3528,3530,3532,3534,3536,3538,3540,3542],{"class":309,"line":371},[307,3529,344],{"class":313},[307,3531,276],{"class":347},[307,3533,326],{"class":313},[307,3535,329],{"class":313},[307,3537,355],{"class":313},[307,3539,289],{"class":358},[307,3541,326],{"class":313},[307,3543,628],{"class":313},[307,3545,3546,3548,3550,3552,3554,3556,3558,3560],{"class":309,"line":390},[307,3547,344],{"class":313},[307,3549,2027],{"class":347},[307,3551,326],{"class":313},[307,3553,329],{"class":313},[307,3555,355],{"class":313},[307,3557,2564],{"class":358},[307,3559,326],{"class":313},[307,3561,628],{"class":313},[307,3563,3564,3566,3568,3570,3572],{"class":309,"line":396},[307,3565,344],{"class":313},[307,3567,2401],{"class":347},[307,3569,326],{"class":313},[307,3571,329],{"class":313},[307,3573,2070],{"class":313},[307,3575,3576,3578,3581,3583,3585,3587,3590],{"class":309,"line":402},[307,3577,344],{"class":313},[307,3579,3580],{"class":347},"paused_at",[307,3582,326],{"class":313},[307,3584,329],{"class":313},[307,3586,355],{"class":313},[307,3588,3589],{"class":358},"2026-08-15T09:20:00Z",[307,3591,572],{"class":313},[307,3593,3594],{"class":309,"line":424},[307,3595,393],{"class":313},[307,3597,3598],{"class":309,"line":532},[307,3599,427],{"class":313},[154,3601,3603],{"id":3602},"resume-request","Resume Request",[159,3605,3606,3607,3609,3610,3613],{},"Resume a ",[167,3608,2564],{}," subscription. Billing restarts on the next scheduled date; pass ",[167,3611,3612],{},"is_bill_now"," to charge the current cycle immediately and reset the billing anchor to today.",[232,3615,235],{"id":3616},"path-3",[159,3618,3619,241,3621],{},[167,3620,240],{},[167,3622,3623],{},"\u002Fsubscriptions\u002F{subscription_id}\u002Fresume",[246,3625,3626,3638],{},[249,3627,3628],{},[252,3629,3630,3632,3634,3636],{},[255,3631,258],{"align":257},[255,3633,261],{"align":257},[255,3635,264],{"align":257},[255,3637,267],{"align":257},[269,3639,3640],{},[252,3641,3642,3644,3646,3649],{},[274,3643,2886],{"align":257},[274,3645,279],{"align":257},[274,3647,3648],{"align":257},"The subscription to resume",[274,3650,1980],{"align":257},[232,3652,267],{"id":3653},"example-2",[159,3655,3436,3656,3440],{},[167,3657,3439],{},[298,3659,3661],{"className":300,"code":3660,"language":302,"meta":303,"style":303},"{\n  \"is_bill_now\": false, \u002F\u002F [optional] default false — resume on the next scheduled billing date; true charges the current cycle now and resets the billing anchor\n  \"signature\": \"secret-key-for-payload\" \u002F\u002F [optional] shared-secret signature for the payload, see the signature section below\n}\n",[167,3662,3663,3667,3682,3700],{"__ignoreMap":303},[307,3664,3665],{"class":309,"line":310},[307,3666,314],{"class":313},[307,3668,3669,3671,3673,3675,3677,3679],{"class":309,"line":317},[307,3670,320],{"class":313},[307,3672,3612],{"class":323},[307,3674,326],{"class":313},[307,3676,329],{"class":313},[307,3678,2976],{"class":313},[307,3680,3681],{"class":367}," \u002F\u002F [optional] default false — resume on the next scheduled billing date; true charges the current cycle now and resets the billing anchor\n",[307,3683,3684,3686,3688,3690,3692,3694,3696,3698],{"class":309,"line":335},[307,3685,320],{"class":313},[307,3687,793],{"class":323},[307,3689,326],{"class":313},[307,3691,329],{"class":313},[307,3693,355],{"class":313},[307,3695,802],{"class":358},[307,3697,326],{"class":313},[307,3699,809],{"class":367},[307,3701,3702],{"class":309,"line":341},[307,3703,427],{"class":313},[232,3705,1890],{"id":3706},"response-body-3",[298,3708,3710],{"className":300,"code":3709,"language":302,"meta":303,"style":303},"{\n    \"status\": true,\n    \"result\": {\n      \"id\": \"sub_Wt5RmK2xPqLv9nYcE7aBz\",\n      \"customer_id\": \"cus_abc123...\",\n      \"subscription_status\": \"ACTIVE\",\n      \"date_next_billing\": \"2026-09-01\",\n      \"resumed_at\": \"2026-08-20T09:20:00Z\"\n    }\n}\n",[167,3711,3712,3716,3728,3740,3758,3776,3794,3812,3830,3834],{"__ignoreMap":303},[307,3713,3714],{"class":309,"line":310},[307,3715,314],{"class":313},[307,3717,3718,3720,3722,3724,3726],{"class":309,"line":317},[307,3719,841],{"class":313},[307,3721,1945],{"class":323},[307,3723,326],{"class":313},[307,3725,329],{"class":313},[307,3727,1164],{"class":313},[307,3729,3730,3732,3734,3736,3738],{"class":309,"line":335},[307,3731,841],{"class":313},[307,3733,1958],{"class":323},[307,3735,326],{"class":313},[307,3737,329],{"class":313},[307,3739,835],{"class":313},[307,3741,3742,3744,3746,3748,3750,3752,3754,3756],{"class":309,"line":341},[307,3743,344],{"class":313},[307,3745,1971],{"class":347},[307,3747,326],{"class":313},[307,3749,329],{"class":313},[307,3751,355],{"class":313},[307,3753,1980],{"class":358},[307,3755,326],{"class":313},[307,3757,628],{"class":313},[307,3759,3760,3762,3764,3766,3768,3770,3772,3774],{"class":309,"line":371},[307,3761,344],{"class":313},[307,3763,276],{"class":347},[307,3765,326],{"class":313},[307,3767,329],{"class":313},[307,3769,355],{"class":313},[307,3771,289],{"class":358},[307,3773,326],{"class":313},[307,3775,628],{"class":313},[307,3777,3778,3780,3782,3784,3786,3788,3790,3792],{"class":309,"line":390},[307,3779,344],{"class":313},[307,3781,2027],{"class":347},[307,3783,326],{"class":313},[307,3785,329],{"class":313},[307,3787,355],{"class":313},[307,3789,179],{"class":358},[307,3791,326],{"class":313},[307,3793,628],{"class":313},[307,3795,3796,3798,3800,3802,3804,3806,3808,3810],{"class":309,"line":396},[307,3797,344],{"class":313},[307,3799,2401],{"class":347},[307,3801,326],{"class":313},[307,3803,329],{"class":313},[307,3805,355],{"class":313},[307,3807,3255],{"class":358},[307,3809,326],{"class":313},[307,3811,628],{"class":313},[307,3813,3814,3816,3819,3821,3823,3825,3828],{"class":309,"line":402},[307,3815,344],{"class":313},[307,3817,3818],{"class":347},"resumed_at",[307,3820,326],{"class":313},[307,3822,329],{"class":313},[307,3824,355],{"class":313},[307,3826,3827],{"class":358},"2026-08-20T09:20:00Z",[307,3829,572],{"class":313},[307,3831,3832],{"class":309,"line":424},[307,3833,393],{"class":313},[307,3835,3836],{"class":309,"line":532},[307,3837,427],{"class":313},[154,3839,3841],{"id":3840},"cancel-request","Cancel Request",[159,3843,3844,3845,3847],{},"Cancel a subscription. By default the cancellation takes effect at the end of the current billing period — the customer keeps access until the next billing date and no further charges occur. Pass ",[167,3846,2847],{}," to cancel right away. Cancellation is permanent; create a new subscription to bill the customer again.",[232,3849,235],{"id":3850},"path-4",[159,3852,3853,241,3855],{},[167,3854,240],{},[167,3856,3857],{},"\u002Fsubscriptions\u002F{subscription_id}\u002Fcancel",[246,3859,3860,3872],{},[249,3861,3862],{},[252,3863,3864,3866,3868,3870],{},[255,3865,258],{"align":257},[255,3867,261],{"align":257},[255,3869,264],{"align":257},[255,3871,267],{"align":257},[269,3873,3874],{},[252,3875,3876,3878,3880,3883],{},[274,3877,2886],{"align":257},[274,3879,279],{"align":257},[274,3881,3882],{"align":257},"The subscription to cancel",[274,3884,1980],{"align":257},[232,3886,267],{"id":3887},"example-3",[159,3889,3436,3890,3440],{},[167,3891,3439],{},[298,3893,3895],{"className":300,"code":3894,"language":302,"meta":303,"style":303},"{\n  \"is_immediate\": false, \u002F\u002F [optional] default false — cancel at the end of the current billing period\n  \"reason\": \"Customer downgraded\", \u002F\u002F [optional] recorded against the cancellation for reporting\n\n  \"signature\": \"secret-key-for-payload\" \u002F\u002F [optional] shared-secret signature for the payload, see the signature section below\n}\n",[167,3896,3897,3901,3916,3939,3943,3961],{"__ignoreMap":303},[307,3898,3899],{"class":309,"line":310},[307,3900,314],{"class":313},[307,3902,3903,3905,3907,3909,3911,3913],{"class":309,"line":317},[307,3904,320],{"class":313},[307,3906,2847],{"class":323},[307,3908,326],{"class":313},[307,3910,329],{"class":313},[307,3912,2976],{"class":313},[307,3914,3915],{"class":367}," \u002F\u002F [optional] default false — cancel at the end of the current billing period\n",[307,3917,3918,3920,3923,3925,3927,3929,3932,3934,3936],{"class":309,"line":335},[307,3919,320],{"class":313},[307,3921,3922],{"class":323},"reason",[307,3924,326],{"class":313},[307,3926,329],{"class":313},[307,3928,355],{"class":313},[307,3930,3931],{"class":358},"Customer downgraded",[307,3933,326],{"class":313},[307,3935,364],{"class":313},[307,3937,3938],{"class":367}," \u002F\u002F [optional] recorded against the cancellation for reporting\n",[307,3940,3941],{"class":309,"line":341},[307,3942,730],{"emptyLinePlaceholder":729},[307,3944,3945,3947,3949,3951,3953,3955,3957,3959],{"class":309,"line":371},[307,3946,320],{"class":313},[307,3948,793],{"class":323},[307,3950,326],{"class":313},[307,3952,329],{"class":313},[307,3954,355],{"class":313},[307,3956,802],{"class":358},[307,3958,326],{"class":313},[307,3960,809],{"class":367},[307,3962,3963],{"class":309,"line":390},[307,3964,427],{"class":313},[232,3966,1358],{"id":3967},"request-parameters-2",[246,3969,3970,3988],{},[249,3971,3972],{},[252,3973,3974,3978,3980,3982,3986],{},[255,3975,3976],{"align":257},[1384,3977,1387],{"style":1386},[255,3979,1390],{"align":257},[255,3981,261],{"align":257},[255,3983,3984],{"align":257},[1384,3985,264],{"style":1397},[255,3987,267],{"align":257},[269,3989,3990,4005,4018],{},[252,3991,3992,3994,3996,3998,4003],{},[274,3993,2847],{"align":257},[274,3995,1457],{"align":257},[274,3997,1653],{"align":257},[274,3999,4000,4001],{"align":257},"Cancel immediately instead of at the end of the current billing period. Default ",[167,4002,1659],{},[274,4004,1659],{"align":257},[252,4006,4007,4009,4011,4013,4016],{},[274,4008,3922],{"align":257},[274,4010,1457],{"align":257},[274,4012,1442],{"align":257},[274,4014,4015],{"align":257},"Optional reason recorded against the cancellation for reporting",[274,4017,3931],{"align":257},[252,4019,4020,4022,4024,4026,4028],{},[274,4021,793],{"align":257},[274,4023,1457],{"align":257},[274,4025,1442],{"align":257},[274,4027,1778],{"align":257},[274,4029,802],{"align":257},[232,4031,1890],{"id":4032},"response-body-4",[298,4034,4036],{"className":300,"code":4035,"language":302,"meta":303,"style":303},"{\n    \"status\": true,\n    \"result\": {\n      \"id\": \"sub_Wt5RmK2xPqLv9nYcE7aBz\",\n      \"customer_id\": \"cus_abc123...\",\n      \"subscription_status\": \"ACTIVE\",\n      \"date_cancel\": \"2026-09-01\",\n      \"cancel_reason\": \"Customer downgraded\",\n      \"date_next_billing\": null\n    }\n}\n",[167,4037,4038,4042,4054,4066,4084,4102,4120,4139,4158,4171,4175],{"__ignoreMap":303},[307,4039,4040],{"class":309,"line":310},[307,4041,314],{"class":313},[307,4043,4044,4046,4048,4050,4052],{"class":309,"line":317},[307,4045,841],{"class":313},[307,4047,1945],{"class":323},[307,4049,326],{"class":313},[307,4051,329],{"class":313},[307,4053,1164],{"class":313},[307,4055,4056,4058,4060,4062,4064],{"class":309,"line":335},[307,4057,841],{"class":313},[307,4059,1958],{"class":323},[307,4061,326],{"class":313},[307,4063,329],{"class":313},[307,4065,835],{"class":313},[307,4067,4068,4070,4072,4074,4076,4078,4080,4082],{"class":309,"line":341},[307,4069,344],{"class":313},[307,4071,1971],{"class":347},[307,4073,326],{"class":313},[307,4075,329],{"class":313},[307,4077,355],{"class":313},[307,4079,1980],{"class":358},[307,4081,326],{"class":313},[307,4083,628],{"class":313},[307,4085,4086,4088,4090,4092,4094,4096,4098,4100],{"class":309,"line":371},[307,4087,344],{"class":313},[307,4089,276],{"class":347},[307,4091,326],{"class":313},[307,4093,329],{"class":313},[307,4095,355],{"class":313},[307,4097,289],{"class":358},[307,4099,326],{"class":313},[307,4101,628],{"class":313},[307,4103,4104,4106,4108,4110,4112,4114,4116,4118],{"class":309,"line":390},[307,4105,344],{"class":313},[307,4107,2027],{"class":347},[307,4109,326],{"class":313},[307,4111,329],{"class":313},[307,4113,355],{"class":313},[307,4115,179],{"class":358},[307,4117,326],{"class":313},[307,4119,628],{"class":313},[307,4121,4122,4124,4127,4129,4131,4133,4135,4137],{"class":309,"line":396},[307,4123,344],{"class":313},[307,4125,4126],{"class":347},"date_cancel",[307,4128,326],{"class":313},[307,4130,329],{"class":313},[307,4132,355],{"class":313},[307,4134,3255],{"class":358},[307,4136,326],{"class":313},[307,4138,628],{"class":313},[307,4140,4141,4143,4146,4148,4150,4152,4154,4156],{"class":309,"line":402},[307,4142,344],{"class":313},[307,4144,4145],{"class":347},"cancel_reason",[307,4147,326],{"class":313},[307,4149,329],{"class":313},[307,4151,355],{"class":313},[307,4153,3931],{"class":358},[307,4155,326],{"class":313},[307,4157,628],{"class":313},[307,4159,4160,4162,4164,4166,4168],{"class":309,"line":424},[307,4161,344],{"class":313},[307,4163,2401],{"class":347},[307,4165,326],{"class":313},[307,4167,329],{"class":313},[307,4169,4170],{"class":313}," null\n",[307,4172,4173],{"class":309,"line":532},[307,4174,393],{"class":313},[307,4176,4177],{"class":309,"line":537},[307,4178,427],{"class":313},[232,4180,2480],{"id":4181},"response-parameters-2",[246,4183,4184,4200],{},[249,4185,4186],{},[252,4187,4188,4192,4194,4198],{},[255,4189,4190],{"align":257},[1384,4191,1387],{"style":1386},[255,4193,261],{"align":257},[255,4195,4196],{"align":257},[1384,4197,264],{"style":1397},[255,4199,267],{"align":257},[269,4201,4202,4213,4224,4234,4262,4274,4286],{},[252,4203,4204,4206,4208,4211],{},[274,4205,1945],{"align":257},[274,4207,1653],{"align":257},[274,4209,4210],{"align":257},"Whether the cancellation was scheduled or applied",[274,4212,1663],{"align":257},[252,4214,4215,4217,4219,4222],{},[274,4216,2516],{"align":257},[274,4218,279],{"align":257},[274,4220,4221],{"align":257},"The subscription the cancellation belongs to",[274,4223,1980],{"align":257},[252,4225,4226,4228,4230,4232],{},[274,4227,2528],{"align":257},[274,4229,279],{"align":257},[274,4231,2533],{"align":257},[274,4233,289],{"align":257},[252,4235,4236,4238,4240,4258],{},[274,4237,2552],{"align":257},[274,4239,1578],{"align":257},[274,4241,4242,4243,4245,4246,4248,4249,4251,4252,184,4254,2577,4256],{"align":257},"Remains ",[167,4244,179],{}," until the scheduled cancellation date, then ",[167,4247,2567],{},"; ",[167,4250,2567],{}," immediately when ",[167,4253,2847],{},[167,4255,1663],{},[163,4257,1590],{"href":1589},[274,4259,4260],{"align":257},[167,4261,179],{},[252,4263,4264,4267,4269,4272],{},[274,4265,4266],{"align":257},"result.date_cancel",[274,4268,1442],{"align":257},[274,4270,4271],{"align":257},"Date the cancellation takes effect",[274,4273,3255],{"align":257},[252,4275,4276,4279,4281,4284],{},[274,4277,4278],{"align":257},"result.cancel_reason",[274,4280,1442],{"align":257},[274,4282,4283],{"align":257},"Reason recorded against the cancellation",[274,4285,3931],{"align":257},[252,4287,4288,4290,4292,4297],{},[274,4289,2758],{"align":257},[274,4291,1442],{"align":257},[274,4293,4294,4296],{"align":257},[167,4295,2612],{}," — no further billing occurs",[274,4298,2612],{"align":257},[154,4300,4302],{"id":4301},"failed-payments","Failed payments",[159,4304,4305,4306,4308,4309,4312,4313,4315,4316,4318,4319,4321,4322,188],{},"When an ",[167,4307,951],{}," billing cycle declines on all cards, the charge is retried daily for up to 3 days. Each attempt fires ",[167,4310,4311],{},"subscription.charge_failed",". If all retries are exhausted, the subscription moves to ",[167,4314,2572],{}," and billing stops until a successful payment is collected — for example after the customer stores a new card via a ",[163,4317,95],{"href":96},", the next retry or a manual ",[163,4320,99],{"href":100}," restores the subscription to ",[167,4323,179],{},[154,4325,4327],{"id":4326},"signature-creation","Signature creation",[159,4329,4330,4331,4333,4334,4338],{},"When creating API keys on the dashboard you can download a passphrase key, use it to generate your signature and send it in the ",[167,4332,793],{}," parameter. The canonicalization and HMAC-SHA256 process is identical across all endpoints — see ",[163,4335,4337],{"href":4336},"\u002Fv2\u002Fmoney-in\u002Fcheckout-link#signature-creation","Checkout Link — Signature creation"," for Node.js, PHP, C#, Java, and Python examples.",[154,4340,4342],{"id":4341},"webhook","Webhook",[159,4344,4345,4346,4348],{},"Webhooks are delivered to ",[167,4347,1858],{}," for each subscription lifecycle event when that field was supplied on create. Broader platform webhooks are configured separately if applicable. Billing-cycle webhooks fire once per cycle outcome, not per cascade attempt.",[159,4350,4351,4352,4355,4356,1699,4359,1699,4362,4364,4365,188],{},"Possible ",[167,4353,4354],{},"event"," values include ",[167,4357,4358],{},"subscription.created",[167,4360,4361],{},"subscription.charged",[167,4363,4311],{},", and others listed under ",[163,4366,4368],{"href":4367},"#webhook-events","Webhook events",[232,4370,4372],{"id":4371},"webhook-payload","Webhook Payload",[298,4374,4376],{"className":300,"code":4375,"language":302,"meta":303,"style":303},"{\n  \u002F\u002F subscription.created · subscription.activated · subscription.charged · subscription.charge_failed ·\n  \u002F\u002F subscription.plan_changed · subscription.paused · subscription.resumed · subscription.cancelled ·\n  \u002F\u002F subscription.expired · subscription.failed\n  \"event\": \"subscription.charged\",\n  \"data\": [\n    {\n      \"subscription\": {\n        \"id\": \"sub_Wt5RmK2xPqLv9nYcE7aBz\",\n        \"customer_id\": \"cus_abc123...\",\n        \"reference\": \"SUB-2026-00042\",\n        \"subscription_status\": \"ACTIVE\",\n        \"collection_method\": \"AUTOCHARGE\",\n        \"total_recurring_excl\": \"600.46\",\n        \"total_recurring_incl\": \"690.53\",\n        \"currency\": \"ZAR\",\n        \"billing\": {\n          \"period\": \"MONTHLY\",\n          \"billing_day\": 1,\n          \"date_start\": \"2026-08-01\",\n          \"date_end\": \"2027-07-31\"\n        },\n        \"date_last_billing\": \"2026-08-01\", \u002F\u002F present from the first billing cycle\n        \"date_next_billing\": \"2026-09-01\",\n        \"card_id\": \"crd_9kLmXw3RtYqPz8vNcE2aB\", \u002F\u002F card charged for this cycle; present on subscription.charged\n        \"transaction_id\": \"tra_pr6CvR_4pvWwmgQ4y3dtY\", \u002F\u002F present on subscription.charged\n        \"invoice_id\": \"inv_k2Jd8sLqPz...\", \u002F\u002F present when invoice.is_generate was true\n        \"error\": null, \u002F\u002F decline details; present on subscription.charge_failed\n        \"metadata\": {\n          \"order_id\": \"ord_98765\"\n        },\n        \"completed_at\": \"2026-08-01T06:00:00Z\"\n      }\n    }\n  ],\n  \"created_at\": \"2026-08-01T06:00:00Z\"\n}\n",[167,4377,4378,4382,4387,4392,4397,4415,4428,4432,4445,4463,4481,4499,4517,4535,4553,4571,4589,4601,4620,4634,4652,4668,4673,4694,4712,4734,4756,4778,4795,4807,4823,4827,4845,4850,4854,4858,4874],{"__ignoreMap":303},[307,4379,4380],{"class":309,"line":310},[307,4381,314],{"class":313},[307,4383,4384],{"class":309,"line":317},[307,4385,4386],{"class":367},"  \u002F\u002F subscription.created · subscription.activated · subscription.charged · subscription.charge_failed ·\n",[307,4388,4389],{"class":309,"line":335},[307,4390,4391],{"class":367},"  \u002F\u002F subscription.plan_changed · subscription.paused · subscription.resumed · subscription.cancelled ·\n",[307,4393,4394],{"class":309,"line":341},[307,4395,4396],{"class":367},"  \u002F\u002F subscription.expired · subscription.failed\n",[307,4398,4399,4401,4403,4405,4407,4409,4411,4413],{"class":309,"line":371},[307,4400,320],{"class":313},[307,4402,4354],{"class":323},[307,4404,326],{"class":313},[307,4406,329],{"class":313},[307,4408,355],{"class":313},[307,4410,4361],{"class":358},[307,4412,326],{"class":313},[307,4414,628],{"class":313},[307,4416,4417,4419,4422,4424,4426],{"class":309,"line":390},[307,4418,320],{"class":313},[307,4420,4421],{"class":323},"data",[307,4423,326],{"class":313},[307,4425,329],{"class":313},[307,4427,332],{"class":313},[307,4429,4430],{"class":309,"line":396},[307,4431,338],{"class":313},[307,4433,4434,4436,4439,4441,4443],{"class":309,"line":402},[307,4435,344],{"class":313},[307,4437,4438],{"class":347},"subscription",[307,4440,326],{"class":313},[307,4442,329],{"class":313},[307,4444,835],{"class":313},[307,4446,4447,4449,4451,4453,4455,4457,4459,4461],{"class":309,"line":424},[307,4448,2214],{"class":313},[307,4450,1971],{"class":383},[307,4452,326],{"class":313},[307,4454,329],{"class":313},[307,4456,355],{"class":313},[307,4458,1980],{"class":358},[307,4460,326],{"class":313},[307,4462,628],{"class":313},[307,4464,4465,4467,4469,4471,4473,4475,4477,4479],{"class":309,"line":532},[307,4466,2214],{"class":313},[307,4468,276],{"class":383},[307,4470,326],{"class":313},[307,4472,329],{"class":313},[307,4474,355],{"class":313},[307,4476,289],{"class":358},[307,4478,326],{"class":313},[307,4480,628],{"class":313},[307,4482,4483,4485,4487,4489,4491,4493,4495,4497],{"class":309,"line":537},[307,4484,2214],{"class":313},[307,4486,407],{"class":383},[307,4488,326],{"class":313},[307,4490,329],{"class":313},[307,4492,355],{"class":313},[307,4494,416],{"class":358},[307,4496,326],{"class":313},[307,4498,628],{"class":313},[307,4500,4501,4503,4505,4507,4509,4511,4513,4515],{"class":309,"line":557},[307,4502,2214],{"class":313},[307,4504,2027],{"class":383},[307,4506,326],{"class":313},[307,4508,329],{"class":313},[307,4510,355],{"class":313},[307,4512,179],{"class":358},[307,4514,326],{"class":313},[307,4516,628],{"class":313},[307,4518,4519,4521,4523,4525,4527,4529,4531,4533],{"class":309,"line":575},[307,4520,2214],{"class":313},[307,4522,183],{"class":383},[307,4524,326],{"class":313},[307,4526,329],{"class":313},[307,4528,355],{"class":313},[307,4530,951],{"class":358},[307,4532,326],{"class":313},[307,4534,628],{"class":313},[307,4536,4537,4539,4541,4543,4545,4547,4549,4551],{"class":309,"line":721},[307,4538,2214],{"class":313},[307,4540,2303],{"class":383},[307,4542,326],{"class":313},[307,4544,329],{"class":313},[307,4546,355],{"class":313},[307,4548,2312],{"class":358},[307,4550,326],{"class":313},[307,4552,628],{"class":313},[307,4554,4555,4557,4559,4561,4563,4565,4567,4569],{"class":309,"line":726},[307,4556,2214],{"class":313},[307,4558,2323],{"class":383},[307,4560,326],{"class":313},[307,4562,329],{"class":313},[307,4564,355],{"class":313},[307,4566,2332],{"class":358},[307,4568,326],{"class":313},[307,4570,628],{"class":313},[307,4572,4573,4575,4577,4579,4581,4583,4585,4587],{"class":309,"line":733},[307,4574,2214],{"class":313},[307,4576,738],{"class":383},[307,4578,326],{"class":313},[307,4580,329],{"class":313},[307,4582,355],{"class":313},[307,4584,747],{"class":358},[307,4586,326],{"class":313},[307,4588,628],{"class":313},[307,4590,4591,4593,4595,4597,4599],{"class":309,"line":757},[307,4592,2214],{"class":313},[307,4594,828],{"class":383},[307,4596,326],{"class":313},[307,4598,329],{"class":313},[307,4600,835],{"class":313},[307,4602,4603,4605,4608,4610,4612,4614,4616,4618],{"class":309,"line":762},[307,4604,2092],{"class":313},[307,4606,2217],{"class":4607},"swJcz",[307,4609,326],{"class":313},[307,4611,329],{"class":313},[307,4613,355],{"class":313},[307,4615,1510],{"class":358},[307,4617,326],{"class":313},[307,4619,628],{"class":313},[307,4621,4622,4624,4626,4628,4630,4632],{"class":309,"line":783},[307,4623,2092],{"class":313},[307,4625,844],{"class":4607},[307,4627,326],{"class":313},[307,4629,329],{"class":313},[307,4631,384],{"class":383},[307,4633,628],{"class":313},[307,4635,4636,4638,4640,4642,4644,4646,4648,4650],{"class":309,"line":788},[307,4637,2092],{"class":313},[307,4639,863],{"class":4607},[307,4641,326],{"class":313},[307,4643,329],{"class":313},[307,4645,355],{"class":313},[307,4647,872],{"class":358},[307,4649,326],{"class":313},[307,4651,628],{"class":313},[307,4653,4654,4656,4658,4660,4662,4664,4666],{"class":309,"line":812},[307,4655,2092],{"class":313},[307,4657,887],{"class":4607},[307,4659,326],{"class":313},[307,4661,329],{"class":313},[307,4663,355],{"class":313},[307,4665,896],{"class":358},[307,4667,572],{"class":313},[307,4669,4670],{"class":309,"line":817},[307,4671,4672],{"class":313},"        },\n",[307,4674,4675,4677,4679,4681,4683,4685,4687,4689,4691],{"class":309,"line":823},[307,4676,2214],{"class":313},[307,4678,2420],{"class":383},[307,4680,326],{"class":313},[307,4682,329],{"class":313},[307,4684,355],{"class":313},[307,4686,872],{"class":358},[307,4688,326],{"class":313},[307,4690,364],{"class":313},[307,4692,4693],{"class":367}," \u002F\u002F present from the first billing cycle\n",[307,4695,4696,4698,4700,4702,4704,4706,4708,4710],{"class":309,"line":838},[307,4697,2214],{"class":313},[307,4699,2401],{"class":383},[307,4701,326],{"class":313},[307,4703,329],{"class":313},[307,4705,355],{"class":313},[307,4707,3255],{"class":358},[307,4709,326],{"class":313},[307,4711,628],{"class":313},[307,4713,4714,4716,4718,4720,4722,4724,4727,4729,4731],{"class":309,"line":858},[307,4715,2214],{"class":313},[307,4717,169],{"class":383},[307,4719,326],{"class":313},[307,4721,329],{"class":313},[307,4723,355],{"class":313},[307,4725,4726],{"class":358},"crd_9kLmXw3RtYqPz8vNcE2aB",[307,4728,326],{"class":313},[307,4730,364],{"class":313},[307,4732,4733],{"class":367}," \u002F\u002F card charged for this cycle; present on subscription.charged\n",[307,4735,4736,4738,4741,4743,4745,4747,4749,4751,4753],{"class":309,"line":882},[307,4737,2214],{"class":313},[307,4739,4740],{"class":383},"transaction_id",[307,4742,326],{"class":313},[307,4744,329],{"class":313},[307,4746,355],{"class":313},[307,4748,2795],{"class":358},[307,4750,326],{"class":313},[307,4752,364],{"class":313},[307,4754,4755],{"class":367}," \u002F\u002F present on subscription.charged\n",[307,4757,4758,4760,4763,4765,4767,4769,4771,4773,4775],{"class":309,"line":904},[307,4759,2214],{"class":313},[307,4761,4762],{"class":383},"invoice_id",[307,4764,326],{"class":313},[307,4766,329],{"class":313},[307,4768,355],{"class":313},[307,4770,2811],{"class":358},[307,4772,326],{"class":313},[307,4774,364],{"class":313},[307,4776,4777],{"class":367}," \u002F\u002F present when invoice.is_generate was true\n",[307,4779,4780,4782,4785,4787,4789,4792],{"class":309,"line":910},[307,4781,2214],{"class":313},[307,4783,4784],{"class":383},"error",[307,4786,326],{"class":313},[307,4788,329],{"class":313},[307,4790,4791],{"class":313}," null,",[307,4793,4794],{"class":367}," \u002F\u002F decline details; present on subscription.charge_failed\n",[307,4796,4797,4799,4801,4803,4805],{"class":309,"line":915},[307,4798,2214],{"class":313},[307,4800,1315],{"class":383},[307,4802,326],{"class":313},[307,4804,329],{"class":313},[307,4806,835],{"class":313},[307,4808,4809,4811,4813,4815,4817,4819,4821],{"class":309,"line":933},[307,4810,2092],{"class":313},[307,4812,1329],{"class":4607},[307,4814,326],{"class":313},[307,4816,329],{"class":313},[307,4818,355],{"class":313},[307,4820,1338],{"class":358},[307,4822,572],{"class":313},[307,4824,4825],{"class":309,"line":938},[307,4826,4672],{"class":313},[307,4828,4829,4831,4834,4836,4838,4840,4843],{"class":309,"line":961},[307,4830,2214],{"class":313},[307,4832,4833],{"class":383},"completed_at",[307,4835,326],{"class":313},[307,4837,329],{"class":313},[307,4839,355],{"class":313},[307,4841,4842],{"class":358},"2026-08-01T06:00:00Z",[307,4844,572],{"class":313},[307,4846,4847],{"class":309,"line":981},[307,4848,4849],{"class":313},"      }\n",[307,4851,4852],{"class":309,"line":986},[307,4853,393],{"class":313},[307,4855,4856],{"class":309,"line":1009},[307,4857,399],{"class":313},[307,4859,4860,4862,4864,4866,4868,4870,4872],{"class":309,"line":1014},[307,4861,320],{"class":313},[307,4863,2457],{"class":323},[307,4865,326],{"class":313},[307,4867,329],{"class":313},[307,4869,355],{"class":313},[307,4871,4842],{"class":358},[307,4873,572],{"class":313},[307,4875,4876],{"class":309,"line":1020},[307,4877,427],{"class":313},[232,4879,4881],{"id":4880},"webhook-payload-parameters","Webhook Payload Parameters",[246,4883,4884,4901],{},[249,4885,4886],{},[252,4887,4888,4893,4895,4899],{},[255,4889,4890],{"align":257},[1384,4891,1387],{"style":4892},"width:120px",[255,4894,261],{"align":257},[255,4896,4897],{"align":257},[1384,4898,264],{"style":1397},[255,4900,267],{"align":257},[269,4902,4903,4914,4927,4940,4953,4966,4984,5001,5014,5027,5045,5060,5074,5091,5107,5123,5142,5163,5180,5196,5210],{},[252,4904,4905,4907,4909,4912],{},[274,4906,4354],{"align":257},[274,4908,1442],{"align":257},[274,4910,4911],{"align":257},"Type of webhook event that occurred",[274,4913,4361],{"align":257},[252,4915,4916,4918,4920,4923],{},[274,4917,4421],{"align":257},[274,4919,1410],{"align":257},[274,4921,4922],{"align":257},"Array containing subscription data",[274,4924,4925],{"align":257},[307,4926,2632],{},[252,4928,4929,4934,4936,4938],{},[274,4930,4421,4931,4933],{"align":257},[307,4932],{},".subscription.id",[274,4935,279],{"align":257},[274,4937,2521],{"align":257},[274,4939,1980],{"align":257},[252,4941,4942,4947,4949,4951],{},[274,4943,4421,4944,4946],{"align":257},[307,4945],{},".subscription.customer_id",[274,4948,279],{"align":257},[274,4950,2533],{"align":257},[274,4952,289],{"align":257},[252,4954,4955,4960,4962,4964],{},[274,4956,4421,4957,4959],{"align":257},[307,4958],{},".subscription.reference",[274,4961,1747],{"align":257},[274,4963,2545],{"align":257},[274,4965,416],{"align":257},[252,4967,4968,4973,4975,4980],{},[274,4969,4421,4970,4972],{"align":257},[307,4971],{},".subscription.subscription_status",[274,4974,1578],{"align":257},[274,4976,4977,4978],{"align":257},"Subscription state after the event, see ",[163,4979,1590],{"href":1589},[274,4981,4982],{"align":257},[167,4983,179],{},[252,4985,4986,4991,4993,4997],{},[274,4987,4421,4988,4990],{"align":257},[307,4989],{},".subscription.collection_method",[274,4992,1578],{"align":257},[274,4994,2593,4995],{"align":257},[163,4996,1590],{"href":1589},[274,4998,4999],{"align":257},[167,5000,951],{},[252,5002,5003,5008,5010,5012],{},[274,5004,4421,5005,5007],{"align":257},[307,5006],{},".subscription.total_recurring_excl",[274,5009,1442],{"align":257},[274,5011,2698],{"align":257},[274,5013,2312],{"align":257},[252,5015,5016,5021,5023,5025],{},[274,5017,4421,5018,5020],{"align":257},[307,5019],{},".subscription.total_recurring_incl",[274,5022,1442],{"align":257},[274,5024,2710],{"align":257},[274,5026,2332],{"align":257},[252,5028,5029,5034,5036,5041],{},[274,5030,4421,5031,5033],{"align":257},[307,5032],{},".subscription.currency",[274,5035,1722],{"align":257},[274,5037,5038,2749],{"align":257},[163,5039,1731],{"href":1727,"rel":5040,":target":1730},[1729],[274,5042,5043],{"align":257},[167,5044,747],{},[252,5046,5047,5052,5054,5057],{},[274,5048,4421,5049,5051],{"align":257},[307,5050],{},".subscription.billing",[274,5053,1632],{"align":257},[274,5055,5056],{"align":257},"Resolved billing schedule",[274,5058,5059],{"align":257},"See webhook payload",[252,5061,5062,5067,5069,5072],{},[274,5063,4421,5064,5066],{"align":257},[307,5065],{},".subscription.date_last_billing",[274,5068,1442],{"align":257},[274,5070,5071],{"align":257},"Most recent billing date",[274,5073,872],{"align":257},[252,5075,5076,5081,5083,5089],{},[274,5077,4421,5078,5080],{"align":257},[307,5079],{},".subscription.date_next_billing",[274,5082,1442],{"align":257},[274,5084,5085,5086,5088],{"align":257},"Next billing date; ",[167,5087,2612],{}," when no further billing occurs",[274,5090,3255],{"align":257},[252,5092,5093,5098,5100,5105],{},[274,5094,4421,5095,5097],{"align":257},[307,5096],{},".subscription.card_id",[274,5099,279],{"align":257},[274,5101,5102,5103],{"align":257},"Card charged for this cycle; present on ",[167,5104,4361],{},[274,5106,4726],{"align":257},[252,5108,5109,5114,5116,5121],{},[274,5110,4421,5111,5113],{"align":257},[307,5112],{},".subscription.transaction_id",[274,5115,279],{"align":257},[274,5117,5118,5119],{"align":257},"Transaction for this cycle; present on ",[167,5120,4361],{},[274,5122,2795],{"align":257},[252,5124,5125,5130,5132,5140],{},[274,5126,4421,5127,5129],{"align":257},[307,5128],{},".subscription.invoice_id",[274,5131,279],{"align":257},[274,5133,5134,5135,5137,5138],{"align":257},"Invoice for this cycle when ",[167,5136,1785],{}," was ",[167,5139,1663],{},[274,5141,2811],{"align":257},[252,5143,5144,5149,5151,5158],{},[274,5145,4421,5146,5148],{"align":257},[307,5147],{},".subscription.error.code",[274,5150,1578],{"align":257},[274,5152,5153,5154,2577,5156],{"align":257},"Decline code; present on ",[167,5155,4311],{},[163,5157,1590],{"href":1589},[274,5159,5160],{"align":257},[167,5161,5162],{},"INSUFFICIENT_FUNDS",[252,5164,5165,5170,5172,5177],{},[274,5166,4421,5167,5169],{"align":257},[307,5168],{},".subscription.error.message",[274,5171,1442],{"align":257},[274,5173,5174,5175],{"align":257},"Human-readable decline reason; present on ",[167,5176,4311],{},[274,5178,5179],{"align":257},"The transaction was declined due to insufficient funds",[252,5181,5182,5187,5189,5192],{},[274,5183,4421,5184,5186],{"align":257},[307,5185],{},".subscription.metadata",[274,5188,1632],{"align":257},[274,5190,5191],{"align":257},"Custom key\u002Fvalue metadata supplied on create",[274,5193,5194],{"align":257},[167,5195,1886],{},[252,5197,5198,5203,5205,5208],{},[274,5199,4421,5200,5202],{"align":257},[307,5201],{},".subscription.completed_at",[274,5204,1442],{"align":257},[274,5206,5207],{"align":257},"ISO timestamp when the subscription reached the status for this event",[274,5209,4842],{"align":257},[252,5211,5212,5214,5216,5219],{},[274,5213,2457],{"align":257},[274,5215,1442],{"align":257},[274,5217,5218],{"align":257},"ISO timestamp when webhook was created",[274,5220,4842],{"align":257},[232,5222,5224],{"id":5223},"webhook-events","Webhook Events",[246,5226,5227,5242],{},[249,5228,5229],{},[252,5230,5231,5234,5236,5239],{},[255,5232,5233],{"align":257},"Event",[255,5235,264],{"align":257},[255,5237,5238],{"align":257},"Trigger Condition",[255,5240,5241],{"align":257},"Data Included",[269,5243,5244,5259,5275,5290,5305,5321,5337,5352,5368,5385],{},[252,5245,5246,5250,5253,5256],{},[274,5247,5248],{"align":257},[167,5249,4358],{},[274,5251,5252],{"align":257},"The subscription was created",[274,5254,5255],{"align":257},"When the create request succeeds",[274,5257,5258],{"align":257},"Subscription details, billing schedule, totals",[252,5260,5261,5266,5269,5272],{},[274,5262,5263],{"align":257},[167,5264,5265],{},"subscription.activated",[274,5267,5268],{"align":257},"The subscription became active",[274,5270,5271],{"align":257},"When the trial ends or the first charge succeeds",[274,5273,5274],{"align":257},"Subscription details, next billing date",[252,5276,5277,5281,5284,5287],{},[274,5278,5279],{"align":257},[167,5280,4361],{},[274,5282,5283],{"align":257},"A billing cycle was collected successfully",[274,5285,5286],{"align":257},"When the cycle charge succeeds on any card in the cascade",[274,5288,5289],{"align":257},"Subscription details, charged card, transaction, invoice when generated",[252,5291,5292,5296,5299,5302],{},[274,5293,5294],{"align":257},[167,5295,4311],{},[274,5297,5298],{"align":257},"A billing cycle charge attempt failed",[274,5300,5301],{"align":257},"When a cycle charge declines on all attempted cards; fires once per retry",[274,5303,5304],{"align":257},"Subscription details, decline code and message",[252,5306,5307,5312,5315,5318],{},[274,5308,5309],{"align":257},[167,5310,5311],{},"subscription.plan_changed",[274,5313,5314],{"align":257},"The recurring line items changed",[274,5316,5317],{"align":257},"When a scheduled or immediate plan change takes effect",[274,5319,5320],{"align":257},"Subscription details, new items and totals",[252,5322,5323,5328,5331,5334],{},[274,5324,5325],{"align":257},[167,5326,5327],{},"subscription.paused",[274,5329,5330],{"align":257},"The subscription was paused",[274,5332,5333],{"align":257},"When a pause request completes",[274,5335,5336],{"align":257},"Subscription details",[252,5338,5339,5344,5347,5350],{},[274,5340,5341],{"align":257},[167,5342,5343],{},"subscription.resumed",[274,5345,5346],{"align":257},"The subscription was resumed",[274,5348,5349],{"align":257},"When a resume request completes",[274,5351,5274],{"align":257},[252,5353,5354,5359,5362,5365],{},[274,5355,5356],{"align":257},[167,5357,5358],{},"subscription.cancelled",[274,5360,5361],{"align":257},"The subscription was cancelled",[274,5363,5364],{"align":257},"When an immediate cancellation completes, or a scheduled cancellation takes effect",[274,5366,5367],{"align":257},"Subscription details, cancellation reason",[252,5369,5370,5375,5378,5383],{},[274,5371,5372],{"align":257},[167,5373,5374],{},"subscription.expired",[274,5376,5377],{"align":257},"The subscription reached its end date",[274,5379,1656,5380,5382],{"align":257},[167,5381,1539],{}," passes",[274,5384,5336],{"align":257},[252,5386,5387,5392,5395,5398],{},[274,5388,5389],{"align":257},[167,5390,5391],{},"subscription.failed",[274,5393,5394],{"align":257},"Billing stopped after exhausted retries",[274,5396,5397],{"align":257},"When all retries of a failed cycle are exhausted",[274,5399,5400],{"align":257},"Subscription details, last decline code and message",[232,5402,5404],{"id":5403},"webhook-security","Webhook Security",[159,5406,5407],{},"All webhooks are sent with the following headers for verification:",[5409,5410,5411,5418,5424],"ul",{},[5412,5413,5414,5417],"li",{},[167,5415,5416],{},"X-Signature",": HMAC-SHA256 signature of the payload",[5412,5419,5420,5423],{},[167,5421,5422],{},"X-Timestamp",": Unix timestamp of when the webhook was sent",[5412,5425,5426,5429,5430],{},[167,5427,5428],{},"User-Agent",": ",[167,5431,5432],{},"Kwik-Webhooks\u002F1.0",[232,5434,5436],{"id":5435},"webhook-response","Webhook Response",[159,5438,5439,5440,5443],{},"Your endpoint should respond with a ",[167,5441,5442],{},"200"," status code to acknowledge receipt. Failed webhooks will be retried up to 3 times with exponential backoff.",[5445,5446,5447],"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 .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html .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 .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}",{"title":303,"searchDepth":310,"depth":317,"links":5449},[5450,5459,5466,5471,5476,5483,5484,5485],{"id":156,"depth":317,"text":157,"children":5451},[5452,5453,5454,5455,5456,5457,5458],{"id":234,"depth":335,"text":235},{"id":292,"depth":335,"text":293},{"id":430,"depth":335,"text":431},{"id":580,"depth":335,"text":581},{"id":1357,"depth":335,"text":1358},{"id":1889,"depth":335,"text":1890},{"id":2479,"depth":335,"text":2480},{"id":2826,"depth":317,"text":2827,"children":5460},[5461,5462,5463,5464,5465],{"id":2858,"depth":335,"text":235},{"id":2896,"depth":335,"text":267},{"id":3008,"depth":335,"text":1358},{"id":3080,"depth":335,"text":1890},{"id":3268,"depth":335,"text":2480},{"id":3379,"depth":317,"text":3380,"children":5467},[5468,5469,5470],{"id":3396,"depth":335,"text":235},{"id":3433,"depth":335,"text":267},{"id":3474,"depth":335,"text":1890},{"id":3602,"depth":317,"text":3603,"children":5472},[5473,5474,5475],{"id":3616,"depth":335,"text":235},{"id":3653,"depth":335,"text":267},{"id":3706,"depth":335,"text":1890},{"id":3840,"depth":317,"text":3841,"children":5477},[5478,5479,5480,5481,5482],{"id":3850,"depth":335,"text":235},{"id":3887,"depth":335,"text":267},{"id":3967,"depth":335,"text":1358},{"id":4032,"depth":335,"text":1890},{"id":4181,"depth":335,"text":2480},{"id":4301,"depth":317,"text":4302},{"id":4326,"depth":317,"text":4327},{"id":4341,"depth":317,"text":4342,"children":5486},[5487,5488,5489,5490,5491],{"id":4371,"depth":335,"text":4372},{"id":4880,"depth":335,"text":4881},{"id":5223,"depth":335,"text":5224},{"id":5403,"depth":335,"text":5404},{"id":5435,"depth":335,"text":5436},"Create and manage recurring card subscriptions on a customer's vaulted cards. Line items come from your product catalog — each product's pricing type and billing interval determine what is billed each cycle and on the first cycle only. Supports trial periods, automatic charging with card cascade, plan changes, pausing, and cancellation — with invoice issuance and webhook notifications.","md",null,{},{"title":83,"description":5492},"LuEA8fhdakczGJi4EsRKkf5tP39czgIPp-2mC8ObtMs",[5499,5501],{"title":79,"path":80,"stem":81,"description":5500,"children":-1},"Hosted web pages that new customers can use to signup with or existing customers can use to add collections to their account.",{"title":87,"path":88,"stem":89,"description":5502,"children":-1},"Create a secure, customizable checkout link session to capture payments with cards, bank transfers, and other payment methods. Supports 3D Secure authentication, cards storage for recurring billing, invoice issuance, customer creation, and webhook notifications.",1783349991078]