Skip to content

Lista as ofertas de downsell do plano, com métricas

GET/api/subscription-groups/{groupId}/downsell-offers

Auth
Requires a token
Who can call it:
owner
admin
SuperAdmin
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

F-39. 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.

Parameters

NameInTypeDescription
groupIdrequiredpathstring

Headers

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

Responses

StatusDescription
200Ofertas do plano.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

curl example

curl -X GET "https://api.memberfy.net/api/subscription-groups/<groupId>/downsell-offers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"