{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Trial mode"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"trial-mode","__idx":0},"children":["Trial mode"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use trial mode when you want users to try drafting before they pay, and then direct them to your pricing/upgrade page."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["How to use:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create a builder session with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["trial"]}," object in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/builder/sessions"]}," (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/embed-api/openapi/builder/createbuildersession"},"children":["endpoint docs"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cta_url"]}," to your pricing/upgrade URL. All trial CTAs use this URL."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["After purchase, patch the existing session with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["trial: null"]}," via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/builder/sessions/{session_id}"]}," so the end-user can continue and finalize the same started document."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["More information about trial parameters can be found in the"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/embed-api/openapi/builder/createbuildersession"},"children":["Create a new builder session"]}," endpoint description."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"trial\": {\n    \"heading_text\": \"<strong>Free trial</strong> - Upgrade to unlock full preview, downloads, and e-signing.\",\n    \"heading_cta_text\": \"Explore plans\",\n    \"preview_text\": \"Unlock full preview\",\n    \"finalize_title\": \"Finish and use your document\",\n    \"finalize_content\": \"<h3>Your document is ready.</h3><p>Upgrade to:</p><ul><li>View the full document</li><li>Download it as a PDF</li><li>Send it for signing</li></ul>\",\n    \"finalize_cta_text\": \"Explore plans\",\n    \"cta_url\": \"https://yourapp.com/plans\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["trial"]}," is enabled, the session cannot be finalized with the normal finalize endpoint."," ","You can see Trial mode in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://example-embeddable-builder.vercel.app"},"children":["example app"]}," by activating it from Settings."]}]},"headings":[{"value":"Trial mode","id":"trial-mode","depth":1}],"frontmatter":{"seo":{"title":"Trial mode"}},"lastModified":"2026-08-28T07:01:12.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/embed-api/legal-engine/trial-mode","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}