getMembershipPlan
Retrieve a single membership plan record by its subscription ID. Returns core fields by default, with optional configuration and display flags.
Instructions
Get a single membership plan - Fetch a single membership-plan record. Read-only.
Use when: fetching one plan's config. Same lean-by-default as listMembershipPlans.
Required: subscription_id.
Lean-by-default keep-list: 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. 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. Opt in to restore:
include_plan_config=1- config bundle (limits, sidebars, forms, email templates, upgrade chain, payment defaults).include_plan_display_flags=1-show_*profile-visibility toggles.include_extras=1- returns the full BD plan row, untouched.
EAV-routed fields not merged: custom_checkout_url (and any future EAV-routed plan fields) are stored in users_meta and NOT returned by this endpoint even with include_plan_config=1. Read via listUserMeta database=subscription_types database_id=<subscription_id> to fetch them.
See also: listMembershipPlans (enumerate).
Returns: { status: "success", message: [{...record}] }.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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. | |
| subscription_id | Yes | ||
| include_plan_config | No | Opt in to restore plan config fields (limits, sidebars, forms, email templates, upgrade chain, display/payment settings). Default stripped. | |
| include_plan_display_flags | No | Opt in to restore profile-visibility toggles (`show_about`, `show_experience`, `show_phone`, `seal_link`, `website_link`, `social_link`, etc.). Default stripped. |