Saltar al contenido

Cria uma oferta de downsell para um adicional do plano

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

Auth
Requiere token
Quién puede:
owner
admin
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. 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

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.

Cuerpo de la solicitud application/json

NombreTipoDescripción
productIdobligatoriostring (uuid)Adicional da lista do plano, vendido junto (SUBSCRIPTION MONTHLY)
discountPercentopcionalnumberMaior que 0 e menor que 100, até 2 casas. Padrão 10
timingobligatorioIMMEDIATE | 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

Respuestas

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

Ejemplo con 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"}'