O objeto Membership Plan

Atributos

• membership_plan_id string obrigatório

  Identificador exclusivo do plano de associação.

• facility_id string um ou outroInforme o tipo de identificador de instalação configurado para sua integração: use facility_id em integrações de vinculação direta ou linking_identifier em integrações com identificador de vinculação. Não envie os dois; a API usa o tipo de identificador configurado para sua conta de parceiro e ignora o outro. Saiba mais

  Identificador exclusivo da instalação no Performance Hub.

• linking_identifier string um ou outroInforme o tipo de identificador de instalação configurado para sua integração: use facility_id em integrações de vinculação direta ou linking_identifier em integrações com identificador de vinculação. Não envie os dois; a API usa o tipo de identificador configurado para sua conta de parceiro e ignora o outro. Saiba mais

  Valor do identificador exclusivo que o parceiro usa para cada local (por exemplo, "Branch ID", "Location Code", "Store Number"). Saiba mais

• name string obrigatório

  Nome legível do plano (por exemplo, "Office tenant – business hours", "Student – term access", "Hotel guest", "10 Class Pack").

• billing_cycle string opcional

  Frequência de cobrança. Um destes: weekly, fortnightly, monthly, annually ou one_time.

• price integer opcional

  Custo base na menor unidade da moeda (centavos para USD/AUD).

• currency string opcional

  Código de moeda ISO 4217 (por exemplo, "AUD", "USD").

• description string opcional

  Descrição opcional de marketing ou interna.

• active_members integer opcional

  Número de membros ativos que usam este plano de associação

• is_recurring boolean opcional

  Indica se o plano é renovado automaticamente.

• is_trial boolean opcional

  Indica se esta é uma oferta de avaliação.

• visible_to_public boolean opcional

  Indica se o plano está disponível para compra por autoatendimento.

• duration_days integer opcional

  Número de dias de validade do plano de associação.

• access_zones array opcional

  Matriz das zonas de acesso incluídas no plano de associação. Cada zona pode definir os próprios horários de acesso. Consulte Zonas de acesso para obter detalhes.

• class_limit integer opcional

  Número máximo de aulas permitidas (null para ilimitado).

O objeto Membership Plan

Este exemplo usa facility_id. Em uma integração com identificador de vinculação, envie "linking_identifier": "branch_downtown" em vez disso.

{
  "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
}