Lista as assinaturas da comunidade (gestão pela equipe)
GET/api/manage/subscriptions
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- finance
- Clé d’API:
- sales:read
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Exige owner, admin ou finance da comunidade do `X-CommunityId`. Mais novas primeiro. Cada item: `member` (nome, e-mail), `plan` e `product` (opção), `status` e `statusLabel` (`CANCELING` quando vai encerrar no fim do período), `source` (`CHECKOUT` ou `MANUAL`), `isComplimentary` e `complimentaryUntil`, valor (`billingAmount`, `regularAmount`, `discountPercent`, `discountEndsAt`), `addOns` cobrados junto, `nextChargeTotal`, `paymentMethod`, `pendingRenewal` (PIX/boleto em aberto), `commitmentEndsAt`, `nextBillingDate` e o período. Adicionais cobrados com o plano não aparecem como item próprio. Nunca traz custo de provedor. Assinatura de empresa traz `company: { id, name }` e `member` com campos nulos; nas assinaturas de pessoa, `company` é `null`.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
statusfacultatif | query | ACTIVE | TRIALING | PAST_DUE | PAUSED | CANCELING | CANCELED | EXPIRED | COMPLIMENTARY | |
productIdfacultatif | query | string (uuid) | Opção de cobrança |
subscriptionGroupIdfacultatif | query | string (uuid) | Plano |
fromfacultatif | query | string (date-time) | Início da assinatura a partir de |
tofacultatif | query | string (date-time) | Início da assinatura até |
searchfacultatif | query | string | Nome ou e-mail do membro, ou nome da empresa |
pagefacultatif | query | integer | |
limitfacultatif | query | integer |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Réponses
| Statut | Description |
|---|---|
200 | Lista paginada. |
400 | Requisição inválida — falha de validação. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
500 | Erro interno do servidor. |
Exemple curl
curl -X GET "https://api.memberfy.net/api/manage/subscriptions" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"