Detalhe de uma assinatura (gestão pela equipe)
GET/api/manage/subscriptions/{subscriptionId}
- 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.
Owner, admin ou finance. Os campos da listagem, mais `charges` (histórico de cobranças: data, período, valor, status, pago/falhou, motivo, forma de pagamento, parcelas e `purchaseId`, a compra da cobrança, para reembolsá-la em `POST /api/manage/purchases/{purchaseId}/refunds`), `events` (linha do tempo, mais nova primeiro: `CREATED`, `CHARGE_PAID`, `CHARGE_FAILED`, `CANCELED`, `ENDED`, `TEAM_ACTION` com `action`, `actor`, `before` e `after` e `PAST_DUE` (entrou em atraso), `RECOVERED` (pagamento regularizado) e `EXPIRED` (expirou em atraso), cada um com `reason`: `no_card` (sem cartão), `card_expired` (cartão vencido), `card_declined` (cartão recusado), `retries_exhausted` (tentativas esgotadas), `provider` (processador), `paid` (pago) ou `staff` (equipe)) e `addOnSubscriptions`. `pastDueSince` (também na listagem): desde quando está `PAST_DUE`, `null` fora do atraso. Assinatura de outra comunidade: 404.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
subscriptionIdobligatoire | path | string (uuid) |
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 | Detalhe. |
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. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
Exemple curl
curl -X GET "https://api.memberfy.net/api/manage/subscriptions/<subscriptionId>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"