El objeto de plan de membresía

Atributos

• membership_plan_id string obligatorio

  Identificador único del plan de membresía.

• facility_id string uno u otroIndica el tipo de identificador de instalación configurado para tu integración: usa facility_id en las integraciones de vinculación directa o linking_identifier en las integraciones con identificador de vinculación. No envíes ambos; la API usa el tipo de identificador configurado para tu cuenta de socio e ignora el otro. Más información

  Identificador único de la instalación en el Performance Hub.

• linking_identifier string uno u otroIndica el tipo de identificador de instalación configurado para tu integración: usa facility_id en las integraciones de vinculación directa o linking_identifier en las integraciones con identificador de vinculación. No envíes ambos; la API usa el tipo de identificador configurado para tu cuenta de socio e ignora el otro. Más información

  Valor del identificador único que el socio usa para cada ubicación (por ejemplo, "Branch ID", "Location Code" o "Store Number"). Más información

• name string obligatorio

  Nombre legible del plan (por ejemplo, "Office tenant – business hours", "Student – term access", "Hotel guest" o "10 Class Pack").

• billing_cycle string opcional

  Frecuencia de facturación. Uno de estos valores: weekly, fortnightly, monthly, annually o one_time.

• price integer opcional

  Costo base en la unidad monetaria más pequeña (centavos para USD/AUD).

• currency string opcional

  Código de moneda ISO 4217 (por ejemplo, "AUD" o "USD").

• description string opcional

  Descripción comercial o interna opcional.

• active_members integer opcional

  Número de miembros activos que usan este plan de membresía

• is_recurring boolean opcional

  Indica si el plan se renueva automáticamente.

• is_trial boolean opcional

  Indica si se trata de una oferta de prueba.

• visible_to_public boolean opcional

  Indica si el plan está disponible para comprarse mediante autoservicio.

• duration_days integer opcional

  Número de días durante los que es válido el plan de membresía.

• access_zones array opcional

  Matriz de zonas de acceso incluidas en el plan de membresía. Cada zona puede definir sus propios horarios de acceso. Consulta Zonas de acceso para obtener más detalles.

• class_limit integer opcional

  Número máximo de clases permitidas (null para ilimitadas).

El objeto de plan de membresía

Este ejemplo usa facility_id. En una integración con identificador de vinculación, envía "linking_identifier": "branch_downtown" en su lugar.

{
  "membership_plan_id": "plan_99999",
  "facility_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Office tenant – business hours",
  "description": "Weekday access to the level 3 tenancy and the end-of-trip facilities",
  "billing_cycle": "monthly",
  "price": 8900,
  "currency": "AUD",
  "duration_days": 30,
  "is_recurring": true,
  "is_trial": false,
  "visible_to_public": false,
  "active_members": 245,
  "access_zones": [
    {
      "name": "Level 3 Tenancy",
      "description": "Lift lobby, offices and meeting rooms on level 3",
      "access_hours": {
        "mon": [["07:00", "19:00"]],
        "tue": [["07:00", "19:00"]],
        "wed": [["07:00", "19:00"]],
        "thu": [["07:00", "19:00"]],
        "fri": [["07:00", "19:00"]]
      }
    },
    {
      "name": "End-of-trip Facilities",
      "description": "Bike storage, lockers and showers",
      "access_hours": {
        "mon": [["06:00", "20:00"]],
        "tue": [["06:00", "20:00"]],
        "wed": [["06:00", "20:00"]],
        "thu": [["06:00", "20:00"]],
        "fri": [["06:00", "20:00"]]
      }
    }
  ],
  "class_limit": null
}