[{"data":1,"prerenderedAt":1365},["ShallowReactive",2],{"navigation_docs":3,"-recipients-checkout-recipients":104,"-recipients-checkout-recipients-surround":1360},[4,26,32,45,74,87],{"title":5,"path":6,"stem":7,"children":8,"page":25},"Getting Started","\u002Fgetting-started","1.getting-started",[9,13,17,21],{"title":10,"path":11,"stem":12},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F1.introduction",{"title":14,"path":15,"stem":16},"Authentication","\u002Fgetting-started\u002Fauthentication","1.getting-started\u002F2.authentication",{"title":18,"path":19,"stem":20},"Campaign setup","\u002Fgetting-started\u002Fcampaigns","1.getting-started\u002F3.campaigns",{"title":22,"path":23,"stem":24},"AI agent skills","\u002Fgetting-started\u002Fai-agent-skills","1.getting-started\u002F4.ai-agent-skills",false,{"title":27,"path":28,"stem":29,"children":30},"Templates","\u002Ftemplates","2.templates\u002Findex",[31],{"title":27,"path":28,"stem":29},{"title":33,"path":34,"stem":35,"children":36,"page":25},"Campaigns","\u002Fcampaigns","3.campaigns",[37,41],{"title":38,"path":39,"stem":40},"Create campaign","\u002Fcampaigns\u002Fcreate-campaign","3.campaigns\u002F1.create-campaign",{"title":42,"path":43,"stem":44},"Fetch campaign","\u002Fcampaigns\u002Ffetch-campaign","3.campaigns\u002F2.fetch-campaign",{"title":46,"path":47,"stem":48,"children":49,"page":25},"Recipients","\u002Frecipients","4.recipients",[50,54,58,62,66,70],{"title":51,"path":52,"stem":53},"Create recipients","\u002Frecipients\u002Fcreate-recipients","4.recipients\u002F1.create-recipients",{"title":55,"path":56,"stem":57},"Fetch recipient","\u002Frecipients\u002Ffetch-recipient","4.recipients\u002F2.fetch-recipient",{"title":59,"path":60,"stem":61},"Fetch recipient preview","\u002Frecipients\u002Ffetch-recipient-preview","4.recipients\u002F3.fetch-recipient-preview",{"title":63,"path":64,"stem":65},"Create HTML recipient","\u002Frecipients\u002Fcreate-html-recipient","4.recipients\u002F4.create-html-recipient",{"title":67,"path":68,"stem":69},"Checkout recipients","\u002Frecipients\u002Fcheckout-recipients","4.recipients\u002F5.checkout-recipients",{"title":71,"path":72,"stem":73},"PNG API","\u002Frecipients\u002Fpng-api","4.recipients\u002F6.png-api",{"title":75,"path":76,"stem":77,"children":78,"page":25},"Partner Workflows","\u002Fpartner-workflows","5.partner-workflows",[79,83],{"title":80,"path":81,"stem":82},"Create partner team","\u002Fpartner-workflows\u002Fcreate-partner-team","5.partner-workflows\u002F1.create-partner-team",{"title":84,"path":85,"stem":86},"Account status","\u002Fpartner-workflows\u002Faccount-status","5.partner-workflows\u002F2.account-status",{"title":88,"path":89,"stem":90,"children":91,"page":25},"Webhooks","\u002Fwebhooks","6.webhooks",[92,96,100],{"title":93,"path":94,"stem":95},"Overview","\u002Fwebhooks\u002Foverview","6.webhooks\u002F0.overview",{"title":97,"path":98,"stem":99},"Manage subscriptions","\u002Fwebhooks\u002Fmanage-subscriptions","6.webhooks\u002F1.manage-subscriptions",{"title":101,"path":102,"stem":103},"QR scan events","\u002Fwebhooks\u002Fqr-code-scans","6.webhooks\u002F2.qr-code-scans",{"id":105,"title":67,"body":106,"description":1353,"extension":1354,"links":1355,"meta":1356,"navigation":1357,"path":68,"seo":1358,"stem":69,"__hash__":1359},"docs\u002F4.recipients\u002F5.checkout-recipients.md",{"type":107,"value":108,"toc":1342},"minimark",[109,113,116,133,138,200,204,220,224,230,318,321,421,424,492,496,503,573,576,642,647,656,667,676,680,683,692,725,728,1079,1083,1088,1152,1155,1216,1222,1226,1229,1232,1236,1271,1275,1338],[110,111,112],"p",{},"Use checkout when recipients have been created for one-time billing and need to be paid before fulfilment can start. This includes normal one-time campaigns and custom HTML recipients on accounts without a recurring subscription.",[110,114,115],{},"You do not need checkout for recurring campaigns on subscription-backed accounts. Those recipients are billed through the subscription.",[117,118,123],"pre",{"className":119,"code":120,"language":121,"meta":122,"style":122},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","POST https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients\u002Fcheckout\n","http","",[124,125,126],"code",{"__ignoreMap":122},[127,128,131],"span",{"class":129,"line":130},"line",1,[127,132,120],{},[134,135,137],"h2",{"id":136},"when-to-use-checkout","When to use checkout",[139,140,141,154],"table",{},[142,143,144],"thead",{},[145,146,147,151],"tr",{},[148,149,150],"th",{},"Flow",[148,152,153],{},"What to send",[155,156,157,170,181,189],"tbody",{},[145,158,159,163],{},[160,161,162],"td",{},"One-time campaign recipients",[160,164,165,166,169],{},"Add recipients to the campaign, then checkout with ",[124,167,168],{},"campaignId",".",[145,171,172,175],{},[160,173,174],{},"HTML recipients without a subscription",[160,176,177,178,169],{},"Create HTML recipients, fetch the active cart, then checkout with ",[124,179,180],{},"cartId",[145,182,183,186],{},[160,184,185],{},"Recurring campaign with subscription",[160,187,188],{},"Do not call checkout. Billing is handled through the subscription.",[145,190,191,194],{},[160,192,193],{},"HTML recipients with subscription",[160,195,196,197,169],{},"Do not call checkout. Recipients move straight to ",[124,198,199],{},"ready",[134,201,203],{"id":202},"headers","Headers",[117,205,207],{"className":119,"code":206,"language":121,"meta":122,"style":122},"Content-Type: application\u002Fjson\nX-API-Key: YOUR_API_KEY\n",[124,208,209,214],{"__ignoreMap":122},[127,210,211],{"class":129,"line":130},[127,212,213],{},"Content-Type: application\u002Fjson\n",[127,215,217],{"class":129,"line":216},2,[127,218,219],{},"X-API-Key: YOUR_API_KEY\n",[134,221,223],{"id":222},"checkout-a-campaign","Checkout a campaign",[110,225,226,227,229],{},"Use ",[124,228,168],{}," when you want to checkout one one-time campaign.",[117,231,235],{"className":232,"code":233,"language":234,"meta":122,"style":122},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl --request POST 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients\u002Fcheckout' \\\n  --header 'Content-Type: application\u002Fjson' \\\n  --header 'X-API-Key: YOUR_API_KEY' \\\n  --data '{\n    \"campaignId\": \"CAMPAIGN_ID\"\n  }'\n","bash",[124,236,237,264,278,292,303,309],{"__ignoreMap":122},[127,238,239,243,247,250,254,257,260],{"class":129,"line":130},[127,240,242],{"class":241},"sBMFI","curl",[127,244,246],{"class":245},"sfazB"," --request",[127,248,249],{"class":245}," POST",[127,251,253],{"class":252},"sMK4o"," '",[127,255,256],{"class":245},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients\u002Fcheckout",[127,258,259],{"class":252},"'",[127,261,263],{"class":262},"sTEyZ"," \\\n",[127,265,266,269,271,274,276],{"class":129,"line":216},[127,267,268],{"class":245},"  --header",[127,270,253],{"class":252},[127,272,273],{"class":245},"Content-Type: application\u002Fjson",[127,275,259],{"class":252},[127,277,263],{"class":262},[127,279,281,283,285,288,290],{"class":129,"line":280},3,[127,282,268],{"class":245},[127,284,253],{"class":252},[127,286,287],{"class":245},"X-API-Key: YOUR_API_KEY",[127,289,259],{"class":252},[127,291,263],{"class":262},[127,293,295,298,300],{"class":129,"line":294},4,[127,296,297],{"class":245},"  --data",[127,299,253],{"class":252},[127,301,302],{"class":245},"{\n",[127,304,306],{"class":129,"line":305},5,[127,307,308],{"class":245},"    \"campaignId\": \"CAMPAIGN_ID\"\n",[127,310,312,315],{"class":129,"line":311},6,[127,313,314],{"class":245},"  }",[127,316,317],{"class":252},"'\n",[110,319,320],{},"If payment setup or payment recovery is required, Scribeless returns a checkout URL:",[117,322,326],{"className":323,"code":324,"language":325,"meta":122,"style":122},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"status\": \"checkout_required\",\n  \"campaignId\": \"CAMPAIGN_ID\",\n  \"next\": \"\u002Fcheckout?sessionId=CHECKOUT_SESSION_SECRET\",\n  \"checkoutUrl\": \"https:\u002F\u002Fplatform.scribeless.co\u002Fcheckout?sessionId=CHECKOUT_SESSION_SECRET\"\n}\n","json",[124,327,328,332,358,377,397,416],{"__ignoreMap":122},[127,329,330],{"class":129,"line":130},[127,331,302],{"class":252},[127,333,334,337,341,344,347,350,353,355],{"class":129,"line":216},[127,335,336],{"class":252},"  \"",[127,338,340],{"class":339},"spNyl","status",[127,342,343],{"class":252},"\"",[127,345,346],{"class":252},":",[127,348,349],{"class":252}," \"",[127,351,352],{"class":245},"checkout_required",[127,354,343],{"class":252},[127,356,357],{"class":252},",\n",[127,359,360,362,364,366,368,370,373,375],{"class":129,"line":280},[127,361,336],{"class":252},[127,363,168],{"class":339},[127,365,343],{"class":252},[127,367,346],{"class":252},[127,369,349],{"class":252},[127,371,372],{"class":245},"CAMPAIGN_ID",[127,374,343],{"class":252},[127,376,357],{"class":252},[127,378,379,381,384,386,388,390,393,395],{"class":129,"line":294},[127,380,336],{"class":252},[127,382,383],{"class":339},"next",[127,385,343],{"class":252},[127,387,346],{"class":252},[127,389,349],{"class":252},[127,391,392],{"class":245},"\u002Fcheckout?sessionId=CHECKOUT_SESSION_SECRET",[127,394,343],{"class":252},[127,396,357],{"class":252},[127,398,399,401,404,406,408,410,413],{"class":129,"line":305},[127,400,336],{"class":252},[127,402,403],{"class":339},"checkoutUrl",[127,405,343],{"class":252},[127,407,346],{"class":252},[127,409,349],{"class":252},[127,411,412],{"class":245},"https:\u002F\u002Fplatform.scribeless.co\u002Fcheckout?sessionId=CHECKOUT_SESSION_SECRET",[127,414,415],{"class":252},"\"\n",[127,417,418],{"class":129,"line":311},[127,419,420],{"class":252},"}\n",[110,422,423],{},"If automatic invoice payment succeeds, Scribeless returns:",[117,425,427],{"className":323,"code":426,"language":325,"meta":122,"style":122},"{\n  \"status\": \"payment_succeeded\",\n  \"campaignId\": \"CAMPAIGN_ID\",\n  \"invoiceUrl\": \"https:\u002F\u002Finvoice.stripe.com\u002Fi\u002F...\"\n}\n",[124,428,429,433,452,470,488],{"__ignoreMap":122},[127,430,431],{"class":129,"line":130},[127,432,302],{"class":252},[127,434,435,437,439,441,443,445,448,450],{"class":129,"line":216},[127,436,336],{"class":252},[127,438,340],{"class":339},[127,440,343],{"class":252},[127,442,346],{"class":252},[127,444,349],{"class":252},[127,446,447],{"class":245},"payment_succeeded",[127,449,343],{"class":252},[127,451,357],{"class":252},[127,453,454,456,458,460,462,464,466,468],{"class":129,"line":280},[127,455,336],{"class":252},[127,457,168],{"class":339},[127,459,343],{"class":252},[127,461,346],{"class":252},[127,463,349],{"class":252},[127,465,372],{"class":245},[127,467,343],{"class":252},[127,469,357],{"class":252},[127,471,472,474,477,479,481,483,486],{"class":129,"line":294},[127,473,336],{"class":252},[127,475,476],{"class":339},"invoiceUrl",[127,478,343],{"class":252},[127,480,346],{"class":252},[127,482,349],{"class":252},[127,484,485],{"class":245},"https:\u002F\u002Finvoice.stripe.com\u002Fi\u002F...",[127,487,415],{"class":252},[127,489,490],{"class":129,"line":305},[127,491,420],{"class":252},[134,493,495],{"id":494},"redirect-after-checkout","Redirect after checkout",[110,497,498,499,502],{},"Send ",[124,500,501],{},"redirectUrl"," when your integration needs Scribeless to send the customer back to your app after hosted checkout. The redirect URL must use HTTPS.",[117,504,506],{"className":232,"code":505,"language":234,"meta":122,"style":122},"curl --request POST 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients\u002Fcheckout' \\\n  --header 'Content-Type: application\u002Fjson' \\\n  --header 'X-API-Key: YOUR_API_KEY' \\\n  --data '{\n    \"campaignId\": \"CAMPAIGN_ID\",\n    \"redirectUrl\": \"https:\u002F\u002Fpartner.example.com\u002Fscribeless\u002Fcallback\"\n  }'\n",[124,507,508,524,536,548,556,561,566],{"__ignoreMap":122},[127,509,510,512,514,516,518,520,522],{"class":129,"line":130},[127,511,242],{"class":241},[127,513,246],{"class":245},[127,515,249],{"class":245},[127,517,253],{"class":252},[127,519,256],{"class":245},[127,521,259],{"class":252},[127,523,263],{"class":262},[127,525,526,528,530,532,534],{"class":129,"line":216},[127,527,268],{"class":245},[127,529,253],{"class":252},[127,531,273],{"class":245},[127,533,259],{"class":252},[127,535,263],{"class":262},[127,537,538,540,542,544,546],{"class":129,"line":280},[127,539,268],{"class":245},[127,541,253],{"class":252},[127,543,287],{"class":245},[127,545,259],{"class":252},[127,547,263],{"class":262},[127,549,550,552,554],{"class":129,"line":294},[127,551,297],{"class":245},[127,553,253],{"class":252},[127,555,302],{"class":245},[127,557,558],{"class":129,"line":305},[127,559,560],{"class":245},"    \"campaignId\": \"CAMPAIGN_ID\",\n",[127,562,563],{"class":129,"line":311},[127,564,565],{"class":245},"    \"redirectUrl\": \"https:\u002F\u002Fpartner.example.com\u002Fscribeless\u002Fcallback\"\n",[127,567,569,571],{"class":129,"line":568},7,[127,570,314],{"class":245},[127,572,317],{"class":252},[110,574,575],{},"When checkout is required, this returns a hosted checkout URL:",[117,577,579],{"className":323,"code":578,"language":325,"meta":122,"style":122},"{\n  \"status\": \"checkout_required\",\n  \"campaignId\": \"CAMPAIGN_ID\",\n  \"checkoutUrl\": \"https:\u002F\u002Fplatform.scribeless.co\u002Fpartner-checkout?sessionId=CHECKOUT_SESSION_SECRET\"\n}\n",[124,580,581,585,603,621,638],{"__ignoreMap":122},[127,582,583],{"class":129,"line":130},[127,584,302],{"class":252},[127,586,587,589,591,593,595,597,599,601],{"class":129,"line":216},[127,588,336],{"class":252},[127,590,340],{"class":339},[127,592,343],{"class":252},[127,594,346],{"class":252},[127,596,349],{"class":252},[127,598,352],{"class":245},[127,600,343],{"class":252},[127,602,357],{"class":252},[127,604,605,607,609,611,613,615,617,619],{"class":129,"line":280},[127,606,336],{"class":252},[127,608,168],{"class":339},[127,610,343],{"class":252},[127,612,346],{"class":252},[127,614,349],{"class":252},[127,616,372],{"class":245},[127,618,343],{"class":252},[127,620,357],{"class":252},[127,622,623,625,627,629,631,633,636],{"class":129,"line":294},[127,624,336],{"class":252},[127,626,403],{"class":339},[127,628,343],{"class":252},[127,630,346],{"class":252},[127,632,349],{"class":252},[127,634,635],{"class":245},"https:\u002F\u002Fplatform.scribeless.co\u002Fpartner-checkout?sessionId=CHECKOUT_SESSION_SECRET",[127,637,415],{"class":252},[127,639,640],{"class":129,"line":305},[127,641,420],{"class":252},[110,643,644,645,346],{},"After checkout completes, Scribeless redirects to ",[124,646,501],{},[117,648,650],{"className":119,"code":649,"language":121,"meta":122,"style":122},"https:\u002F\u002Fpartner.example.com\u002Fscribeless\u002Fcallback?status=payment_succeeded&campaignId=CAMPAIGN_ID\n",[124,651,652],{"__ignoreMap":122},[127,653,654],{"class":129,"line":130},[127,655,649],{},[110,657,658,659,662,663,666],{},"Failed or incomplete payment redirects use ",[124,660,661],{},"status=payment_failed"," and may include a ",[124,664,665],{},"reason"," query parameter:",[117,668,670],{"className":119,"code":669,"language":121,"meta":122,"style":122},"https:\u002F\u002Fpartner.example.com\u002Fscribeless\u002Fcallback?status=payment_failed&campaignId=CAMPAIGN_ID&reason=checkout_not_fulfilled\n",[124,671,672],{"__ignoreMap":122},[127,673,674],{"class":129,"line":130},[127,675,669],{},[134,677,679],{"id":678},"fetch-active-cart","Fetch active cart",[110,681,682],{},"Use the active cart for HTML recipients created on an account without a subscription. Scribeless automatically adds the hidden one-time HTML campaign to the active cart.",[117,684,686],{"className":119,"code":685,"language":121,"meta":122,"style":122},"GET https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fcarts\u002Factive\n",[124,687,688],{"__ignoreMap":122},[127,689,690],{"class":129,"line":130},[127,691,685],{},[117,693,695],{"className":232,"code":694,"language":234,"meta":122,"style":122},"curl --request GET 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fcarts\u002Factive' \\\n  --header 'X-API-Key: YOUR_API_KEY'\n",[124,696,697,715],{"__ignoreMap":122},[127,698,699,701,703,706,708,711,713],{"class":129,"line":130},[127,700,242],{"class":241},[127,702,246],{"class":245},[127,704,705],{"class":245}," GET",[127,707,253],{"class":252},[127,709,710],{"class":245},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Fcarts\u002Factive",[127,712,259],{"class":252},[127,714,263],{"class":262},[127,716,717,719,721,723],{"class":129,"line":216},[127,718,268],{"class":245},[127,720,253],{"class":252},[127,722,287],{"class":245},[127,724,317],{"class":252},[110,726,727],{},"Successful requests return the open cart. If the account does not already have one, Scribeless creates it.",[117,729,731],{"className":323,"code":730,"language":325,"meta":122,"style":122},"{\n  \"id\": \"CART_ID\",\n  \"status\": \"open\",\n  \"created_at\": \"2026-06-11T10:00:00.000000+00:00\",\n  \"updated_at\": \"2026-06-11T10:00:00.000000+00:00\",\n  \"completed_at\": null,\n  \"campaigns\": [\n    {\n      \"id\": \"CART_CAMPAIGN_ID\",\n      \"campaign\": {\n        \"id\": \"CAMPAIGN_ID\",\n        \"name\": \"[hidden:html] campaign:a6_postcard:landscape:duplex:envelope-false\",\n        \"render_mode\": \"html\",\n        \"product\": {\n          \"name\": \"A6 postcard\"\n        },\n        \"metrics\": [\n          {\n            \"status\": \"pending\",\n            \"count\": 3\n          }\n        ]\n      }\n    }\n  ]\n}\n",[124,732,733,737,757,776,796,815,829,843,849,870,885,906,927,948,962,982,988,1002,1008,1029,1044,1050,1056,1062,1068,1074],{"__ignoreMap":122},[127,734,735],{"class":129,"line":130},[127,736,302],{"class":252},[127,738,739,741,744,746,748,750,753,755],{"class":129,"line":216},[127,740,336],{"class":252},[127,742,743],{"class":339},"id",[127,745,343],{"class":252},[127,747,346],{"class":252},[127,749,349],{"class":252},[127,751,752],{"class":245},"CART_ID",[127,754,343],{"class":252},[127,756,357],{"class":252},[127,758,759,761,763,765,767,769,772,774],{"class":129,"line":280},[127,760,336],{"class":252},[127,762,340],{"class":339},[127,764,343],{"class":252},[127,766,346],{"class":252},[127,768,349],{"class":252},[127,770,771],{"class":245},"open",[127,773,343],{"class":252},[127,775,357],{"class":252},[127,777,778,780,783,785,787,789,792,794],{"class":129,"line":294},[127,779,336],{"class":252},[127,781,782],{"class":339},"created_at",[127,784,343],{"class":252},[127,786,346],{"class":252},[127,788,349],{"class":252},[127,790,791],{"class":245},"2026-06-11T10:00:00.000000+00:00",[127,793,343],{"class":252},[127,795,357],{"class":252},[127,797,798,800,803,805,807,809,811,813],{"class":129,"line":305},[127,799,336],{"class":252},[127,801,802],{"class":339},"updated_at",[127,804,343],{"class":252},[127,806,346],{"class":252},[127,808,349],{"class":252},[127,810,791],{"class":245},[127,812,343],{"class":252},[127,814,357],{"class":252},[127,816,817,819,822,824,826],{"class":129,"line":311},[127,818,336],{"class":252},[127,820,821],{"class":339},"completed_at",[127,823,343],{"class":252},[127,825,346],{"class":252},[127,827,828],{"class":252}," null,\n",[127,830,831,833,836,838,840],{"class":129,"line":568},[127,832,336],{"class":252},[127,834,835],{"class":339},"campaigns",[127,837,343],{"class":252},[127,839,346],{"class":252},[127,841,842],{"class":252}," [\n",[127,844,846],{"class":129,"line":845},8,[127,847,848],{"class":252},"    {\n",[127,850,852,855,857,859,861,863,866,868],{"class":129,"line":851},9,[127,853,854],{"class":252},"      \"",[127,856,743],{"class":241},[127,858,343],{"class":252},[127,860,346],{"class":252},[127,862,349],{"class":252},[127,864,865],{"class":245},"CART_CAMPAIGN_ID",[127,867,343],{"class":252},[127,869,357],{"class":252},[127,871,873,875,878,880,882],{"class":129,"line":872},10,[127,874,854],{"class":252},[127,876,877],{"class":241},"campaign",[127,879,343],{"class":252},[127,881,346],{"class":252},[127,883,884],{"class":252}," {\n",[127,886,888,891,894,896,898,900,902,904],{"class":129,"line":887},11,[127,889,890],{"class":252},"        \"",[127,892,743],{"class":893},"sbssI",[127,895,343],{"class":252},[127,897,346],{"class":252},[127,899,349],{"class":252},[127,901,372],{"class":245},[127,903,343],{"class":252},[127,905,357],{"class":252},[127,907,909,911,914,916,918,920,923,925],{"class":129,"line":908},12,[127,910,890],{"class":252},[127,912,913],{"class":893},"name",[127,915,343],{"class":252},[127,917,346],{"class":252},[127,919,349],{"class":252},[127,921,922],{"class":245},"[hidden:html] campaign:a6_postcard:landscape:duplex:envelope-false",[127,924,343],{"class":252},[127,926,357],{"class":252},[127,928,930,932,935,937,939,941,944,946],{"class":129,"line":929},13,[127,931,890],{"class":252},[127,933,934],{"class":893},"render_mode",[127,936,343],{"class":252},[127,938,346],{"class":252},[127,940,349],{"class":252},[127,942,943],{"class":245},"html",[127,945,343],{"class":252},[127,947,357],{"class":252},[127,949,951,953,956,958,960],{"class":129,"line":950},14,[127,952,890],{"class":252},[127,954,955],{"class":893},"product",[127,957,343],{"class":252},[127,959,346],{"class":252},[127,961,884],{"class":252},[127,963,965,968,971,973,975,977,980],{"class":129,"line":964},15,[127,966,967],{"class":252},"          \"",[127,969,913],{"class":970},"swJcz",[127,972,343],{"class":252},[127,974,346],{"class":252},[127,976,349],{"class":252},[127,978,979],{"class":245},"A6 postcard",[127,981,415],{"class":252},[127,983,985],{"class":129,"line":984},16,[127,986,987],{"class":252},"        },\n",[127,989,991,993,996,998,1000],{"class":129,"line":990},17,[127,992,890],{"class":252},[127,994,995],{"class":893},"metrics",[127,997,343],{"class":252},[127,999,346],{"class":252},[127,1001,842],{"class":252},[127,1003,1005],{"class":129,"line":1004},18,[127,1006,1007],{"class":252},"          {\n",[127,1009,1011,1014,1016,1018,1020,1022,1025,1027],{"class":129,"line":1010},19,[127,1012,1013],{"class":252},"            \"",[127,1015,340],{"class":970},[127,1017,343],{"class":252},[127,1019,346],{"class":252},[127,1021,349],{"class":252},[127,1023,1024],{"class":245},"pending",[127,1026,343],{"class":252},[127,1028,357],{"class":252},[127,1030,1032,1034,1037,1039,1041],{"class":129,"line":1031},20,[127,1033,1013],{"class":252},[127,1035,1036],{"class":970},"count",[127,1038,343],{"class":252},[127,1040,346],{"class":252},[127,1042,1043],{"class":893}," 3\n",[127,1045,1047],{"class":129,"line":1046},21,[127,1048,1049],{"class":252},"          }\n",[127,1051,1053],{"class":129,"line":1052},22,[127,1054,1055],{"class":252},"        ]\n",[127,1057,1059],{"class":129,"line":1058},23,[127,1060,1061],{"class":252},"      }\n",[127,1063,1065],{"class":129,"line":1064},24,[127,1066,1067],{"class":252},"    }\n",[127,1069,1071],{"class":129,"line":1070},25,[127,1072,1073],{"class":252},"  ]\n",[127,1075,1077],{"class":129,"line":1076},26,[127,1078,420],{"class":252},[134,1080,1082],{"id":1081},"checkout-active-cart","Checkout active cart",[110,1084,226,1085,1087],{},[124,1086,180],{}," when you want to checkout everything currently in the active cart.",[117,1089,1091],{"className":232,"code":1090,"language":234,"meta":122,"style":122},"curl --request POST 'https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients\u002Fcheckout' \\\n  --header 'Content-Type: application\u002Fjson' \\\n  --header 'X-API-Key: YOUR_API_KEY' \\\n  --data '{\n    \"cartId\": \"CART_ID\"\n  }'\n",[124,1092,1093,1109,1121,1133,1141,1146],{"__ignoreMap":122},[127,1094,1095,1097,1099,1101,1103,1105,1107],{"class":129,"line":130},[127,1096,242],{"class":241},[127,1098,246],{"class":245},[127,1100,249],{"class":245},[127,1102,253],{"class":252},[127,1104,256],{"class":245},[127,1106,259],{"class":252},[127,1108,263],{"class":262},[127,1110,1111,1113,1115,1117,1119],{"class":129,"line":216},[127,1112,268],{"class":245},[127,1114,253],{"class":252},[127,1116,273],{"class":245},[127,1118,259],{"class":252},[127,1120,263],{"class":262},[127,1122,1123,1125,1127,1129,1131],{"class":129,"line":280},[127,1124,268],{"class":245},[127,1126,253],{"class":252},[127,1128,287],{"class":245},[127,1130,259],{"class":252},[127,1132,263],{"class":262},[127,1134,1135,1137,1139],{"class":129,"line":294},[127,1136,297],{"class":245},[127,1138,253],{"class":252},[127,1140,302],{"class":245},[127,1142,1143],{"class":129,"line":305},[127,1144,1145],{"class":245},"    \"cartId\": \"CART_ID\"\n",[127,1147,1148,1150],{"class":129,"line":311},[127,1149,314],{"class":245},[127,1151,317],{"class":252},[110,1153,1154],{},"Successful cart checkout returns:",[117,1156,1158],{"className":323,"code":1157,"language":325,"meta":122,"style":122},"{\n  \"campaignIds\": [],\n  \"next\": \"\u002Fcheckout?sessionId=CHECKOUT_SESSION_SECRET\",\n  \"checkoutUrl\": \"https:\u002F\u002Fplatform.scribeless.co\u002Fcheckout?sessionId=CHECKOUT_SESSION_SECRET\"\n}\n",[124,1159,1160,1164,1178,1196,1212],{"__ignoreMap":122},[127,1161,1162],{"class":129,"line":130},[127,1163,302],{"class":252},[127,1165,1166,1168,1171,1173,1175],{"class":129,"line":216},[127,1167,336],{"class":252},[127,1169,1170],{"class":339},"campaignIds",[127,1172,343],{"class":252},[127,1174,346],{"class":252},[127,1176,1177],{"class":252}," [],\n",[127,1179,1180,1182,1184,1186,1188,1190,1192,1194],{"class":129,"line":280},[127,1181,336],{"class":252},[127,1183,383],{"class":339},[127,1185,343],{"class":252},[127,1187,346],{"class":252},[127,1189,349],{"class":252},[127,1191,392],{"class":245},[127,1193,343],{"class":252},[127,1195,357],{"class":252},[127,1197,1198,1200,1202,1204,1206,1208,1210],{"class":129,"line":294},[127,1199,336],{"class":252},[127,1201,403],{"class":339},[127,1203,343],{"class":252},[127,1205,346],{"class":252},[127,1207,349],{"class":252},[127,1209,412],{"class":245},[127,1211,415],{"class":252},[127,1213,1214],{"class":129,"line":305},[127,1215,420],{"class":252},[110,1217,1218,1219,1221],{},"Recipients remain ",[124,1220,1024],{}," until checkout is paid. After payment succeeds, Scribeless marks the paid recipients as ready for fulfilment.",[134,1223,1225],{"id":1224},"recipient-count-changes","Recipient count changes",[110,1227,1228],{},"If you add, remove, or change recipients before a one-time campaign or cart has been paid for, call checkout again to get a fresh checkout link or payment attempt for the updated recipient count.",[110,1230,1231],{},"Calling checkout again generates a new payment step based on the latest pending recipients. Paid invoices are only attached after payment succeeds.",[134,1233,1235],{"id":1234},"notes","Notes",[1237,1238,1239,1248,1257,1262,1265,1268],"ul",{},[1240,1241,1242,1243,1245,1246,169],"li",{},"API-key checkout supports ",[124,1244,168],{}," or ",[124,1247,180],{},[1240,1249,1250,1251,1253,1254,169],{},"API-key checkout does not support ",[124,1252,1170],{}," or recipient ",[124,1255,1256],{},"ids",[1240,1258,1259,1261],{},[124,1260,168],{}," checkout is only available for one-time campaigns.",[1240,1263,1264],{},"Cart checkout is the simplest flow for unpaid HTML recipients.",[1240,1266,1267],{},"Checkout URLs include a session secret. Do not log them publicly.",[1240,1269,1270],{},"If a one-time campaign has already been paid or finalized, create a new campaign for the next send instead of adding more recipients.",[134,1272,1274],{"id":1273},"status-codes","Status codes",[139,1276,1277,1287],{},[142,1278,1279],{},[145,1280,1281,1284],{},[148,1282,1283],{},"Status",[148,1285,1286],{},"Meaning",[155,1288,1289,1299,1318,1328],{},[145,1290,1291,1296],{},[160,1292,1293],{},[124,1294,1295],{},"200",[160,1297,1298],{},"Checkout completed or returned the next setup\u002Fpayment step.",[145,1300,1301,1306],{},[160,1302,1303],{},[124,1304,1305],{},"400",[160,1307,1308,1309,1311,1312,1314,1315,1317],{},"Missing or invalid ",[124,1310,168],{},", ",[124,1313,180],{},", or ",[124,1316,501],{},", invalid campaign state, unsupported checkout body, or failed recipient validation.",[145,1319,1320,1325],{},[160,1321,1322],{},[124,1323,1324],{},"401",[160,1326,1327],{},"Missing, malformed, invalid, or unauthorized API key.",[145,1329,1330,1335],{},[160,1331,1332],{},[124,1333,1334],{},"500",[160,1336,1337],{},"Checkout failed unexpectedly. Retry or contact support if it persists.",[1339,1340,1341],"style",{},"html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .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 .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}",{"title":122,"searchDepth":216,"depth":216,"links":1343},[1344,1345,1346,1347,1348,1349,1350,1351,1352],{"id":136,"depth":216,"text":137},{"id":202,"depth":216,"text":203},{"id":222,"depth":216,"text":223},{"id":494,"depth":216,"text":495},{"id":678,"depth":216,"text":679},{"id":1081,"depth":216,"text":1082},{"id":1224,"depth":216,"text":1225},{"id":1234,"depth":216,"text":1235},{"id":1273,"depth":216,"text":1274},"Create a checkout link for pending one-time recipients.","md",null,{},true,{"title":67,"description":1353},"Q-qvG0m2I9oT1iey5gGfvtsmdGvEMI7imj0S7coHF0Q",[1361,1363],{"title":63,"path":64,"stem":65,"description":1362,"children":-1},"Create a Scribeless recipient from custom HTML.",{"title":71,"path":72,"stem":73,"description":1364,"children":-1},"Render Scribeless handwriting text as a PNG.",1781258371510]