Get summary of canceled MemberMemberships

Permite obter resumo de contratos de alunos cancelados.

Obter Contratos de Membros

Descrição

Permite obter uma lista de contratos de membros com base em vários critérios de filtragem, incluindo períodos de registro e cancelamento, tipos de contratos e categorias.

Parâmetros de Consulta (Query Parameters)

ParâmetroTipoObrigatórioDescrição
idMemberint32NãoID do membro para filtrar os contratos.
idMembershipint32NãoID do tipo de contrato para filtrar os resultados.
memberNamestringNãoNome do membro para filtrar os contratos.
registerDateStartdate-timeNãoData inicial do registro no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
registerDateEnddate-timeNãoData final do registro no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
cancelDateStartdate-timeNãoData inicial de cancelamento no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
cancelDateEnddate-timeNãoData final de cancelamento no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
showTransfersbooleanNãoFiltra para mostrar contratos transferidos. Valor padrão é false.
showAggregatorsbooleanNãoFiltra para mostrar contratos agregadores. Valor padrão é false.
showVipsbooleanNãoFiltra para mostrar contratos de categoria VIP. Valor padrão é false.
contractTypestringNãoFiltra pelos tipos de contrato, separados por vírgula. Consulte a tabela de tipos abaixo.
takeint32NãoNúmero total de registros a serem retornados. Valor padrão é 25. Máximo permitido: 25.
skipint32NãoNúmero total de registros a serem ignorados (para paginação). Valor padrão é 0.

Tipos de Contrato

CódigoDescrição
1Comum
3Extensão de Plano
4Extensão de Bloqueio
5Mensal Recorrente
6Recorrente Mensal com Validade
7Mensal Recorrente com Renovação Automática
8Dependente Adicional
9Anual com Data de Término Específica
10Contrato Adicional

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!