MembershipTypeResource

base_membership_id
Type: integer | null
required

Integer numbers.
created_at
Type: string
required
deleted_at
Type: string | null
required
description
Type: string | null
required
disable_default_card
Type: boolean
required
exclude_from_parent_tenant_fee
Type: boolean
required
exclude_from_tax
Type: boolean
required
forced_bundle_with_base
Type: boolean
required

When true (add-ons only), the add-on is only offered bundled with its base; the base is not listed alone.
form_id
Type: integer | null
required

Integer numbers.
hidden
Type: boolean
required
id
Type: integer
required

Integer numbers.
manual_order_enabled
Type: boolean
required
membership_card_id
Type: integer | null
required

Integer numbers.
metadata
Type: array | null
required
plans
Type: array object[] · PlanResource[]
required

Plans associated with this membership type.
- amount
  Type: integer | null
  required
  
  Integer numbers.
- boundary_id
  Type: integer | null
  required
  
  Integer numbers.
- created_at
  Type: string
  required
- deleted_at
  Type: string | null
  required
- description
  Type: string | null
  required
- id
  Type: integer
  required
  
  Integer numbers.
- interval
  Type: string | null
  required
- is_business_plan
  Type: boolean
  required
- max_beneficiaries
  Type: integer | null
  required
  
  Integer numbers.
- membership_type_id
  Type: integer
  required
  
  Integer numbers.
- metadata
  Type: array | null
  required
- nickname
  Type: string | null
  required
- plan_id
  Type: string | null
  required
- plan_to_hide
  Type: integer | null
  required
  
  Integer numbers.
- pricing_type
  Type: string | null
  required
- status
  Type: string | null
  required
- subscription_schedule_id
  Type: string | null
  required
- updated_at
  Type: string
  required
- audience
  Type: string
- boundary
  Type: object
- membership_type
  Type: object
- user_in_boundary
  Type: string
pre_expiration_leadup
Type: integer | null
required

Integer numbers.
product_id
Type: string | null
required
renewal_notifications
Type: boolean
required
renewal_notifications_post_expiration
Type: boolean
required
renewal_notifications_post_expiration_days
Type: integer | null
required

Integer numbers.
renewal_notifications_pre_expiration
Type: boolean
required
renewal_notifications_pre_expiration_days
Type: integer | null
required

Integer numbers.
sort_order
Type: integer | null
required

Integer numbers.
status
Type: string | null
required
title
Type: string
required
type
Type: string | null
required
updated_at
Type: string
required
user_auto_renewals
Type: boolean
required
visibility_requires_base_membership
Type: boolean
required
waivers
Type: array object[]
required

Waivers associated with this membership type.
- created_at
  Type: string | nullFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- deleted_at
  Type: string | nullFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- file
  Type: string
  required
- id
  Type: integer
  required
  
  Integer numbers.
- publicUrl
  Type: string
  required
- tenant_id
  Type: integer | null
  required
  
  Integer numbers.
- title
  Type: string
  required
- updated_at
  Type: string | nullFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
audience
Type: string
form
Type: object
- allow_repeat_submissions
  Type: boolean
  required
- bookable_entity_id
  Type: integer | null
  required
  
  Integer numbers.
- created_at
  Type: string | nullFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- creator_id
  Type: integer | null
  required
  
  Integer numbers.
- deleted_at
  Type: string | nullFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- description
  Type: string | null
  required
- form_structure
  Type: array
  required
- form_template_key
  Type: string | null
  required
- id
  Type: integer
  required
  
  Integer numbers.
- link
  Type: string
  required
- original_form_id
  Type: integer | null
  required
  
  Integer numbers.
- parent_form_id
  Type: integer | null
  required
  
  Integer numbers.
- profile_field_associations
  Type: array | null
  required
- status
  Type: string
  required
- tenant_id
  Type: integer | null
  required
  
  Integer numbers.
- title
  Type: string
  required
- type
  Type: string
  required
- updated_at
  Type: string | nullFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- uuid
  Type: string | null
  required
plans_active
Type: array object[] · PlanResource[]
- amount
  Type: integer | null
  required
  
  Integer numbers.
- boundary_id
  Type: integer | null
  required
  
  Integer numbers.
- created_at
  Type: string
  required
- deleted_at
  Type: string | null
  required
- description
  Type: string | null
  required
- id
  Type: integer
  required
  
  Integer numbers.
- interval
  Type: string | null
  required
- is_business_plan
  Type: boolean
  required
- max_beneficiaries
  Type: integer | null
  required
  
  Integer numbers.
- membership_type_id
  Type: integer
  required
  
  Integer numbers.
- metadata
  Type: array | null
  required
- nickname
  Type: string | null
  required
- plan_id
  Type: string | null
  required
- plan_to_hide
  Type: integer | null
  required
  
  Integer numbers.
- pricing_type
  Type: string | null
  required
- status
  Type: string | null
  required
- subscription_schedule_id
  Type: string | null
  required
- updated_at
  Type: string
  required
- audience
  Type: string
- boundary
  Type: object
- membership_type
  Type: object
- user_in_boundary
  Type: string
plans_discountable
Type: array object[] · PlanResource[]
- amount
  Type: integer | null
  required
  
  Integer numbers.
- boundary_id
  Type: integer | null
  required
  
  Integer numbers.
- created_at
  Type: string
  required
- deleted_at
  Type: string | null
  required
- description
  Type: string | null
  required
- id
  Type: integer
  required
  
  Integer numbers.
- interval
  Type: string | null
  required
- is_business_plan
  Type: boolean
  required
- max_beneficiaries
  Type: integer | null
  required
  
  Integer numbers.
- membership_type_id
  Type: integer
  required
  
  Integer numbers.
- metadata
  Type: array | null
  required
- nickname
  Type: string | null
  required
- plan_id
  Type: string | null
  required
- plan_to_hide
  Type: integer | null
  required
  
  Integer numbers.
- pricing_type
  Type: string | null
  required
- status
  Type: string | null
  required
- subscription_schedule_id
  Type: string | null
  required
- updated_at
  Type: string
  required
- audience
  Type: string
- boundary
  Type: object
- membership_type
  Type: object
- user_in_boundary
  Type: string
tax_ignore
Type: object
- bookable_entity_id
  Type: integer | null
  required
  
  Integer numbers.
- created_at
  Type: string | nullFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- deleted_at
  Type: string | nullFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- id
  Type: integer
  required
  
  Integer numbers.
- membership_type_id
  Type: string | null
  required
- parent_program_id
  Type: integer | null
  required
  
  Integer numbers.
- product_id
  Type: integer | null
  required
  
  Integer numbers.
- program_id
  Type: integer | null
  required
  
  Integer numbers.
- tenant_id
  Type: integer | null
  required
  
  Integer numbers.
- updated_at
  Type: string | nullFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
waiver_assignments
Type: array object[]
- created_at
  Type: string | nullFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- deleted_at
  Type: string | nullFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- id
  Type: integer
  required
  
  Integer numbers.
- membership_type_id
  Type: integer | null
  required
  
  Integer numbers.
- parent_program_id
  Type: integer | null
  required
  
  Integer numbers.
- program_id
  Type: integer | null
  required
  
  Integer numbers.
- tenant_id
  Type: integer | null
  required
  
  Integer numbers.
- updated_at
  Type: string | nullFormat: date-time
  required
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- volunteer_opportunity_id
  Type: integer | null
  required
  
  Integer numbers.
- waiver_id
  Type: integer
  required
  
  Integer numbers.