Aller au contenu

Cria uma oferta de downsell para um adicional do plano

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

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
Clé d’API:
store:write
X-CommunityId
X-CommunityId Envoyez 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. 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).

Paramètres

NomEmplacementTypeDescription
groupIdobligatoirepathstring

En-têtes

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

Corps de la requête application/json

NomTypeDescription
productIdobligatoirestring (uuid)Adicional da lista do plano, vendido junto (SUBSCRIPTION MONTHLY)
discountPercentfacultatifnumberMaior que 0 e menor que 100, até 2 casas. Padrão 10
timingobligatoireIMMEDIATE | DELAYED
delayMinutesfacultatifintegerSó em DELAYED: de 60 a 129600 (90 dias)
priceDurationfacultatifFOREVER | FIRST_CHARGE | CYCLESPadrão FOREVER
priceCyclesfacultatifintegerSó em CYCLES: de 2 a 36 cobranças
ttlMinutesfacultatifintegerDe 60 a 43200. Padrão 2880 (48 h)
isActivefacultatifboolean

Réponses

StatutDescription
201Oferta criada.
400Requisição inválida — falha de validação.
401Token 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`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Exemple 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"}'