Pular para o conteúdo
Criar conta
ou
Entrar
O logotipo da documentação da Stripe
/
Pergunte à IA
Criar conta
Login
Comece já
Pagamentos
Automação de finanças
Plataformas e marketplaces
Gestão de valores
Ferramentas para desenvolvedores
Comece já
Pagamentos
Automação de finanças
Comece já
Pagamentos
Automação de finanças
Plataformas e marketplaces
Gestão de valores
Visão geral
Billing
    Visão geral
    Sobre as APIs do Billing
    Assinaturas
      Visão geral
      Início rápido
      Casos de uso
      Crie sua integração
      Recursos de assinatura
        Faturas de assinatura
        Cronogramas de assinatura
        Preços de assinatura
        Modelos de preço recorrente
        Incorporar uma tabela de preços
        Iniciar assinaturas
        Definir quantidades
        Defina ciclos de faturamento
        Inicie assinaturas com data passada
        Inscrever-se em vários itens
        Definir períodos de avaliação
        Aplicar cupons
        Migrar assinaturas para a Stripe
        Como cobranças proporcionais de crédito são calculadas
        Pagamentos de assinaturas
        Formas de pagamento de assinaturas
        Integrar com processamento de pagamentos externo
        Métodos de cobrança
        Compartilhe um link para atualizar dados de pagamento
        SCA (autenticação forte de cliente)
        Gerenciar assinaturas
        Modifique assinaturas
        Gerencie atualizações pendentes
      Análises
    Invoicing
    Cobrança por uso
    Connect e Billing
    Tax e Billing
    Cotações
    Recuperação de receitas
    Automações
    Scripts
    Reconhecimento de receitas
    Gerenciamento de clientes
    Direitos
    Teste sua integração
Tributos
Relatórios
Dados
Incorporação de startups
Página inicialAutomação de finançasBillingSubscriptionsSubscription features

Usar períodos de avaliação em assinaturas

Adie os pagamentos em assinaturas ativas usando períodos de avaliação.

Copiar página

Você pode iniciar a assinatura do cliente com um período de avaliação gratuita informando o argumento trial_end ao criar a assinatura:

Command Line
cURL
curl https://api.stripe.com/v1/subscriptions \ -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"
\ -d customer=
{{CUSTOMER_ID}}
\ -d "items[0][price]"=
{{PRICE_ID}}
\ -d trial_end=1610403705

O parâmetro trial_end aceita um carimbo de data e hora indicando o momento exato do término da avaliação. Ao criar uma assinatura, você pode usar o parâmetro trial_period_days: um número inteiro que representa o número de dias de duração da avaliação, a partir do momento atual. O período de avaliação deve ser de 730 dias (2 anos) ou menos.

Nenhuma forma de pagamento é exigida do cliente ao criar uma assinatura com período de avaliação. Uma fatura imediata é criada, com o valor de US$ 0.

Avaliações durante a assinatura

Normalmente, os períodos de avaliação são aplicados no início da assinatura, mas também é possível usar um período de avaliação em uma assinatura existente para alterar seu ciclo de faturamento.

Quando a avaliação termina, se o status da assinatura não for paused, geramos uma fatura e enviamos uma notificação de evento invoice.created. Aproximadamente 1 hora depois, tentamos cobrar essa fatura. Um novo ciclo de faturamento também começa para o cliente quando a avaliação termina.

Para encerrar antecipadamente uma avaliação, chame a API de atualização de assinatura e defina o valor trial_end como um novo carimbo de data e hora ou now para encerrar imediatamente a fatura:

Command Line
cURL
curl https://api.stripe.com/v1/subscriptions/
{{SUBSCRIPTION_ID}}
\ -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"
\ -d trial_end=now

Combinar avaliações com a âncora de ciclo de faturamento

A partir da API versão 2018-02-05, também é possível combinar avaliações com billing_cycle_anchor para obter um período gratuito, seguido por um período proporcional que leva a um ciclo de faturamento fixo.

Por exemplo: hoje é dia 15 e você quer oferecer ao cliente uma avaliação gratuita de 7 dias (até o dia 22) para iniciar o faturamento normal no dia 1º. Use a API para combinar avaliações com billing_cycle_anchor (no momento, esse recurso não está disponível no Dashboard).

Neste exemplo, o cliente recebe uma fatura de um valor proporcional no dia 22 (para o período até o dia 1º). No dia 1º, o valor total é faturado novamente, depois no dia 1º do mês seguinte e assim por diante.

Command Line
cURL
curl https://api.stripe.com/v1/subscriptions \ -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"
\ -d customer=
{{CUSTOMER_ID}}
\ -d "items[0][price]"=
{{PRICE_ID}}
\ -d trial_end=1610403705 \ -d billing_cycle_anchor=1611008505

Faturamento por consumo com assinaturas suspensas

Você pode enviar eventos de medição associados a um preço em uma assinatura mesmo quando ela estiver suspensa. No entanto, após o reinício da assinatura, a fatura não incluirá nenhum evento de medição enviado durante o estado de suspensão. As faturas futuras só incluem eventos do consumo que ocorrerem após a data de reinício. Se você usa registros de uso herdados, não é possível criar registros de uso enquanto uma assinatura estiver suspensa.

Adicionar uma nova avaliação a uma assinatura anteriormente em uma avaliação

Você pode adicionar uma nova avaliação a uma assinatura que não esteja em período de avaliação atualizando a assinatura especificando trial_end ou atualizando o cronograma de assinatura associado. Você precisa especificar phases.trial_end para assinaturas.

Quando uma assinatura inicia uma nova avaliação após o término de uma avaliação anterior, o campo trial_start permanece definido para o início da primeira avaliação. A partir API versão 2025-04-30, trial_start reflete automaticamente o início da nova avaliação de assinaturas adicionada com billing_mode definido como credits_attributed_to_debits.

Combinar avaliações com add_invoice_items

Os períodos de avaliação de assinaturas podem ser combinados com preços avulsos e add_invoice_items. Isso pode acontecer quando você quer cobrar uma tarifa ou valor adicional avulso no início da avaliação. Nesse caso, uma fatura será gerada imediatamente com o valor do item avulso no início da avaliação.

Requisitos de conformidade para avaliações e promoções

Você deve cumprir os requisitos das bandeiras de cartão quando oferece avaliações (gratuitas ou não). Isso inclui cenários como avaliações gratuitas ou cobrança de preço reduzido nos primeiros meses para depois cobrar automaticamente as tarifas normais. Quando usa nossos recursos de avaliação, você pode ativar configurações de mensagens no Stripe Dashboard como ajuda para cumprir os requisitos.

Quando você avisa os usuários sobre pagamentos bem-sucedidos, a Stripe exibe automaticamente nessas notificações informações sobre a avaliação e o URL de cancelamento.

Se você não usar essas configurações, continuará responsável pelo cumprimento dos requisitos.

Quando os e-mails para clientes estão ativados, é enviado um lembrete sete dias antes do término da avaliação. Se a avaliação durar menos de sete dias, esse e-mail será enviado assim que a avaliação começar. Se as avaliações forem renovadas, esse e-mail será enviado a cada renovação.

Quando os lembretes de avaliação e de renovação de assinatura estão ativados durante a avaliação, os clientes recebem apenas o lembrete de término da avaliação. Os e-mails de renovação são enviados nos períodos de faturamento subsequentes.

O link da política de cancelamento é um URL exibido nos recibos dos clientes juntamente com outras informações da avaliação. Essas informações são incluídas em todos os pagamentos com cartão. O URL de cancelamento também é incluído no e-mail de lembrete enviado aos clientes sete dias antes do final da avaliação.

Nas descrições no extrato definidas manualmente na fatura, o texto da avaliação não é incluído e você precisa acrescentá-lo. Se você usar as descrições no extrato dos produtos, o texto da avaliação será acrescentado automaticamente. Se a descrição no extrato tiver mais de 10 caracteres, verifique se ela continua fazendo sentido para os clientes com o acréscimo do texto da avaliação. Há um limite de 22 caracteres. Isso significa que qualquer texto após o 10º caractere é substituído por * TERM.AVAL..

Se você não definir manualmente a descrição no extrato ou usar as descrições no extrato dos produtos, o texto da avaliação será acrescentado à descrição no extrato da sua conta. Se necessário, você pode configurar uma descrição resumida para garantir a exibição correta do texto da avaliação.

Cumprir requisitos sem usar os recursos da Stripe

Mesmo que você ofereça avaliações ou promoções sem usar nossos recursos de avaliação, continua responsável pelo cumprimento dos requisitos. Você pode escutar o evento invoice.upcoming para determinar quando enviar notificações por e-mail. Para adicionar texto a uma descrição no extrato indicando que a promoção acabou:

  • Escute o evento customer.subscription.updated
  • Verifique se uma avaliação ou promoção terminou
  • Atualize a descrição no extrato em latest_invoice da assinatura

Você precisa atualizar a fatura mais recente até uma hora após sua criação, enquanto ela ainda está no status de rascunho.

Criar avaliações gratuitas sem coletar forma de pagamento

Dica de segurança

Iniciar uma avaliação gratuita sem uma forma de pagamento permite que os clientes em potencial experimentem seu produto ou serviço mais rápido, mas também pode permitir que emissores de spam criem muitos clientes, usos e assinaturas falsos. Recomendamos que você considere cuidadosamente o fluxo de inscrição aqui para facilitar o uso pelos clientes reais e dificultar os abusos por bots de spam – por exemplo, exigindo que os clientes criem uma conta de usuário e preencham um captcha antes de iniciar a assinatura de teste gratuita.

Você pode inscrever clientes em uma avaliação gratuita de uma assinatura sem coletar os dados de pagamento no Dashboard, na API e no Checkout. Quando você cria a assinatura, pode especificar se deseja cancelar ou suspender a assinatura se o cliente não tiver fornecido uma forma de pagamento durante o período de avaliação. Para cancelar ou pausar a assinatura, defina o parâmetro trial_settings.end_behavior.missing_payment_method ao criar ou atualizar a assinatura:

  • Cancelar assinatura - Se a assinatura de avaliação gratuita terminar sem uma forma de pagamento, será cancelada imediatamente. Você pode criar outra assinatura se o cliente decidir assinar um plano pago no futuro. Defina missing_payment_method=cancel para cancelar a assinatura quando chegar ao final de uma avaliação sem uma forma de pagamento disponível.
  • Suspender assinatura – se a assinatura de avaliação gratuita terminar sem uma forma de pagamento, ela é suspensa e não reinicia o ciclo até ser retomada. Quando uma assinatura é suspensa, ela não gera faturas (ao contrário de quando a cobrança de pagamentos de uma assinatura é suspensa). Quando seu cliente adiciona a forma de pagamento após a suspensão da assinatura, você pode retomar a mesma assinatura. A assinatura pode permanecer suspensa indefinidamente. Defina missing_payment_method=pause para suspender a assinatura quando ela atingir o final de uma avaliação sem uma forma de pagamento disponível.

Como opção, defina missing_payment_method=create_invoice como emitir uma fatura ao final da avaliação se nenhuma forma de pagamento estiver presente. Se uma forma de pagamento não for informada quando a fatura for finalizada, a assinatura será movida para past_due.

Crie e-mails de lembrete para coletar os dados de pagamento do cliente nas configurações de mensagem do teste gratuito.

Configure avaliações gratuitas sem formas de pagamento para cancelar

Use o Dashboard, a API ou o Checkout para criar avaliações gratuitas de uma assinatura sem coletar dados de pagamento dos clientes e para configurar o cancelamento da assinatura se a avaliação terminar sem uma forma de pagamento.

Você pode usar o Dashboard para registrar clientes para uma avaliação gratuita de uma assinatura sem coletar os dados de pagamento:

  1. Nas configurações de assinatura do Dashboard, selecione +Criar assinatura.
  2. Após adicionar dados do seu cliente e do produto, selecione +Adicionar avaliação gratuita, em seguida, insira a duração da avaliação gratuita.
  3. Selecione a opção Suspender ou cancelar se a avaliação gratuita terminar sem uma forma de pagamento e selecione Cancelar imediatamente. Se estiver usando clocks de teste, avance até o final da avaliação. Você não verá uma próxima fatura para a assinatura.
  4. Ouça o evento customer.subscription.deleted, que informa quando uma assinatura é cancelada ao final das avaliações sem uma forma de pagamento.

Se você informar uma forma de pagamento ou selecionar a opção Enviar fatura por e-mail ao cliente com link para a página de pagamento, a opção Suspender ou cancelar se a avaliação gratuita terminar sem uma forma de pagamento não ficará visível.

Configure avaliações gratuitas sem formas de pagamento para suspender

Use o Dashboard, a API ou o Checkout para criar avaliações gratuitas de uma assinatura sem coletar dados de pagamento dos clientes e para configurar sua assinatura para ser suspensa se a avaliação terminar sem uma forma de pagamento.

Você pode usar o Dashboard para registrar clientes para uma avaliação gratuita de uma assinatura sem coletar os dados de pagamento:

  1. Nas configurações de assinatura do Dashboard, selecione +Criar assinatura.
  2. Após adicionar dados do seu cliente e do produto, selecione +Adicionar avaliação gratuita, em seguida, insira a duração da avaliação gratuita.
  3. Selecione a opção Suspender ou cancelar se a avaliação gratuita terminar sem uma forma de pagamento e selecione Suspender. Se estiver usando clocks de teste, avance para o final da avaliação. Você não verá uma próxima fatura para a assinatura.
  4. Ouça o evento customer.subscription.paused, que informa quando uma assinatura é suspensa no final das avaliações sem uma forma de pagamento.

Se você informar uma forma de pagamento ou selecionar a opção Enviar fatura por e-mail ao cliente com link para a página de pagamento, a opção Suspender ou cancelar se a avaliação gratuita terminar sem uma forma de pagamento não ficará visível.

Coletar dados de pagamento do cliente antes do fim da avaliação

Configure sua assinatura para enviar automaticamente um e-mail de lembrete quando a avaliação do cliente estiver prestes a expirar. Você deverá cumprir os requisitos da bandeira de cartão quando a oferta da avaliação terminar. Saiba mais sobre requisitos para avaliações e promoções.

Eventos

Os eventos são acionados sempre que uma avaliação gratuita é alterada. Verifique se a integração gerencia adequadamente os eventos. Por exemplo, talvez você queira enviar um e-mail para um cliente antes do final de uma avaliação gratuita. Saiba mais sobre como gerenciar eventos de assinatura.

A tabela a seguir descreve os eventos que são acionados antes do término de uma avaliação gratuita, quando uma assinatura de avaliação é suspensa ou cancelada e quando uma assinatura é reiniciada e se torna ativa.

EventoDescriçãoCaso de uso
customer.subscription.deletedEnviado quando uma assinatura termina.Pare de fornecer acesso ao seu produto em resposta a este evento. A assinatura muda para o status canceled e envia este evento quando uma avaliação gratuita termina sem forma de pagamento e se o comportamento final de missing_payment_method da assinatura estiver definido como cancel.
customer.subscription.resumedEnviado quando uma assinatura não está mais suspensa. Quando você receber esse evento, conceda ao cliente acesso ao produto se o acesso tiver sido revogado durante a suspensão da assinatura.As assinaturas suspensas são convertidas em assinaturas ativas após serem retomadas. A retomada de uma assinatura pode gerar uma fatura e o Payment Intent correspondente que devem ser pagos antes que a assinatura saia do status paused.
customer.subscription.pausedEnviado quando uma assinatura é totalmente suspensa. O faturamento também fica suspenso até o reinício da assinatura. Quando você recebe esse evento, pode revogar o acesso do cliente ao produto até que uma forma de pagamento seja adicionada e a assinatura seja reiniciada.Pare de fornecer acesso ao seu produto em resposta a este evento. A assinatura muda para o status paused e envia este evento quando uma avaliação gratuita termina sem forma de pagamento e se o comportamento final de missing_payment_method da assinatura estiver definido como pause. A assinatura permanece paused até que seja explicitamente retomada.
customer.subscription.trial_will_endEste evento é enviado três dias antes do final do período de avaliação. O evento é acionado quando o período de avaliação é inferior a três dias.Configure a assinatura para enviar automaticamente um e-mail ao seu cliente 3 dias antes do final do período de avaliação.

Use o portal do cliente para coletar pagamentos

Depois de criar uma assinatura para um cliente sem coletar uma forma de pagamento, redirecione-o para o portal do cliente do Billing para adicionar os dados de pagamento.

Primeiro, configure o portal do cliente do Billing para permitir que os clientes gerenciem suas assinaturas.

Em seguida, colete dados de cobrança dos seus clientes:

  1. Escute a customer.subscription.trial_will_end event.
  2. Se a assinatura não tiver uma forma de pagamento padrão, obtenha o e-mail do cliente usando a API Customers e envie uma mensagem com um link para o seu site. Também é útil inserir o ID do cliente no e-mail: https://example.com?...&customer={{CUSTOMER_ID}}.
  3. Quando o cliente entrar no seu site, crie uma sessão no portal do cliente usando o ID do cliente da etapa anterior.
  4. Redirecione o cliente para o portal do cliente, onde ele poderá atualizar a assinatura com os dados de pagamento.

Permita que os clientes reativem suas assinaturas no portal do cliente

Para habilitar a assinatura de um cliente cuja avaliação terminou em assinatura paused por meio do portal do cliente, habilite a avaliação gratuita sem o recurso de forma de pagamento quando criar uma assinatura no Dashboard.

Enviar um e-mail de lembrete antes do fim da avaliação

Para enviar um e-mail de lembrete antes do final da avaliação, selecione a opção Link para uma página hospedada pela Stripe na configuração de assinaturas e e-mails. O e-mail de lembrete contém um link para o cliente adicionar ou atualizar os dados de pagamento. Não enviamos e-mails de lembrete de avaliação gratuita em uma área restrita. Saiba mais sobre como configurar lembretes de avaliação gratuita.

Use o evento customer.subscription.trial_will_end para enviar seus próprios e-mails hospedados aos clientes. Após ver o evento no Dashboard, é confirmado que seu e-mail foi enviado.

Converter uma avaliação se os clientes fornecerem dados de pagamento antes do término da avaliação

Assinaturas e faturas futuras são criadas no início da avaliação e se tornam ativas no final da avaliação se o cliente informar uma forma de pagamento.

Configurar a suspensão quando uma forma de pagamento não for fornecida

Após o término de uma avaliação gratuita, você pode configurar assinaturas para serem suspensas se nenhuma forma de pagamento padrão estiver disponível para uma assinatura considerando cada assinatura.

Você pode atualizar as assinaturas enquanto elas estão suspensas. Atualizações que normalmente geram cobranças proporcionais (adição de itens, alteração de preço ou plano, alteração da quantidade etc.) não geram itens de linha proporcionais porque o cliente não é cobrado enquanto a assinatura está suspensa. Se quiser estender uma avaliação após a transição de uma assinatura para o status paused, é preciso retomar a assinatura antes de configurar uma avaliação.

Nós verificamos default_source e default_payment_method na assinatura e no cliente para determinar se falta uma forma de pagamento em uma assinatura no final de uma avaliação.

Retomar uma assinatura suspensa

Use o Dashboard, a API, o portal do cliente ou a página da fatura hospedada para retomar uma assinatura suspensa.

Para reiniciar uma assinatura suspensa no Dashboard, navegue até a assinatura e selecione Reiniciar assinatura no menu Ações. Selecione Redefinir ciclo de faturamento ou Sempre faturar (se não estiver redefinindo o ciclo de faturamento) no modal Reiniciar assinatura para cobrar o cliente imediatamente.

Faturamento de uma assinatura

Enquanto estiver suspensa, uma assinatura não criará uma fatura. Se você quiser continuar criando faturas, use pause_collection para parar de receber pagamentos enquanto continua a faturar e adiantar períodos de faturamento.

Para ver uma prévia da fatura gerada quando uma assinatura suspensa é retomada, especifique subscription_details.resume_at.

Veja também

  • Produtos e preços
  • Prices
  • Subscriptions
  • Gerenciar ciclos de faturamento de assinaturas
Esta página foi útil?
SimNão
Precisa de ajuda? Fale com o suporte.
Participe do nosso programa de acesso antecipado.
Confira nosso changelog.
Dúvidas? Fale com a equipe de vendas.
LLM? Read llms.txt.
Powered by Markdoc