Aller au contenu

Aplica um desconto percentual (equipe)

PUT/api/manage/subscriptions/{subscriptionId}/discount

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
finance
Clé d’API:
sales: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, admin ou finance; auditado. `percent` (mais de 0 e menos de 100, até 2 casas) vale a partir da próxima cobrança, até `endsAt` (ou enquanto durar). Usa os campos que toda renovação já aplica; o valor cheio fica em `regularAmount`. Cupom por código não é aplicado por aqui.

Paramètres

NomEmplacementTypeDescription
subscriptionIdobligatoirepathstring (uuid)

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
percentobligatoirenumber
endsAtfacultatifstring (date-time)

Réponses

StatutDescription
200Detalhe depois da ação.
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.
409Assinatura encerrada.
500Erro interno do servidor.

Exemple curl

curl -X PUT "https://api.memberfy.net/api/manage/subscriptions/<subscriptionId>/discount" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"percent":10}'