Free Trial 101
This guide explains how the 30-day free trial works when users request access to your app via the Vim Canvas™ Marketplace. It’s specifically for apps configured at the user level, with step-by-step details on activation, trial management, and billing.
User-Level App: Activation and Free Trial Workflow
When a user requests access to your app, and your app supports individual (user-level) onboarding, the following process applies.
1. Activation and User Assignment
Once a user initiates a request through the Marketplace:
- If practice has allowed “direct add”:
User clicks “Add app”- App is added automatically.
- User receives immediate notification that the app is installed and usually ready to use.
- If approval is required (user must request app or app needs an organization-level subscription):
- User clicks "Request to Add" and sees a notification that Vim will review the request.
- Vim notifies the organization’s Console Owner.
- For individual apps: If approved, user gets a notification and follow-up email confirming activation or next steps.
- For org-level subscription apps: Vim requests Console Owner’s permission to share contact details with the app developer, who will follow up directly.
- If your app supports a free trial, the developer can return the user as authorized, granting access as soon as the app’s activation status is set to Enabled
2. 30-Day Free Trial (If Enabled)
If your app is marked as “Free Trial” in your manifest submission, here’s what happens next:
During the trial period:
- Users receive 30 days of free access to your app.
- No charges apply during the trial.
- You are responsible for managing the user experience during this period.
- User data is shared via the Vim SDK—make sure to authorize users in your system.
- Use this time to engage users, gather feedback, and plan for what happens after the trial ends.
3. After the Trial Ends
Following the end of the Trial Period, you are responsible for taking one of the following actions:
- Return the app authentication as unauthorized (code 403) as part of the token endpoint (more info here) and not trigger the activation status to "Enabled" in order not to trigger the billing event. In that case, users won't have access to your app and Vim will not charge you for these users from this date. If you fail to do so, Vim will automatically begin charging usage fees for such user, once the Trial Period ends.
- Keep returning the user as authorized and trigger the activation status to "Enabled". If you do so, no matter if the user is a premium user and has completed payment on your end or not, Vim will begin charging the usage fee.
Reminder: Vim only bills for authorized users. To avoid charges, be sure to deauthorize any users you don’t wish to continue before the trial period ends.