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
    • 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.

    • path
      Type: array
      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

  • membership_type
    Type: object
    • base_membership_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 | 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: integer
      required

      Integer numbers.

    • forced_bundle_with_base
      Type: boolean
      required
    • 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
      required
    • pre_expiration_leadup
      Type: integer
      required

      Integer numbers.

    • product_id
      Type: string | null
      required
    • renewal_notifications
      Type: integer
      required

      Integer numbers.

    • renewal_notifications_post_expiration
      Type: integer
      required

      Integer numbers.

    • renewal_notifications_post_expiration_days
      Type: integer | null
      required

      Integer numbers.

    • renewal_notifications_pre_expiration
      Type: integer
      required

      Integer numbers.

    • renewal_notifications_pre_expiration_days
      Type: integer | null
      required

      Integer numbers.

    • sort_order
      Type: integer
      required

      Integer numbers.

    • status
      Type: string
      required
    • tenant_id
      Type: integer
      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

    • user_auto_renewals
      Type: boolean
      required
    • visibility_requires_base_membership
      Type: boolean
      required
    • waivers
      Type: array
      required
  • user_in_boundary
    Type: string