Central do Desenvolvedor

Documentação do Desenvolvedor

A central do desenvolvedor é um repositório com referências técnicas, conceitos e materiais passo a passo sobre o funcionamento e comunicação através de API.

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ável
Descrição

invoice.email

Email do cliente

invoice.customer_ref

Nome do cliente

invoice.created_at

Data de criação da fatura

invoice.total

Valor total da fatura (Ex.: R$ 100,00)

invoice.discount

Valor de desconto na fatura (Ex.: R$ 5,00)

invoice.tax

Valor de imposto na fatura (Ex.: R$ 1,20)

invoice.id

ID da fatura

invoice.to_secure_id

ID seguro da fatura

invoice.to_secure_url

URL segura para a fatura na web

invoice.items

Array 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_name

Nome da sua conta iugu

invoice.updated_at

Data da última atualização da fatura

invoice.due_date

Data de vencimento da fatura

invoice.subscription

Assinatura que gerou essa fatura, se existir.

invoice.bank_slip

Dados do boleto bancário com os seguintes campos:

  • bank_slip.barcode: Código de barras em formato HTML.
  • bank_slip.digitable_line: Linha digitável.

Assinatura

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

Variável

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.:

{
  :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 %}

Updated about a year ago

Emails transacionais


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.