People and access
CLI commands to find people, explain their access and simulate purchase lifecycle events.
These commands find the people using your app, explain why they have or lack a perk, and play renewals, expirations and refunds on simulated purchases. Studio's People page shows the same data.
People
| Command | What it does | Key flags |
|---|---|---|
person list | The newest people. | --limit (at most 100) |
person find <query> | Finds people by exact email, distinct ID or person ID. Names can't be searched. | |
person view [person] | Profile, perks and what grants each, subscriptions, purchases, flag overrides and recent events. | |
person why [person] [perk] | Why a person has or lacks a perk, where the chain breaks, and the fix. | |
person edit [person] | Changes their email, name or attributes. | --email, --name, --set key=value, --set-once key=value |
person create | Adds a person by the distinct ID your app will identify them by. | --distinct-id, --email, --name |
person erase [person] | Erases their personal data for good. Asks you to type their email or distinct ID. | --wait (default) or --no-wait |
Subscriptions and purchases shown are production store purchases. See Delete personal data for what erasing keeps.
Simulated purchases
These commands work on simulated purchases, which debug builds make with the test publishable key. They never touch production, store sandbox, Stripe test mode or payment source test purchases. See Simulate renewals, expiry and refunds. The MCP server's sandbox tools do the same.
| Command | What it does |
|---|---|
sandbox view [person] | A person's simulated purchases and subscriptions, and their access. |
sandbox renew [person] [product] | Renews a simulated subscription for another period. |
sandbox expire [person] [product] | Ends a simulated subscription now. |
sandbox grace-period [person] [product] | Starts its three-day billing grace period, as after a failed renewal. |
sandbox refund [person] [product] | Refunds a one-time simulated purchase; its access ends. |
sandbox revoke [person] [product] | Revokes a simulated purchase or subscription. |
sandbox reset | Deletes every simulated purchase in the project. Asks first. |
Example
voidhash person why ada@example.com premium
voidhash sandbox grace-period user_123 pro_monthlyNext steps
- People and identity: distinct IDs and merges.
- Test purchases (Help center): every way to test a purchase.
- Catalog and payments: products, perks and stores.
Something wrong or missing on this page? Tell us by email or on Discord.