Mindbody · Schema

Membership

Implementation of the 'Membership' model.

FitnessWellnessBeautySchedulingBookingPoint of SaleStudiosSalonsSpasWebhooks

Properties

Name	Type	Description
MembershipId	integer	The membership id.
MembershipName	string	The membership name.
Priority	integer	The priority/sort order.
MemberRetailDiscount	number	The membership discount for retail as a percentage.
MemberServiceDiscount	number	The membership discount for services as a percentage.
AllowClientsToScheduleUnpaid	boolean	Allow clients in this membership to schedule unpaid.
OnlineBookingRestrictedToMembersOnly	array	List of programs that are restricted to clients in this membership only.
DayOfMonthSchedulingOpensForNextMonth	integer	Day of month scheduling opens for next month. Unrestricted is a null value.
RestrictSelfSignInToMembersOnly	boolean	Restrict self sign in to members only.
AllowMembersToBookAppointmentsWithoutPaying	boolean	Allow members to book appointments without paying.
AllowMembersToPurchaseNonMembersServices	boolean	Allow members to purchase non-members services.
AllowMembersToPurchaseNonMembersProducts	boolean	Allow members to purchase non-members products.
IsActive	boolean	Indicates if the membership is active.
EarlyAccessDaysBeforeSchedulingWindow	integer	Number of days before the scheduling window that members with this membership get early access.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mindbody/refs/heads/main/json-schema/public-api-v6-membership-schema.json",
  "title": "Membership",
  "description": "Implementation of the 'Membership' model.",
  "type": "object",
  "properties": {
    "MembershipId": {
      "type": "integer",
      "format": "int32",
      "description": "The membership id.",
      "example": 123456
    },
    "MembershipName": {
      "type": "string",
      "description": "The membership name.",
      "example": "example-value"
    },
    "Priority": {
      "type": "integer",
      "format": "int32",
      "description": "The priority/sort order.",
      "example": 1
    },
    "MemberRetailDiscount": {
      "type": "number",
      "format": "double",
      "description": "The membership discount for retail as a percentage.",
      "example": 1.0
    },
    "MemberServiceDiscount": {
      "type": "number",
      "format": "double",
      "description": "The membership discount for services as a percentage.",
      "example": 1.0
    },
    "AllowClientsToScheduleUnpaid": {
      "type": "boolean",
      "description": "Allow clients in this membership to schedule unpaid.",
      "example": true
    },
    "OnlineBookingRestrictedToMembersOnly": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProgramMembership"
      },
      "description": "List of programs that are restricted to clients in this membership only.",
      "example": [
        {}
      ]
    },
    "DayOfMonthSchedulingOpensForNextMonth": {
      "type": "integer",
      "format": "int32",
      "description": "Day of month scheduling opens for next month. Unrestricted is a null value.",
      "example": 1
    },
    "RestrictSelfSignInToMembersOnly": {
      "type": "boolean",
      "description": "Restrict self sign in to members only.",
      "example": true
    },
    "AllowMembersToBookAppointmentsWithoutPaying": {
      "type": "boolean",
      "description": "Allow members to book appointments without paying.",
      "example": true
    },
    "AllowMembersToPurchaseNonMembersServices": {
      "type": "boolean",
      "description": "Allow members to purchase non-members services.",
      "example": true
    },
    "AllowMembersToPurchaseNonMembersProducts": {
      "type": "boolean",
      "description": "Allow members to purchase non-members products.",
      "example": true
    },
    "IsActive": {
      "type": "boolean",
      "description": "Indicates if the membership is active.",
      "example": true
    },
    "EarlyAccessDaysBeforeSchedulingWindow": {
      "type": "integer",
      "format": "int32",
      "description": "Number of days before the scheduling window that members with this membership get early access.",
      "example": 1
    }
  }
}