Pular para o conteúdo
memberfy
pt-br

Cria uma oferta de downsell para um adicional do plano

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

Auth
Exige token
Quem pode:
owner
admin
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

F-39. Owner ou admin. Recusas 400 com `errors[].param`: `productId` (fora da lista do plano ou não vendido junto), `discountPercent` (fora de (0, 100)), `timing` (já existe uma IMMEDIATE ativa para o mesmo adicional), `delayMinutes` (ausente em DELAYED, ou fora de 60 min a 90 dias), `priceCycles` (ausente em CYCLES, ou fora de 2 a 36), `ttlMinutes` (fora de 1 h a 30 dias).

Parâmetros

NomeOndeTipoDescrição
groupIdobrigatóriopathstring

Headers

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

Corpo da requisição application/json

NomeTipoDescrição
productIdobrigatóriostring (uuid)Adicional da lista do plano, vendido junto (SUBSCRIPTION MONTHLY)
discountPercentopcionalnumberMaior que 0 e menor que 100, até 2 casas. Padrão 10
timingobrigatórioIMMEDIATE | DELAYED
delayMinutesopcionalintegerSó em DELAYED: de 60 a 129600 (90 dias)
priceDurationopcionalFOREVER | FIRST_CHARGE | CYCLESPadrão FOREVER
priceCyclesopcionalintegerSó em CYCLES: de 2 a 36 cobranças
ttlMinutesopcionalintegerDe 60 a 43200. Padrão 2880 (48 h)
isActiveopcionalboolean

Respostas

CódigoDescrição
201Oferta criada.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Exemplo com curl

curl -X POST "https://api.memberfy.net/api/subscription-groups/<groupId>/downsell-offers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"productId":"00000000-0000-0000-0000-000000000000","timing":"IMMEDIATE"}'