Lista as ofertas de downsell do plano, com métricas
GET/api/subscription-groups/{groupId}/downsell-offers
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- SuperAdmin
- Clé d’API:
- store:read
- X-CommunityId
X-CommunityIdEnvoyez 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.
Owner ou admin da comunidade do `X-CommunityId` (e SuperAdmin); plano de outra comunidade responde 404. Cada oferta traz `stats`: `shown` (exibições vistas na tela), `delivered` (disponibilizadas), `accepted` (aceites pagos), `declined`, `expired`, `conversionRate` (aceites / disponibilizadas), `revenueFirstCharge` e `netFirstCharge` (o 1º pagamento, bruto e líquido da comunidade), `revenueTotal` e `netTotal` (com as renovações da assinatura nascida da oferta). Nunca custo do provedor.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
groupIdobligatoire | path | string |
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 | Ofertas do plano. |
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/subscription-groups/<groupId>/downsell-offers" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"