Membership

MemberMembership pydantic-model

Bases: OtfItemBase

A member's OrangeTheory membership plan, including billing and expiration details.

Show JSON schema:

{
  "description": "A member's OrangeTheory membership plan, including billing and expiration details.",
  "properties": {
    "paymentDate": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Next scheduled payment date.",
      "title": "Paymentdate"
    },
    "activeDate": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Date the membership became active.",
      "title": "Activedate"
    },
    "expirationDate": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Date the membership expires.",
      "title": "Expirationdate"
    },
    "current": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Whether this is the member's current active membership.",
      "title": "Current"
    },
    "count": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Total number of sessions included in the membership.",
      "title": "Count"
    },
    "remaining": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Number of sessions remaining.",
      "title": "Remaining"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Name of the membership plan.",
      "title": "Name"
    },
    "updatedDate": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "When the membership record was last updated.",
      "title": "Updateddate"
    },
    "createdDate": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "When the membership record was created.",
      "title": "Createddate"
    },
    "isDeleted": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Whether the membership has been deleted.",
      "title": "Isdeleted"
    },
    "memberMembershipId": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Membermembershipid"
    },
    "memberMembershipUUId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Membermembershipuuid"
    },
    "membershipId": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Membershipid"
    },
    "memberId": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Memberid"
    },
    "mboDescriptionId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Mbodescriptionid"
    },
    "createdBy": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Createdby"
    },
    "updatedBy": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Updatedby"
    }
  },
  "title": "MemberMembership",
  "type": "object"
}

Fields:

• payment_date (datetime | None)
• active_date (datetime | None)
• expiration_date (datetime | None)
• current (bool | None)
• count (int | None)
• remaining (int | None)
• name (str | None)
• updated_date (datetime | None)
• created_date (datetime | None)
• is_deleted (bool | None)
• member_membership_id (int | None)
• member_membership_uuid (str | None)
• membership_id (int | None)
• member_id (int | None)
• mbo_description_id (str | None)
• created_by (str | None)
• updated_by (str | None)

payment_date pydantic-field

payment_date = None

Next scheduled payment date.

active_date pydantic-field

active_date = None

Date the membership became active.

expiration_date pydantic-field

expiration_date = None

Date the membership expires.

current pydantic-field

current = None

Whether this is the member's current active membership.

count pydantic-field

count = None

Total number of sessions included in the membership.

remaining pydantic-field

remaining = None

Number of sessions remaining.

name pydantic-field

name = None

Name of the membership plan.

updated_date pydantic-field

updated_date = None

When the membership record was last updated.

created_date pydantic-field

created_date = None

When the membership record was created.

is_deleted pydantic-field

is_deleted = None

Whether the membership has been deleted.