PayZu GatewayRecorrência

Alterar a carência


Nesta páginaConsulte a carênciaAltere a carênciaQuando o prazo novo valeErros desta operação

Leia a carência da conta e grave um prazo novo para as próximas faturas de ciclo de todas as assinaturas. O que a carência faz com a assinatura está em Carência.

Consulte a carência

bash
curl https://api.sandbox.payzu.dev/v1/settings \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

Referência: Consultar as configurações

CampoO que traz
grace_daysA carência da conta, em dias depois do vencimento da fatura do ciclo.
refund_cancels_subscriptionSe o estorno de uma fatura de assinatura cancela a assinatura quando o pedido de estorno não diz. A API só lê este campo.

Altere a carência

bash
curl -X PATCH https://api.sandbox.payzu.dev/v1/settings \
  -H "Authorization: Bearer SUA_CHAVE_DE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "grace_days": 3
  }'

Referência: Alterar as configurações

A resposta 200 traz as configurações gravadas, no formato da consulta.

CampoRegra
grace_daysInteiro de 0 a 30, e o único campo aceito. Outro campo, valor fora da faixa ou corpo vazio respondem 400.

Quando o prazo novo vale

  • Faturas criadas depois: recebem o prazo novo, com billing.expires_at no billing.due_at mais o grace_days gravado.
  • Faturas que já existem: mantêm o billing.expires_at que tinham, e a assinatura em carência mantém o grace.ends_at.
  • Adesão e fatura avulsa: não usam grace_days. A fatura da adesão vence 1 hora depois de criada, e a avulsa tem o próprio billing.expires_at.

Com 0, a fatura do ciclo expira no próprio vencimento.

Sem pagamento até billing.due_at, a fatura passa a expired e a assinatura é cancelada, no Pix e no cartão. Na assinatura no cartão, a cobrança do ciclo sem desfecho ainda segura a fatura por até 48 horas, como em Carência.

Erros desta operação

CódigoHTTPMensagem
PZ034404Recorrência não ativada para esta conta.

Os erros de autenticação, de idempotência e de validação estão no Catálogo de erros.