What is the difference between public and private custom fields?

Public custom fields are visible to members and can be read client-side (browser). Private custom fields are only accessible server-side or through the admin API. Use private visibility for sensitive data like internal notes or feature flags.

Can I restrict a custom field to admin access only?

Yes. Use the --restrict-to-admin flag when creating or updating a custom field. This prevents members from reading or modifying the field value. Remove the restriction with --no-restrict-to-admin.

Can I associate a custom field with specific plans?

Yes. When creating a custom field, use --plan-ids to associate it with one or more plans. This limits the field to members on those plans.

Custom Fields | Memberstack CLI

memberstack custom-fields <subcommand> [options]

custom-fields list

List all custom fields.

memberstack custom-fields list

Example

$ memberstack custom-fields list
[
  {
    "id": "fld_abc123",
    "key": "tier",
    "label": "Member Tier",
    "visibility": "PUBLIC",
    "hidden": false
  }
]

custom-fields create

Create a new custom field.

memberstack custom-fields create --key <key> --label <label> [options]

Options

Option	Description	Required
`--key <key>`	Field key	Yes
`--label <label>`	Field label	Yes
`--hidden`	Hide the field	No
`--visibility <visibility>`	Field visibility: `PUBLIC` or `PRIVATE`	No
`--restrict-to-admin`	Restrict field to admin access	No
`--plan-ids <ids...>`	Plan IDs to associate with the field	No

Examples

memberstack custom-fields create --key tier --label "Member Tier"

memberstack custom-fields create \
  --key vip \
  --label "VIP Status" \
  --visibility PRIVATE \
  --restrict-to-admin

memberstack custom-fields create --key type --label "Account Type" --hidden

custom-fields update

Update an existing custom field.

memberstack custom-fields update <id> [options]

Arguments

Argument	Description	Required
`id`	Custom field ID	Yes

Options

Option	Description	Required
`--label <label>`	Field label	Yes
`--hidden`	Hide the field	No
`--no-hidden`	Show the field	No
`--table-hidden`	Hide the field from the table	No
`--no-table-hidden`	Show the field in the table	No
`--visibility <visibility>`	Field visibility: `PUBLIC` or `PRIVATE`	No
`--restrict-to-admin`	Restrict field to admin access	No
`--no-restrict-to-admin`	Remove admin restriction	No

Examples

memberstack custom-fields update fld_abc123 --label "Updated Tier" --hidden

memberstack custom-fields update fld_abc123 \
  --label "Member Status" \
  --no-hidden \
  --visibility PUBLIC

custom-fields delete

Delete a custom field.

memberstack custom-fields delete <id>

Arguments

Argument	Description	Required
`id`	Custom field ID	Yes

Example

memberstack custom-fields delete fld_abc123

Custom Fields

custom-fields list

Example

custom-fields create

Options

Examples

custom-fields update

Arguments

Options

Examples

custom-fields delete

Arguments

Example

FAQ

On this page