What the directory says about payment
Obsidian’s developer policies divide behavior into not allowed, allowed with disclosure, and licensing rules. Payment sits in the second group. The policies say the following are “only allowed if clearly indicated in your README”:
- Payment is required for full access.
- An account is required for full access.
- Network use, with a clear explanation of which remote services are used and why.
- Accessing files outside of Obsidian vaults.
- Server-side telemetry, with a link to a privacy policy.
- Closed-source code, “handled on a case by case basis”.
Under “not allowed” the policies list code obfuscation, client-side telemetry, dynamic ads, and plugins that install or update themselves or their dependencies. These apply to plugins in the official directory, not to plugins installed some other way.
Nothing in the policies provides a checkout or a way to charge. The directory is where people find and install plugins; the sale happens on your side. So a paid Obsidian plugin is a normal plugin plus a License API call, and a README that says what the free version does, what the paid one adds, which servers it contacts and what it costs.
Two consequences of those rules matter for design. A plugin cannot update itself, so Obsidian’s own plugin updates are the delivery channel and you cannot gate them. And with obfuscation banned, the code a buyer installs is readable. The check is a courtesy to honest users.
What is specific to Obsidian
Network calls. The plugin API provides requestUrl, which the API definitions describe as similar to fetch but “without any CORS restrictions”. Use it for the License API calls; there is no CORS question to solve.
Where the key lives. The standard saveData() writes data.json in the plugin folder, which is inside the vault. A vault is often synced by Obsidian Sync or iCloud, or kept in a git repository, sometimes a public one. A license key in data.json is shared to every synced device and may be pushed to GitHub. Use app.saveLocalStorage(key, value) instead. It stores a vault-specific value in the app’s localStorage, so it stays out of the vault files.
Vaults versus devices. Local storage is per vault, so a user with three vaults on one computer would activate three times. Two ways around it:
- On desktop, derive the
fingerprintfrom something device-wide, for example a hash of the hostname and user name read through Node. Activating again with the same fingerprint returns the same seat, so extra vaults cost nothing. - On mobile, where Node is not available, send a random id per vault and set the device limit with that in mind.
If your plugin sets isDesktopOnly: true in its manifest, you only need the first.
Telemetry. Client-side telemetry is not allowed. A license call is not telemetry, but say in the README what it sends: the key, a device name and the fingerprint.
Mobile. Unless the manifest says isDesktopOnly, a plugin can run on a phone or tablet, and that device takes a slot like any other.
Recommended setup
| Setting | Suggested value | Why |
|---|---|---|
| License type | One-time, or an annual subscription if the plugin has a server cost | A server cost is the clearest reason to charge repeatedly; say which model you sell in the README |
| Device limit | 5 | Desktop, laptop, phone, tablet, and one spare |
| Trial | 14 days, with the start date in local storage | No license needed before purchase |
| Updates | Obsidian’s plugin updater | You cannot gate it, so gate features |
Whatever you charge, the README has to say that payment is required for full access, because that is the disclosure the policies ask for.
Doing this with Clavem
Create a product, connect Stripe, map the Stripe price. Add a settings tab with a key field and a status line. On load, call validate through requestUrl in the background, store the new token and show the state. The Obsidian plugin guide has the flow, and the offline guide covers the token check. Obsidian’s own policies say the app prioritizes private and offline usage, so make sure the plugin keeps working with no network by trusting the stored token until refresh_by.
Guides to follow
- License key validation for Obsidian plugins
- Offline license verification for Obsidian plugins
- License key validation in Node.js
Questions
Are paid plugins allowed in the Obsidian community directory?
The developer policies list payment required for full access as allowed only if clearly indicated in the README. They also list an account requirement, network use and closed-source code as disclosures, the last one decided case by case. Read the current policies before you submit.
Where should an Obsidian plugin keep the license key?
Not in data.json, which lives inside the vault and travels with Obsidian Sync, iCloud and git. Use the app's local storage, which is not part of the vault files, and treat the key as per device.