Antes de começar
Certifique-se de ter:Credenciais da API
Credenciais de API e token de acesso válidos para autenticação.
Configuração da conta
Configuração adequada da conta para o país de destino e verificação da empresa.
Lista branca de IPs
Adicione os endereços IP do seu servidor à lista de permissões para acesso à API.
Endpoint do webhook
Configure um URL de webhook para receber notificações de pagamento.
Passo 1: Atualizar um plano de assinatura
Para modificar um plano de assinatura existente, envie uma requisiçãoPATCH para o endpoint Update Subscription Plan.
Parâmetros-chave da solicitação
A solicitação requer vários parâmetros-chave:Frequências de faturamento suportadas
Diário
Atualização para faturamento diário. Ideal para serviços que estão migrando para padrões de uso diário.Envie a propriedade
autoRecurring.type com o valor: dayMensal
Atualização para faturamento mensal. Prática comum para padronizar os ciclos de faturamento entre as linhas de produtos.Envie a propriedade
autoRecurring.type com o valor: monthPersonalizado (sob demanda)
Atualização para faturamento sob demanda. Ideal para a transição para modelos de precificação baseados no uso.Envie a propriedade
autoRecurring.type com o valor: customExemplo de solicitação
Abaixo está um exemplo usandocurl:
curl
Etapa 2: Lidar com a resposta
Resposta bem-sucedida
Um plano de assinatura atualizado com sucesso retorna uma confirmação com o status atual:Campos de resposta principais
Resposta de erro
Quando uma atualização do plano de assinatura falhar, você receberá informações detalhadas sobre o erro:Etapa 3: Rastrear o status da transação
Após atualizar um plano de assinatura, monitore o status dele por meio destes métodos:Webhooks (Recomendado)
Receba notificações em tempo real quando o status da transação mudar. Ideal para ambientes de produção.
Endpoint da API de Status
Consultar o status da transação programaticamente. Útil para consultar ou recuperar notificações de webhook perdidas.
Visualização do Business Portal
Interface visual para monitoramento de transações. Ideal para supervisão manual e análise detalhada de transações.
Códigos de status comuns
Referência completaConsulte todos os códigos de status em nossa Documentação de Status da Transação.
Testando sua integração
Cenários de teste
Verifique se sua integração lida com esses cenários:- Atualização de valor concluída com sucesso: Modifique o preço do plano com valores válidos.
- Alteração da frequência de faturamento: Atualize de faturamento mensal para diário ou personalizado.
- Atualizações parciais: Modifique apenas campos específicos sem enviar a carga útil completa.
- Erros de validação: Teste com valores inválidos, campos obrigatórios ausentes ou frequências não suportadas.
- Plano inexistente: Tentativa de atualizar um plano que não existe.
- Falhas de autenticação: Teste com tokens de acesso inválidos ou expirados.
Próximos passos
Após atualizar um plano de assinatura, talvez seja necessário realizar ações adicionais:Criar um novo plano de assinatura
Configure planos de assinatura adicionais para diferentes faixas de preço ou níveis de serviço.
Criar assinatura com plano atualizado
Crie novas assinaturas usando seu plano atualizado para testar as alterações.
Confira os detalhes do plano de assinatura
Recupere as informações atualizadas do plano para verificar se todas as alterações foram aplicadas corretamente.

