Archive a membership type
path Parameters
idHeaders
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
Archive a membership type › Responses
MembershipTypeResource
idtitledescriptionproduct_idtypebase_membership_idstatusmetadatarenewal_notificationsrenewal_notifications_pre_expirationrenewal_notifications_post_expirationrenewal_notifications_pre_expiration_daysrenewal_notifications_post_expiration_dayspre_expiration_leadupuser_auto_renewalsexclude_from_taxmembership_card_idhiddenhide_starting_at_pricevisibility_requires_base_membershipforced_bundle_with_baseWhen true (add-ons only), the add-on is only offered bundled with its base; the base is not listed alone.
exclude_from_parent_tenant_feeform_iddisable_default_cardsort_ordermanual_order_enabledcreated_atupdated_atdeleted_atuser_blocked_from_membership_checkoutWhether the authenticated member is blocked from purchasing a membership because their coverage is provided through a family group holder's membership instead. Only computed on the show endpoint for an authenticated member; null otherwise (e.g. guests, or contexts that don't compute this, such as the index listing).
user_can_purchaseWhether the authenticated member can purchase this membership type according to MembershipTypePolicy::purchase. Only computed on the show endpoint for authenticated members; null otherwise.
Waivers associated with this membership type.
Plans associated with this membership type.
audienceRaw per-locale values and their provenance for the manager translation editor,
plus each field's translation mode (auto translates into every supported
locale, source shows the English value everywhere). Omitted for non-manager
readers.
Unarchive a membership type
path Parameters
idHeaders
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
Unarchive a membership type › Responses
MembershipTypeResource
idtitledescriptionproduct_idtypebase_membership_idstatusmetadatarenewal_notificationsrenewal_notifications_pre_expirationrenewal_notifications_post_expirationrenewal_notifications_pre_expiration_daysrenewal_notifications_post_expiration_dayspre_expiration_leadupuser_auto_renewalsexclude_from_taxmembership_card_idhiddenhide_starting_at_pricevisibility_requires_base_membershipforced_bundle_with_baseWhen true (add-ons only), the add-on is only offered bundled with its base; the base is not listed alone.
exclude_from_parent_tenant_feeform_iddisable_default_cardsort_ordermanual_order_enabledcreated_atupdated_atdeleted_atuser_blocked_from_membership_checkoutWhether the authenticated member is blocked from purchasing a membership because their coverage is provided through a family group holder's membership instead. Only computed on the show endpoint for an authenticated member; null otherwise (e.g. guests, or contexts that don't compute this, such as the index listing).
user_can_purchaseWhether the authenticated member can purchase this membership type according to MembershipTypePolicy::purchase. Only computed on the show endpoint for authenticated members; null otherwise.
Waivers associated with this membership type.
Plans associated with this membership type.
audienceRaw per-locale values and their provenance for the manager translation editor,
plus each field's translation mode (auto translates into every supported
locale, source shows the English value everywhere). Omitted for non-manager
readers.
Reorder items by an ordered array of IDs
Headers
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
Reorder items by an ordered array of IDs › Request Body
idsprioritized_idsReorder items by an ordered array of IDs › Responses
messageDisable manual ordering and return to natural ordering
Headers
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
Disable manual ordering and return to natural ordering › Responses
messageList all membership types in the system
Headers
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
List all membership types in the system › Responses
Paginated set of MembershipTypeResource
current_pagefromlast_pageper_pagetototalRetrieve a membership type
path Parameters
membership_typeHeaders
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
Retrieve a membership type › Responses
MembershipTypeResource
idtitledescriptionproduct_idtypebase_membership_idstatusmetadatarenewal_notificationsrenewal_notifications_pre_expirationrenewal_notifications_post_expirationrenewal_notifications_pre_expiration_daysrenewal_notifications_post_expiration_dayspre_expiration_leadupuser_auto_renewalsexclude_from_taxmembership_card_idhiddenhide_starting_at_pricevisibility_requires_base_membershipforced_bundle_with_baseWhen true (add-ons only), the add-on is only offered bundled with its base; the base is not listed alone.
exclude_from_parent_tenant_feeform_iddisable_default_cardsort_ordermanual_order_enabledcreated_atupdated_atdeleted_atuser_blocked_from_membership_checkoutWhether the authenticated member is blocked from purchasing a membership because their coverage is provided through a family group holder's membership instead. Only computed on the show endpoint for an authenticated member; null otherwise (e.g. guests, or contexts that don't compute this, such as the index listing).
user_can_purchaseWhether the authenticated member can purchase this membership type according to MembershipTypePolicy::purchase. Only computed on the show endpoint for authenticated members; null otherwise.
Waivers associated with this membership type.
Plans associated with this membership type.
audienceRaw per-locale values and their provenance for the manager translation editor,
plus each field's translation mode (auto translates into every supported
locale, source shows the English value everywhere). Omitted for non-manager
readers.