Cota um adicional para o plano em andamento
POST/api/subscriptions/{id}/add-ons/quote
- Auth
- Jeton requis
- Clé d’API:
- Clé d’API non acceptée
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
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. **Empresa:** o admin da empresa com vínculo vivo age como o assinante na assinatura da empresa (`companyId` na resposta); funcionário da empresa que não é admin recebe 403 (`monetization.company.adminOnly`); quem não tem relação com ela, 404.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
idobligatoire | path | string (uuid) |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (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
| Nom | Type | Description |
|---|---|---|
productIdobligatoire | string (uuid) | O adicional |
Réponses
| Statut | Description |
|---|---|
200 | Operação realizada com sucesso. |
400 | Requisição inválida — falha de validação. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
Exemple curl
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"}'