PayZu GatewayRecorrência
Alterar um plano
Envie só os campos que mudam; a alteração vale para as assinaturas criadas depois dela.
Altere o plano
bash
curl -X PATCH https://api.sandbox.payzu.dev/v1/plans/plan_oOsn4Cs4eayZ3LoytwzErn \
-H "Authorization: Bearer SUA_CHAVE_DE_API" \
-H "Content-Type: application/json" \
-d '{
"description": "Acesso mensal à plataforma e ao suporte"
}'Referência: Alterar um plano
A resposta traz o plano inteiro, no formato da consulta, com o campo alterado e o novo updated_at.
O que muda
| Campo | Regra |
|---|---|
name, description, payment_settings | Aceitos na alteração, com as regras da criação. |
checkout | Só os campos enviados mudam. null num campo apaga o valor dele. |
discount | type e value vão juntos e põem o desconto para valer. Os campos que não vierem ficam como estavam. Sem type e value, os outros campos não põem o desconto para valer. discount: null tira o desconto. |
amount, discount | O valor fica em no mínimo 500 (R$ 5,00), também depois do desconto. A regra é conferida quando o valor ou o desconto mudam. |
metadata | O mapa enviado troca o anterior inteiro. |
status | inactive tira o plano de venda, e active volta a vendê-lo. |
recurrence | Não muda depois da criação. |
Quem já assinou continua com o nome, o valor e a periodicidade da adesão.
Para mudar o valor de quem já assina, veja Alterar uma assinatura.
Erros desta operação
| Código | HTTP | Mensagem |
|---|---|---|
| - | 400 | O desconto fixo deve ser menor que o valor do plano. |
| - | 400 | O valor mínimo é R$ 5,00. |
| - | 400 | O valor com desconto precisa ser de no mínimo R$ 5,00. |
PZ032 | 403 | Cartão não habilitado para esta conta. Fale com o suporte para habilitar ou ofereça apenas Pix. |
PZ033 | 403 | Pix não habilitado para esta conta. Fale com o suporte para habilitar. |
| - | 404 | Plano não encontrado para o id informado |
PZ034 | 404 | Recorrência não ativada para esta conta. |
PZ550 | 409 | Já existe um plano com este slug. |
| - | 422 | Cartão não está disponível para a recorrência deste plano. |
Os três erros de 400 acima trazem o motivo em message, sem fields. Os erros de autenticação, de idempotência e de validação estão no Catálogo de erros.