Emails transacionais

A iugu permite personalizar totalmente os emails enviados a seus clientes, bem como desligar aqueles que você não se interessa em enviar. Utilizamos a linguagem Liquid para a customização dos emails. Dessa forma, o usuário pode criar loops, aplicar filtros em texto etc.

Disponibilizamos variáveis que podem ser utilizadas dentro dos emails através do Liquid (veja abaixo). Para informações sobre como utilizar Liquid, recomendamos acessar a wiki do projeto.

Emails disponíveis

  • Lembrete de fatura: enviado para o cliente quando a fatura está perto de vencer.
  • Fatura vencida: enviado para o cliente quando a fatura chega em sua data de vencimento.
  • Recibo de fatura: enviado para o cliente quando a fatura é paga com sucesso.
  • Fatura cancelada: enviado para o cliente quando uma fatura é cancelada.
  • Estorno de fatura: email de reembolso de fatura.
  • Recorrência/Assinatura: falha na cobrança: enviado quando há uma falha na cobrança automática de uma assinatura.
  • Recorrência/Assinatura: nova conta: enviado quando a assinatura é criada.
  • Recorrência/Assinatura: alterada: enviado quando alguma informação da assinatura mudou.
  • Recorrência/Assinatura: suspensa: enviado quando a assinatura é suspensa.
  • Assinatura: Últimos dias de período de testes: enviado para informar o tempo restante no período de teste da assinatura.
  • Assinatura: Fim do período de testes: enviado ao fim do período de teste de uma assinatura.

Tipos de objetos

Fatura

Disponível para todos os emails transacionais que lidem com uma fatura ou cobrança.

VariávelDescrição
invoice.email E-mail do cliente
invoice.customer_refNome do cliente
invoice.created_at Data de criação da fatura
invoice.total Valor total da fatura (Ex.: R$ 100,00)
invoice.discountValor de desconto na fatura (Ex.: R$ 5,00)
invoice.taxValor de imposto na fatura (Ex.: R$ 1,20)
invoice.idID da fatura
invoice.to_secure_idID seguro da fatura
invoice.to_secure_urlURL segura para a fatura na web
invoice.itemsArray de itens da fatura, com os seguintes campos:

  • item.price: Preço unitário do item.

  • item.quantity: Quantidade do item.

  • item.description: Descrição do item.

  • item.total: Valor total (price x quantity)
  • invoice.account_nameNome da sua conta iugu
    invoice.updated_atData da última atualização da fatura
    invoice.due_dateData de vencimento da fatura
    invoice.subscription Assinatura que gerou essa fatura, se existir.
    invoice.bank_slipDados do boleto bancário com os seguintes campos:

  • bank_slip.barcode_data_url: Código de barras em formato HTML.

  • bank_slip.digitable_line: Linha digitável.

  • bank_slip.bank_slip_url: URL da imagem do Boleto.
  • bank_slip.bank_slip_pdf_url: PDF do Boleto
  • invoice.pix
  • pix.qr_code_url: URL do QR Code

  • pix.qr_code_text: Pix Copia e Cola
  • Assinatura

    Disponível para todos os emails transacionais que lidem com uma assinatura.

    VariávelDescrição
    subscription.price Preço da assinatura (Ex.: R$ 15,00).
    subscription.customer_email Email do cliente.
    subscription.customer_name Nome do cliente.
    subscription.plan_name Nome do plano da assinatura.
    subscription.features Funcionalidades da assinatura em formato JSON. Ex.:

    json { :feature: { :name=>'Feature', :value=>0 } }
    subscription.account_name Nome da sua conta iugu
    subscription.customer_ref Nome, se existir, ou email do cliente.
    subscription.days_left Número de dias restantes para o fim do ciclo atual da assinatura.
    subscription.trial_days_left Número de dias restantes para o fim do período de teste da assinatura.

    Variáveis personalizadas

    Você também pode adicionar variáveis personalizadas a uma fatura, numa assinatura ou num cadastro de cliente, durante a criação ou alteração dos mesmos, via painel de controle ou API.

    Para exibir o valor dessas variáveis nos emails enviados, use o filtro custom_variable entre as tags {{ }}, por exemplo:

    {{ invoice | custom_variable: 'nome_da_variavel’ }}
    {{ subscription | custom_variable: 'nome_da_variavel’ }}
    

    Essas variáveis podem ser utilizadas também na lógica do seu email.

    Suponha que você tenha, para cada cliente, uma variável modelo que identifica se ele é um varejo (e-commerce tradicional) ou um marketplace. Usando uma simples condicional, você pode alterar o conteúdo do email de nova conta para assinatura, por exemplo:

    {% assign model = subscription.customer | custom_variable: 'modelo' %}
    {% if model == 'varejo' %}
    <p> ... </p>
    {% elsif model == 'marketplace' %}
    <p> ... </p>
    {% endif %}