Aller au contenu

Lista subscriptions

GET/api/subscriptions

Auth
Jeton requis
Clé d’API:
sales:read
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Cada assinatura traz `commitmentEndsAt` (fim do contrato vigente, ou `null` sem contrato) e `cancelEffectiveAt` (quando um cancelamento agendado de fato encerra a assinatura, ou `null`), e `product.commitmentMonths`. `billedWithId` é a assinatura do plano com que um adicional é cobrado (o adicional não traz os campos abaixo); nas outras, `billedWithId = null`, `addOns` (os adicionais cobrados junto: `id`, `productId`, `title`, `status`, `billingAmount`, `canceledAt`, `renewsWithPlan`) e `nextChargeTotal` (o plano mais os adicionais que renovam com ele, sem a taxa paga pelo comprador; `null` sem próxima cobrança). `pendingRenewal`: a cobrança de renovação em aberto que a assinatura espera — o PIX ou boleto gerado antes do vencimento, o de "Pagar agora", ou um cartão em análise — ou `null`. Forma: `{ purchaseId, paymentMethod, amount, dueDate, pixCode, qrCode, boletoUrl, boletoBarcode }`. `amount` é o total do pedido (plano e adicionais), o que o membro paga. `pixCode` (copia e cola), `qrCode` (URL da imagem), `boletoUrl`, `boletoBarcode` (linha digitável) e `dueDate` (validade do PIX ou vencimento do boleto) vêm do pedido no provedor de pagamento e são `null` no cartão ou quando o provedor não responde. Sempre `null` num adicional ligado: a cobrança aparece no plano. Cada assinatura traz `companyId`: a empresa que paga, ou `null`. Com `?companyId=` a lista é a das assinaturas da empresa (aba "Cobrança" de "Minha empresa"), só para o admin da empresa com vínculo vivo; qualquer outra pessoa recebe 403 (`param = companyId`), exista a empresa ou não. Sem o parâmetro, só as da pessoa.

Paramètres

NomEmplacementTypeDescription
companyIdfacultatifquerystring (uuid)Lista as assinaturas da empresa (admin da empresa).

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Réponses

StatutDescription
200Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Exemple curl

curl -X GET "https://api.memberfy.net/api/subscriptions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"