Saltar al contenido

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

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

Auth
Requiere token
Quién puede:
owner
admin
SuperAdmin
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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.

Parámetros

NombreDóndeTipoDescripción
groupIdobligatoriopathstring

Headers

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

Respuestas

CódigoDescripción
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.

Ejemplo con curl

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