Trial mode

Use trial mode when you want users to try drafting before they pay, and then direct them to your pricing/upgrade page.

How to use:

1. Create a builder session with a trial object in POST /api/builder/sessions (endpoint docs).
2. Set cta_url to your pricing/upgrade URL. All trial CTAs use this URL.
3. After purchase, patch the existing session with trial: null via PATCH /api/builder/sessions/{session_id} so the end-user can continue and finalize the same started document.

More information about trial parameters can be found in the Create a new builder session endpoint description.

{
  "trial": {
    "heading_text": "<strong>Free trial</strong> - Upgrade to unlock full preview, downloads, and e-signing.",
    "heading_cta_text": "Explore plans",
    "preview_text": "Unlock full preview",
    "finalize_title": "Finish and use your document",
    "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>",
    "finalize_cta_text": "Explore plans",
    "cta_url": "https://yourapp.com/plans"
  }
}

When trial is enabled, the session cannot be finalized with the normal finalize endpoint. You can see Trial mode in the example app by activating it from Settings.