Aller au contenu

Consulta a troca de plano agendada

GET/api/subscriptions/{id}/scheduled-change

Auth
Jeton requis
Clé d’API:
sales:read
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.

A troca de plano que espera o fim do período. O assinante, ou owner/admin da comunidade do X-CommunityId (e SuperAdmin); assinatura de outra pessoa ou de outra comunidade responde 404. Sem troca agendada, 404 (`noScheduledChange`). `data`: `changeType` (`UPGRADE`, `DOWNGRADE`, `SAME_PRICE` ou `INTERVAL_CHANGE`), `currentProduct` e `newProduct` (`id`, `title`, `price`, `billingInterval`), `effectiveDate` (quando a troca vale: a renovação em que a cobrança já vem no preço novo), `scheduledAt` e `scheduledById` (o perfil que agendou), `addOns` (os adicionais que entram com a troca, `productId`, `title`, `amount` por período; `[]` sem nenhum). O mesmo objeto vem em `scheduledChange` de `GET /api/subscriptions`, `GET /api/subscriptions/{id}` e `GET /api/subscriptions/me` (ou `null`). **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

NomEmplacementTypeDescription
idobligatoirepathstring

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.

Réponses

StatutDescription
200Operação realizada com sucesso.
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 GET "https://api.memberfy.net/api/subscriptions/<id>/scheduled-change" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"