Aller au contenu

Lista ou consulta me

GET/api/subscriptions/me

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.

Traz `commitmentEndsAt`, `cancelEffectiveAt` e `product.commitmentMonths`. Um adicional cobrado junto com um plano (`billedWithId`) nunca é a assinatura devolvida aqui; o plano é. A resposta traz `billedWithId`, `addOns` e `nextChargeTotal` (ver `GET /api/subscriptions`). Traz também `pendingRenewal`, a cobrança de renovação em aberto, ou `null` (ver `GET /api/subscriptions`): é o que a tela de "Pagar agora" e o PIX de renovação mostram.

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`).
404Recurso não encontrado.
500Erro interno do servidor.

Exemple curl

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