Pedido de Assinatura

Crie uma Assinatura

A criação de uma assinatura é a etapa inicial e essencial para habilitar cobranças recorrentes e automatizadas para seus clientes. Ao registrar uma assinatura, você estabelece um fluxo contínuo de pagamentos, garantindo um relacionamento financeiro eficiente e duradouro.

Ao configurar uma assinatura, você utilizará o criar assinatura. É possível definir assinaturas baseadas em planos ou optar por assinaturas avulsas, sem uma data final de ciclo, conforme a necessidade do usuário.

📘

Assinaturas Avulsas

Assinaturas avulsas não possuem um plano associado. Seus itens são descritos diretamente na pedido de assinatura, assim como o intervalo de recorrência e o meio de pagamento. Vale ressaltar que uma assinatura avulsa não possui um final de ciclo definido, proporcionando flexibilidade contínua até que seja cancelada.

📘

Meios de pagamento disponíveis

Aqui você pode saber mais sobre os meios de pagamento disponíveis e suas características.

Após a criação da assinatura, você receberá um subscription_id, que é um identificador único da assinatura. Todas as mudanças no status da assinatura serão notificadas via webhook, conforme o cadastro que você realizou anteriormente.

🚧

Alterações na Assinatura

Você poderá realizar alterações em uma assinatura enquanto ela estiver ativa, mantendo o mesmo subscription_id e realizando as alterações através dele.

Assim, será possível efetuar mudanças como substituição do meio de pagamento, inclusão e modificação de itens no caso de assinaturas avulsas, ou ajuste na data de faturamento, entre outras.

Forneça os Campos Necessários

É essencial fornecer informações relacionadas ao cliente, incluindo o objeto customer, que identifica o cliente dentro do sistema Zapay. Adicionalmente, inclua o meio de pagamento desejado, podendo ser credit_card ou tokenized_credit_card.

📘

Campos Opcionais

A inclusão de certos campos não é estritamente obrigatória ao criar um pedido de pagamento. No entanto, ao fornecer essas informações, é possível aprimorar a experiência do usuário no processo de pagamento. Recomenda-se prestar atenção especial aos campos obrigatórios caso opte por incluir esses detalhes.

Eventos Disponíveis para uma Assinatura

Possuímos uma lista de eventos significativos que podem ocorrer em nossa API em relação às assinaturas. Confira abaixo:

EventoDescrição
subscription.createdOcorre sempre que uma assinatura é criada.
subscription.updatedOcorre sempre que uma assinatura é atualizada.
subscription.paidOcorre sempre que uma assinatura é efetivamente paga.
subscription.canceledOcorre sempre que uma assinatura é cancelada.

Eventos Disponíveis para Itens de Assinatura

Além dos eventos gerais de assinatura, também há eventos específicos para os itens dentro de uma assinatura avulsa. Confira abaixo:

EventoDescrição
subscription.item.createdOcorre sempre que um novo item é adicionado a uma assinatura.
subscription.item.updatedOcorre sempre que um item de uma assinatura é atualizado.
subscription.item.canceledOcorre sempre que um item de uma assinatura é cancelado.

Status de uma Assinatura

O ciclo de vida de uma assinatura compreende várias etapas, com diferentes status associados a ela. Esses status proporcionam uma visão clara de uma assinatura, desde sua criação até a conclusão ou eventual cancelamento, refletindo as diversas situações e estados possíveis ao longo do processo. A assinatura é ativada após a confirmação do pagamento da primeira fatura e se mantém ativa até a próxima cobrança. Caso o pagamento não seja realizado, a assinatura pode ser inativada e, após tentativas de cobrança, ser encerrada automaticamente.

StatusDescrição
activeA assinatura está ativa após a confirmação do pagamento da primeira fatura e se mantém ativa até a próxima cobrança.
inactiveA assinatura foi inativada devido ao não pagamento e está em processo de encerramento após tentativas de cobrança.

🚧

Atenção

Independentemente do status, é importante lembrar que uma assinatura sempre gera pelo menos uma cobrança.

Explore detalhadamente as assinaturas por meio de nossa API Reference!