Reference

Listar planos de sócio

Devolve os planos de sócio (os produtos de quota periódica), ordenados por id. Os planos sem clube são sempre incluídos. Sem updated_since devolve todos (sincronização inicial); com updated_since só os alterados desde essa data. Requer o plano Enterprise e o scope catalog:read.

get/v1/membership-plans

Request

  • Base URL: https://api-public.mvf.pt
  • URL: https://api-public.mvf.pt/v1/membership-plans
  • Auth: HTTP bearer

Query parameters

club_idstring
Example:clb_1

Só os registos deste clube. Tem de ser um clube a que a API key tem acesso. Em /v1/staff e /v1/membership-plans, os registos sem clube (comuns a todos os clubes) são sempre incluídos.

updated_sincestring date-time
Example:2026-10-07T00:00:00Z

Só os registos alterados depois desta data (ISO 8601). Um valor sem fuso horário (ex: 2026-10-07T08:00:00) e uma data sem hora (ex: 2026-10-07) são interpretados como UTC. Recomendamos enviar sempre em UTC com Z (ex: 2026-10-07T08:00:00Z). Usa a hora de início da sincronização anterior menos uma margem de segurança (ver Sincronização de dados).

limitinteger

Número máximo de registos por página.

cursorstring

O next_cursor da página anterior.

Response

Uma página de planos de sócio.

Example response

{
  "data": [
    {
      "id": "prd_86",
      "name": "Mensalidade Ginásio",
      "product_group_id": "grp_-4",
      "active": true,
      "club_id": null,
      "updated_at": "2026-10-08T08:00:00.000Z"
    }
  ],
  "pagination": {
    "next_cursor": "eyJhZnRlciI6MTAwfQ"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.