[{"data":1,"prerenderedAt":685},["ShallowReactive",2],{"navigation_docs":3,"-partner-workflows-checkout-recipients":104,"-partner-workflows-checkout-recipients-surround":680},[4,26,32,45,70,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],{"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},"PNG API","\u002Frecipients\u002Fpng-api","4.recipients\u002F5.png-api",{"title":71,"path":72,"stem":73,"children":74,"page":25},"Partner Workflows","\u002Fpartner-workflows","5.partner-workflows",[75,79,83],{"title":76,"path":77,"stem":78},"Create partner team","\u002Fpartner-workflows\u002Fcreate-partner-team","5.partner-workflows\u002F1.create-partner-team",{"title":80,"path":81,"stem":82},"Account status","\u002Fpartner-workflows\u002Faccount-status","5.partner-workflows\u002F2.account-status",{"title":84,"path":85,"stem":86},"Checkout recipients","\u002Fpartner-workflows\u002Fcheckout-recipients","5.partner-workflows\u002F3.checkout-recipients",{"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":84,"body":106,"description":673,"extension":674,"links":675,"meta":676,"navigation":677,"path":85,"seo":678,"stem":86,"__hash__":679},"docs\u002F5.partner-workflows\u002F3.checkout-recipients.md",{"type":107,"value":108,"toc":661},"minimark",[109,113,130,133,138,141,144,162,166,182,186,234,238,332,336,339,419,424,428,431,434,502,509,513,519,528,539,548,552,555,558,562,583,587,657],[110,111,112],"p",{},"Complete checkout for recipients on an approved partner one-time campaign.",[114,115,120],"pre",{"className":116,"code":117,"language":118,"meta":119,"style":119},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","POST https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients\u002Fcheckout\n","http","",[121,122,123],"code",{"__ignoreMap":119},[124,125,128],"span",{"class":126,"line":127},"line",1,[124,129,117],{},[110,131,132],{},"This endpoint is only for approved partner workflows configured by Scribeless. Normal API integrations do not need to call it.",[134,135,137],"h2",{"id":136},"when-to-use-checkout","When to use checkout",[110,139,140],{},"Call this endpoint after adding recipients to an approved partner one-time campaign. Checkout is the step that collects payment and allows those recipients to move toward fulfilment.",[110,142,143],{},"You do not need to call checkout for recurring campaigns. If the customer has a subscription set up and the campaign is recurring, billing is handled automatically at the end of the 30-day billing cycle.",[110,145,146,147,153,154,157,158,161],{},"Use ",[148,149,150],"a",{"href":81},[121,151,152],{},"GET \u002Fapi\u002Faccount\u002Fstatus"," before checkout when you need to check whether the account is ready. ",[121,155,156],{},"billByInvoice"," indicates whether invoice billing is ready for the account. If ",[121,159,160],{},"billingSetupUrl"," is present, send the customer to that URL to finish billing setup before expecting checkout to complete.",[134,163,165],{"id":164},"headers","Headers",[114,167,169],{"className":116,"code":168,"language":118,"meta":119,"style":119},"Content-Type: application\u002Fjson\nX-API-Key: YOUR_API_KEY\n",[121,170,171,176],{"__ignoreMap":119},[124,172,173],{"class":126,"line":127},[124,174,175],{},"Content-Type: application\u002Fjson\n",[124,177,179],{"class":126,"line":178},2,[124,180,181],{},"X-API-Key: YOUR_API_KEY\n",[134,183,185],{"id":184},"request-body","Request body",[187,188,189,205],"table",{},[190,191,192],"thead",{},[193,194,195,199,202],"tr",{},[196,197,198],"th",{},"Field",[196,200,201],{},"Type",[196,203,204],{},"Description",[206,207,208,222],"tbody",{},[193,209,210,216,219],{},[211,212,213],"td",{},[121,214,215],{},"campaignId",[211,217,218],{},"string",[211,220,221],{},"Campaign whose pending recipients should be checked out.",[193,223,224,229,231],{},[211,225,226],{},[121,227,228],{},"redirectUrl",[211,230,218],{},[211,232,233],{},"HTTPS URL where Scribeless should send the customer after a partner checkout payment succeeds or fails.",[134,235,237],{"id":236},"example-request","Example request",[114,239,243],{"className":240,"code":241,"language":242,"meta":119,"style":119},"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    \"redirectUrl\": \"https:\u002F\u002Fpartner.example.com\u002Fscribeless\u002Fcallback\"\n  }'\n","bash",[121,244,245,272,286,300,311,317,323],{"__ignoreMap":119},[124,246,247,251,255,258,262,265,268],{"class":126,"line":127},[124,248,250],{"class":249},"sBMFI","curl",[124,252,254],{"class":253},"sfazB"," --request",[124,256,257],{"class":253}," POST",[124,259,261],{"class":260},"sMK4o"," '",[124,263,264],{"class":253},"https:\u002F\u002Fplatform.scribeless.co\u002Fapi\u002Frecipients\u002Fcheckout",[124,266,267],{"class":260},"'",[124,269,271],{"class":270},"sTEyZ"," \\\n",[124,273,274,277,279,282,284],{"class":126,"line":178},[124,275,276],{"class":253},"  --header",[124,278,261],{"class":260},[124,280,281],{"class":253},"Content-Type: application\u002Fjson",[124,283,267],{"class":260},[124,285,271],{"class":270},[124,287,289,291,293,296,298],{"class":126,"line":288},3,[124,290,276],{"class":253},[124,292,261],{"class":260},[124,294,295],{"class":253},"X-API-Key: YOUR_API_KEY",[124,297,267],{"class":260},[124,299,271],{"class":270},[124,301,303,306,308],{"class":126,"line":302},4,[124,304,305],{"class":253},"  --data",[124,307,261],{"class":260},[124,309,310],{"class":253},"{\n",[124,312,314],{"class":126,"line":313},5,[124,315,316],{"class":253},"    \"campaignId\": \"CAMPAIGN_ID\",\n",[124,318,320],{"class":126,"line":319},6,[124,321,322],{"class":253},"    \"redirectUrl\": \"https:\u002F\u002Fpartner.example.com\u002Fscribeless\u002Fcallback\"\n",[124,324,326,329],{"class":126,"line":325},7,[124,327,328],{"class":253},"  }",[124,330,331],{"class":260},"'\n",[134,333,335],{"id":334},"payment-succeeded","Payment succeeded",[110,337,338],{},"When checkout completes, Scribeless moves eligible pending recipients toward fulfilment. Scribeless attempts automatic payment first. If automatic payment cannot be completed, the response returns the next checkout or payment step instead.",[114,340,344],{"className":341,"code":342,"language":343,"meta":119,"style":119},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"status\": \"payment_succeeded\",\n  \"campaignId\": \"CAMPAIGN_ID\",\n  \"invoiceUrl\": \"https:\u002F\u002Finvoice.stripe.com\u002Fi\u002F...\"\n}\n","json",[121,345,346,350,376,395,414],{"__ignoreMap":119},[124,347,348],{"class":126,"line":127},[124,349,310],{"class":260},[124,351,352,355,359,362,365,368,371,373],{"class":126,"line":178},[124,353,354],{"class":260},"  \"",[124,356,358],{"class":357},"spNyl","status",[124,360,361],{"class":260},"\"",[124,363,364],{"class":260},":",[124,366,367],{"class":260}," \"",[124,369,370],{"class":253},"payment_succeeded",[124,372,361],{"class":260},[124,374,375],{"class":260},",\n",[124,377,378,380,382,384,386,388,391,393],{"class":126,"line":288},[124,379,354],{"class":260},[124,381,215],{"class":357},[124,383,361],{"class":260},[124,385,364],{"class":260},[124,387,367],{"class":260},[124,389,390],{"class":253},"CAMPAIGN_ID",[124,392,361],{"class":260},[124,394,375],{"class":260},[124,396,397,399,402,404,406,408,411],{"class":126,"line":302},[124,398,354],{"class":260},[124,400,401],{"class":357},"invoiceUrl",[124,403,361],{"class":260},[124,405,364],{"class":260},[124,407,367],{"class":260},[124,409,410],{"class":253},"https:\u002F\u002Finvoice.stripe.com\u002Fi\u002F...",[124,412,413],{"class":260},"\"\n",[124,415,416],{"class":126,"line":313},[124,417,418],{"class":260},"}\n",[110,420,421,423],{},[121,422,401],{}," is the hosted Stripe invoice URL for the paid invoice.",[134,425,427],{"id":426},"checkout-required","Checkout required",[110,429,430],{},"If the customer has not provided billing card details yet, or automatic payment cannot be completed, the response includes a Scribeless checkout URL. Send the customer to that URL so they can complete payment setup or payment recovery.",[110,432,433],{},"Scribeless returns a partner checkout URL:",[114,435,437],{"className":341,"code":436,"language":343,"meta":119,"style":119},"{\n  \"status\": \"checkout_required\",\n  \"campaignId\": \"CAMPAIGN_ID\",\n  \"checkoutUrl\": \"https:\u002F\u002Fplatform.scribeless.co\u002Fpartner-checkout?sessionId=CHECKOUT_SESSION_SECRET\"\n}\n",[121,438,439,443,462,480,498],{"__ignoreMap":119},[124,440,441],{"class":126,"line":127},[124,442,310],{"class":260},[124,444,445,447,449,451,453,455,458,460],{"class":126,"line":178},[124,446,354],{"class":260},[124,448,358],{"class":357},[124,450,361],{"class":260},[124,452,364],{"class":260},[124,454,367],{"class":260},[124,456,457],{"class":253},"checkout_required",[124,459,361],{"class":260},[124,461,375],{"class":260},[124,463,464,466,468,470,472,474,476,478],{"class":126,"line":288},[124,465,354],{"class":260},[124,467,215],{"class":357},[124,469,361],{"class":260},[124,471,364],{"class":260},[124,473,367],{"class":260},[124,475,390],{"class":253},[124,477,361],{"class":260},[124,479,375],{"class":260},[124,481,482,484,487,489,491,493,496],{"class":126,"line":302},[124,483,354],{"class":260},[124,485,486],{"class":357},"checkoutUrl",[124,488,361],{"class":260},[124,490,364],{"class":260},[124,492,367],{"class":260},[124,494,495],{"class":253},"https:\u002F\u002Fplatform.scribeless.co\u002Fpartner-checkout?sessionId=CHECKOUT_SESSION_SECRET",[124,497,413],{"class":260},[124,499,500],{"class":126,"line":313},[124,501,418],{"class":260},[110,503,504,505,508],{},"Recipients remain ",[121,506,507],{},"pending"," until they have been paid for.",[134,510,512],{"id":511},"redirect-callback","Redirect callback",[110,514,515,516,518],{},"Scribeless redirects the customer back to ",[121,517,228],{}," after partner checkout completes.",[114,520,522],{"className":116,"code":521,"language":118,"meta":119,"style":119},"https:\u002F\u002Fpartner.example.com\u002Fscribeless\u002Fcallback?status=payment_succeeded&campaignId=CAMPAIGN_ID\n",[121,523,524],{"__ignoreMap":119},[124,525,526],{"class":126,"line":127},[124,527,521],{},[110,529,530,531,534,535,538],{},"Failed or incomplete payment redirects use ",[121,532,533],{},"status=payment_failed"," and may include a ",[121,536,537],{},"reason"," query parameter:",[114,540,542],{"className":116,"code":541,"language":118,"meta":119,"style":119},"https:\u002F\u002Fpartner.example.com\u002Fscribeless\u002Fcallback?status=payment_failed&campaignId=CAMPAIGN_ID&reason=checkout_not_fulfilled\n",[121,543,544],{"__ignoreMap":119},[124,545,546],{"class":126,"line":127},[124,547,541],{},[134,549,551],{"id":550},"recipient-count-changes","Recipient count changes",[110,553,554],{},"If you add, remove, or change recipients before the campaign has been paid for, call checkout again to get a fresh checkout link or payment attempt for the updated recipient count.",[110,556,557],{},"Calling checkout again generates a new payment step based on the latest campaign recipients. Paid invoices are only attached to the campaign after payment succeeds.",[134,559,561],{"id":560},"notes","Notes",[563,564,565,569,580],"ul",{},[566,567,568],"li",{},"This endpoint is available only for approved partner one-time campaigns.",[566,570,571,572,575,576,579],{},"Create the campaign with ",[121,573,574],{},"frequency: \"oneTime\"",". Do not set ",[121,577,578],{},"billing_method: \"oneTimeInvoice\""," when creating the campaign.",[566,581,582],{},"If a one-time campaign has already been paid or finalized, you cannot add and checkout more recipients on that campaign. Create a new campaign for the next send.",[134,584,586],{"id":585},"status-codes","Status codes",[187,588,589,599],{},[190,590,591],{},[193,592,593,596],{},[196,594,595],{},"Status",[196,597,598],{},"Meaning",[206,600,601,611,637,647],{},[193,602,603,608],{},[211,604,605],{},[121,606,607],{},"200",[211,609,610],{},"Checkout completed or returned the next setup\u002Fpayment step.",[193,612,613,618],{},[211,614,615],{},[121,616,617],{},"400",[211,619,620,621,623,624,626,627,629,630,633,634,636],{},"Missing or invalid ",[121,622,215],{},", invalid ",[121,625,228],{},", invalid campaign state, or failed recipient validation. Missing ",[121,628,215],{}," returns ",[121,631,632],{},"API key checkout requires a campaign id",". ",[121,635,228],{}," must use HTTPS.",[193,638,639,644],{},[211,640,641],{},[121,642,643],{},"401",[211,645,646],{},"Missing, malformed, invalid, unauthorized, or non-partner API key.",[193,648,649,654],{},[211,650,651],{},[121,652,653],{},"500",[211,655,656],{},"Checkout failed unexpectedly. Retry or contact support if it persists.",[658,659,660],"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}",{"title":119,"searchDepth":178,"depth":178,"links":662},[663,664,665,666,667,668,669,670,671,672],{"id":136,"depth":178,"text":137},{"id":164,"depth":178,"text":165},{"id":184,"depth":178,"text":185},{"id":236,"depth":178,"text":237},{"id":334,"depth":178,"text":335},{"id":426,"depth":178,"text":427},{"id":511,"depth":178,"text":512},{"id":550,"depth":178,"text":551},{"id":560,"depth":178,"text":561},{"id":585,"depth":178,"text":586},"Complete checkout for approved partner one-time campaign recipients.","md",null,{},true,{"title":84,"description":673},"UKBSP3ZDPHfUSfmOwx7Z4hRAg2kxvvfeg6BYguJTADk",[681,683],{"title":80,"path":81,"stem":82,"description":682,"children":-1},"Check whether a Scribeless account is ready for API-driven sending.",{"title":93,"path":94,"stem":95,"description":684,"children":-1},"Receive signed Scribeless events in your own systems.",1780671949392]