Aller au contenu
memberfy
FR

Atualiza subscriptions

PUT/api/subscription-groups/{id}

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
SuperAdmin
Clé d’API:
store: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.

Exige owner, admin ou SuperAdmin. A comunidade é a do X-CommunityId. Grupo de outra comunidade responde 404. productIds, quando enviado, substitui a lista inteira. slug só muda quando enviado: renomear o plano não altera o endereço. slug já usado por outro plano da comunidade, ativo ou não, responde 400 com param slug. visibility (public ou link_only) muda quando enviado. productIds que remove deste plano uma opção de cobrança que não está em nenhum outro plano responde 400 com param productIds e o nome das opções na mensagem (toda opção de cobrança pertence a um plano).

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.

Corps de la requête application/json

NomTypeDescription
namefacultatifstring
slugfacultatifstringEndereço do plano nos links públicos. Só muda quando enviado; renomear o plano não o altera. Único na comunidade. · max 60
descriptionfacultatifstring
sortOrderfacultatifinteger
metadatafacultatifobject
isActivefacultatifboolean
visibilityfacultatifpublic | link_only`public` (padrão) ou `link_only` (Somente com link).
monthlyCreditsfacultatifintegerCréditos que cada assinatura viva (ACTIVE ou TRIALING) do plano recebe por mês de calendário, válidos até a virada do mês no fuso da comunidade (plano anual também concede por mês). Concedido pelo reconciliador horário e na ativação, uma vez por mês; troca de plano concede só a diferença positiva; PAST_DUE e PAUSED não recebem; cancelamento imediato ou reembolso revoga o que não foi usado. Valor acima de 0 exige um space de Reservas ou de Agendamento na comunidade, senão 403 (`param = monthlyCredits`); inteiro fora de 0 a 10000: 400. Padrão 0. A resposta do plano traz `monthlyCredits`. · ≥ 0, ≤ 10000
productIdsfacultatif—[]productIds must be an array
productIds.*facultatifstring (uuid)Each productId must be a valid UUID
addOnProductIdsfacultatifstring (uuid)[]Adicionais do plano. Substitui a lista inteira do plano; omitido mantém, [] limpa. Mesmas recusas do POST (400, param addOnProductIds). Remover da lista um produto que tem assinatura viva de quem assina este plano responde 409 (param addOnProductIds): o cancelamento em cascata a encerraria na hora. Encerre essas assinaturas antes, ou desative a venda do produto.
includedProductIdsfacultatifstring (uuid)[]Produtos que o plano inclui sem custo extra (curso, evento, digital...). Quem tem assinatura ativa do plano tem o produto, sem comprá-lo. Substitui a lista; omitido mantém, [] limpa. Produto de outra comunidade, excluído ou opção de plano: 400 com param includedProductIds. A resposta do plano traz includedProductIds. Também se configura pelo produto (includedInPlanIds).

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.
409Conflito com o estado atual do recurso.
500Erro interno do servidor.

Exemple curl

curl -X PUT "https://api.memberfy.net/api/subscription-groups/<id>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'