Skip to content

Cota um adicional para o plano em andamento

POST/api/subscriptions/{id}/add-ons/quote

Auth
Requires a token
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-37. Sem efeito: diz quanto custa somar um adicional ao plano que o membro já assina. `:id` é a assinatura do plano (a âncora), do próprio membro, na comunidade do X-CommunityId; de outra pessoa ou de outra comunidade responde 404. O adicional precisa estar na lista de adicionais do plano e ser `SUBSCRIPTION` `MONTHLY` à venda; já assinado (ACTIVE, TRIALING, PAST_DUE ou PAUSED) responde 400. A âncora precisa estar ACTIVE, sem cancelamento agendado e com próxima cobrança; assinatura que já é adicional de outra responde 400 (`param = id`). `periodAmount` é o valor do adicional por período do plano (o mensal, ou 12 × o mensal no anual). `prorataAmount` é o proporcional até `nextChargeDate`; com menos de 3 dias ou menos de R$ 10, `floorApplied = true` e `amountDueNow = 0`: o adicional começa já e entra cheio na próxima cobrança. `amountToCharge` soma a taxa da plataforma quando o comprador a paga (`feePayer = BUYER`); é uma cobrança separada, com taxa percentual e fixa. `maxInstallments` é o teto de parcelas no cartão (meses restantes no anual, limitado ao da opção do plano; 1 no mensal). `nextChargeTotal` é o total da próxima cobrança conjunta já com o adicional.

Parameters

NameInTypeDescription
idrequiredpathstring (uuid)

Headers

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

Request body application/json

NameTypeDescription
productIdrequiredstring (uuid)O adicional

Responses

StatusDescription
200Operação realizada com sucesso.
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.

curl example

curl -X POST "https://api.memberfy.net/api/subscriptions/<id>/add-ons/quote" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"productId":"00000000-0000-0000-0000-000000000000"}'