Guia de Assinaturas

Confira o guia de assinaturas para mais informações.

Endpoint responsável por criar uma assinatura cuja forma de pagamento é cartão de crédito, permitindo validar o cartão informado durante a criação e utilizá-lo nas cobranças recorrentes da assinatura.

Durante a criação, o cartão é validado, mas a primeira cobrança será realizada apenas na data definida em nextDueDate, salvo quando essa data corresponder ao dia atual.

Este endpoint aceita tanto o envio dos dados completos do cartão quanto a utilização de um token previamente gerado.

Quando utilizar

Utilize este endpoint quando sua integração precisar:

• criar assinaturas recorrentes pagas por cartão de crédito;
• validar o cartão do cliente no momento da contratação;
• armazenar um cartão tokenizado para cobranças futuras;
• iniciar um período de trial mantendo o cartão previamente validado;
• automatizar cobranças recorrentes sem solicitar novamente os dados do cartão a cada ciclo.

Caso sua integração já utilize tokenização, recomenda-se informar apenas creditCardToken, sem enviar novamente os dados completos do cartão.

Parâmetros importantes

Além dos campos gerais da assinatura, alguns parâmetros possuem impacto direto no funcionamento da recorrência:

• creditCard — dados do cartão utilizados para validação inicial.
• creditCardHolderInfo — informações do titular do cartão.
• creditCardToken — token previamente gerado. Quando informado, substitui os objetos creditCard e creditCardHolderInfo.
• remoteIp — IP real do dispositivo do pagador. Não utilize o IP do seu servidor.
• nextDueDate — define quando ocorrerá a primeira cobrança da assinatura.

Comportamentos importantes

Ao criar uma assinatura utilizando cartão de crédito, considere que:

• o cartão é validado durante a criação da assinatura;
• a validação não garante que a cobrança futura será aprovada;
• o cartão pode perder validade antes da data da cobrança por cancelamento, expiração, bloqueio ou insuficiência de limite;
• novas cobranças utilizarão o mesmo cartão enquanto a assinatura permanecer ativa.

Caso nextDueDate seja a data atual, a primeira cobrança poderá ocorrer imediatamente.

Boas práticas

Tokenização de cartão de crédito

Sempre que possível, recomenda-se utilizar a tokenização de cartão de crédito.

Com ela, sua aplicação deixa de transmitir os dados completos do cartão em novas operações, utilizando apenas o identificador (creditCardToken) retornado anteriormente.

Para utilizar essa funcionalidade, siga as instruções da documentação de Criar cobrança com cartão de crédito.

Conteúdos relacionados

• Guia de Assinaturas
• Criar cobrança com cartão de crédito
• Atualizar cartão de crédito da assinatura
• Webhooks de cobrança e webhooks de assinaturas.