Memberstack CLI

Plans

Manage Memberstack plans.

View Markdown
memberstack plans <subcommand> [options]

plans list

List all plans.

memberstack plans list [options]

Options

OptionDescription
--status <status>Filter by status: ALL, ACTIVE, INACTIVE
--order-by <field>Order by field: PRIORITY, CREATED_AT

plans get

Get a plan by ID.

memberstack plans get <id>

Arguments

ArgumentDescription
idPlan ID

plans create

Create a new plan.

memberstack plans create [options]

Options

OptionDescription
--name <name>Plan name
--description <description>Plan description
--icon <icon>Plan icon
--is-paidMark plan as paid
--team-accounts-enabledEnable team accounts
--team-account-invite-signup-link <url>Team account invite signup link
--team-account-upgrade-link <url>Team account upgrade link

Example

memberstack plans create --name "Pro" --description "Professional tier" --is-paid

plans update

Update a plan.

memberstack plans update <id> [options]

Arguments

ArgumentDescription
idPlan ID

Options

OptionDescription
--name <name>Plan name
--description <description>Plan description
--icon <icon>Plan icon
--status <status>Plan status: ACTIVE, INACTIVE
--limit-membersEnable member limit
--no-limit-membersDisable member limit
--member-limit <number>Maximum number of members
--team-account-upgrade-link <url>Team account upgrade link
--team-account-invite-signup-link <url>Team account invite signup link
--restrict-to-adminRestrict plan to admin
--no-restrict-to-adminRemove admin restriction
--redirect <key=url>Set redirect URL (repeatable). Keys: afterSignup, afterLogin, afterLogout, afterPurchase, afterCancel, afterReplace, verificationRequired
--permission-id <id>Permission ID (repeatable; replaces all permissions)
--allowed-domain <email>Allowed email domain (repeatable; replaces all domains)

Example

memberstack plans update pln_abc123 --status ACTIVE --restrict-to-admin

plans delete

Delete a plan.

memberstack plans delete <id>

Arguments

ArgumentDescription
idPlan ID

plans order

Reorder plans by priority.

memberstack plans order --plan <planId:priority> [--plan <planId:priority> ...]

Options

OptionDescription
--plan <planId:priority>Plan ID and priority (repeatable), for example --plan pln_abc:1

Example

memberstack plans order --plan pln_basic:1 --plan pln_pro:2 --plan pln_enterprise:3

FAQ

How is this guide?

Last updated on

On this page