listMembershipPlans
Retrieve membership plans with subscription IDs for assigning to new users. Supports filtering and pagination to find plans by properties.
Instructions
List membership plans - Paginated enumeration of membership-plan records. Read-only.
Use when: discovering subscription_id values to use when creating members. Essential prerequisite for createUser - every member needs a valid subscription_id.
Lean-by-default keep-list: rows return only the core fields: subscription_id, subscription_name, subscription_type, profile_type, monthly_amount, yearly_amount, initial_amount, lead_price, searchable, search_membership_permissions, data_settings. data_settings is the comma-separated list of post-type IDs this plan can publish — kept by default to support author-resolution flows (find plans whose members can publish a given post type). A plan's members have a publicly accessible, searchable profile (BD's UI calls this "Listing Searchable") only when searchable=1 AND search_membership_permissions contains visitor. Everything else stripped — restore via flags:
include_plan_config=1- restores config bundle (active/searchable toggles, limits, forms, sidebars, email templates, upgrade chain, payment defaults, etc.).include_plan_display_flags=1- restoresshow_*profile-visibility toggles.include_extras=1- returns the full BD plan row, untouched (every column).
Pagination: cursor-based (limit, page). See Rule: Pagination.
Filter/sort: property+property_value+property_operator, order_column+order_type. See Rule: Filter operators.
See also: getMembershipPlan (single by ID).
Returns: { status: "success", total, ..., message: [...records] }.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Pagination cursor (use next_page from previous response) | |
| limit | No | Records per page (default 25, max 100) | |
| property | No | Column key to filter by (present on the response rows; a wrong name silently returns empty). For multi-condition AND, pass parallel arrays here and in `property_value`/`property_operator` — equal length, Nth entries paired. See Rule: Compound filters. | |
| order_type | No | Sort direction: ASC or DESC | |
| order_column | No | Column to sort by — a column key present on the response rows (a wrong name silently returns empty) | |
| include_extras | No | Opt in to return ALL remaining fields on this resource that are not in the lean-by-default keep-list and not gated by another `include_*` flag. Lean default returns only the core identity, routing, and load-bearing fields. `include_extras=1` restores everything else (geo, all hero_*, layout/sidebar/menu config, all display toggles, admin metadata, etc.). Resource-specific — see each tool's description for what the extras bundle contains. | |
| property_value | No | Value to filter by; array to pair with a `property` array (same length). | |
| property_operator | No | Filter operator (word-form; symbol forms WAF-stripped). Single: eq, ne, lt, lte, gt, gte, like, not_like. CSV: in, not_in, between. Substring: contains, starts_with, ends_with (+not_). Date: year_eq, month_eq, day_eq (+not_), since_days, until_days. Length: length_eq, length_lt, length_gt, length_between. Null: is_set, is_not_set, is_null, is_not_null. Array to pair with a `property` array (same length). See Rule: Filter operators for value shapes. | |
| include_plan_config | No | Opt in to restore plan config fields: `sub_active`, `search_priority`, `auto_activate`, `status_after_upgrade`, `upgradable_membership`, `photo_limit`, `style_limit`, `service_limit`, `location_limit`, all form/sidebar/email-template fields, `profile_layout`, `menu_name`, `data_settings_read`, `location_settings`, `payment_default`, `hide_specialties`, `email_member`, `login_redirect`, `page_header`, `page_footer`, `display_ads`, `receive_messages`, `index_rule`, `nofollow_links`. Default stripped. (Note: `data_settings` is now in the lean-by-default keep-list — no opt-in needed.) | |
| include_plan_display_flags | No | Opt in to restore profile-visibility toggles: `show_about`, `show_experience`, `show_education`, `show_background`, `show_affiliations`, `show_publications`, `show_awards`, `show_slogan`, `show_sofware`, `show_phone`, `seal_link`, `website_link`, `social_link`. Default stripped. |