payment-approved
Confirma que o pagamento foi aprovado e orienta o usuário a continuar no app.
Obrigatórias
appUrl
Opcionais
appNamecustomerNameorderIdproductNamepaymentAmountpaymentMethodpaidAt
Variáveis
- appUrl (obrigatória) - URL principal do app ou da tela relacionada ao pagamento. Exemplo:
https://app.ailian.com.br
- appName (opcional) - Nome exibido do produto. Usa Ailian quando omitido. Exemplo:
Ailian
- customerName (opcional) - Nome do cliente ou destinatário. Exemplo:
Marina Costa
- orderId (opcional) - Identificador do pedido, assinatura ou checkout. Exemplo:
PED-2026-0001
- productName (opcional) - Nome do plano, pacote de créditos ou item comprado. Exemplo:
Créditos Ailian 20K
- paymentAmount (opcional) - Valor do pagamento já formatado. Exemplo:
R$ 199,90
- paymentMethod (opcional) - Forma de pagamento exibida ao cliente. Exemplo:
Cartão de crédito
- paidAt (opcional) - Data/hora de aprovação já formatada. Exemplo:
11/05/2026 18:30
Exemplo de payload.email
{
"email": {
"template": "payment-approved",
"subject": "Pagamento aprovado",
"variables": {
"appName": "Ailian",
"customerName": "Marina Costa",
"orderId": "PED-2026-0001",
"productName": "Créditos Ailian 20K",
"paymentAmount": "R$ 199,90",
"paymentMethod": "Cartão de crédito",
"paidAt": "11/05/2026 18:30",
"appUrl": "https://app.ailian.com.br/billing"
}
}
}
invoice-issued
Informa que a nota fiscal foi emitida e entrega o link para acesso/download.
Obrigatórias
invoiceUrl
Opcionais
appNamecustomerNameinvoiceNumberproductNameinvoiceAmountissuedAtappUrl
Variáveis
- invoiceUrl (obrigatória) - URL pública ou autenticada para abrir/baixar a nota fiscal. Exemplo:
https://app.ailian.com.br/invoices/nf-001
- appName (opcional) - Nome exibido do produto. Usa Ailian quando omitido. Exemplo:
Ailian
- customerName (opcional) - Nome do cliente ou destinatário. Exemplo:
Marina Costa
- invoiceNumber (opcional) - Número da nota fiscal emitida. Exemplo:
NF-e 1024
- productName (opcional) - Nome do plano, pacote de créditos ou item faturado. Exemplo:
Créditos Ailian 20K
- invoiceAmount (opcional) - Valor da nota fiscal já formatado. Exemplo:
R$ 199,90
- issuedAt (opcional) - Data/hora de emissão já formatada. Exemplo:
11/05/2026 18:45
- appUrl (opcional) - URL alternativa para acessar a área financeira no app. Exemplo:
https://app.ailian.com.br/billing
Exemplo de payload.email
{
"email": {
"template": "invoice-issued",
"subject": "Nota fiscal emitida",
"variables": {
"appName": "Ailian",
"customerName": "Marina Costa",
"invoiceNumber": "NF-e 1024",
"productName": "Créditos Ailian 20K",
"invoiceAmount": "R$ 199,90",
"issuedAt": "11/05/2026 18:45",
"invoiceUrl": "https://app.ailian.com.br/invoices/nf-001",
"appUrl": "https://app.ailian.com.br/billing"
}
}
}
commercial-offer-sent
Entrega ao cliente o link seguro para revisar e aceitar uma proposta comercial.
Obrigatórias
offerUrl
Opcionais
appNameappUrlcustomerNamecustomerEmailplanNameplanSlugproposalAmountproposalAmountCentsproposalCurrencyintervalintervalLabelactivationPolicyactivationPolicyLabelofferIdexpiresAt
Variáveis
- offerUrl (obrigatória) - URL segura da proposta comercial para revisão e aceite. Exemplo:
https://app.ailian.com.br/billing/offers/offer_20260513_001
- appName (opcional) - Nome exibido do produto. Usa Ailian quando omitido. Exemplo:
Ailian
- appUrl (opcional) - URL principal do app ou da área de faturamento. Exemplo:
https://app.ailian.com.br/billing
- customerName (opcional) - Nome do cliente ou destinatário. Exemplo:
Marina Costa
- customerEmail (opcional) - E-mail do cliente usado pelo produtor para direcionar a proposta. Exemplo:
[email protected]
- planName (opcional) - Nome comercial do plano ofertado. Exemplo:
Ghostwriter Growth
- planSlug (opcional) - Identificador técnico do plano ofertado. Exemplo:
ghostwriter-growth
- proposalAmount (opcional) - Valor da proposta já formatado. Exemplo:
R$ 899,00
- proposalAmountCents (opcional) - Valor da proposta em centavos, usado como fallback quando proposalAmount não vier formatado. Exemplo:
89900
- proposalCurrency (opcional) - Moeda ISO usada com proposalAmountCents. Usa BRL quando omitida. Exemplo:
BRL
- interval (opcional) - Periodicidade técnica do plano, usada como fallback quando intervalLabel não vier formatado. Exemplo:
month
- intervalLabel (opcional) - Periodicidade exibida ao cliente. Exemplo:
Mensal
- activationPolicy (opcional) - Política técnica de ativação, usada como fallback quando activationPolicyLabel não vier formatada. Exemplo:
on_accept
- activationPolicyLabel (opcional) - Política de ativação exibida ao cliente. Exemplo:
Ativação após aceite
- offerId (opcional) - Identificador da proposta comercial. Exemplo:
offer_20260513_001
- expiresAt (opcional) - Data/hora de expiração da proposta, em ISO ou já formatada. Exemplo:
2026-05-20T18:30:00.000-03:00
Exemplo de payload.email
{
"email": {
"template": "commercial-offer-sent",
"subject": "Sua proposta comercial está pronta",
"variables": {
"appName": "Ailian",
"appUrl": "https://app.ailian.com.br/billing",
"customerName": "Marina Costa",
"customerEmail": "[email protected]",
"planName": "Ghostwriter Growth",
"planSlug": "ghostwriter-growth",
"proposalAmount": "R$ 899,00",
"proposalAmountCents": 89900,
"proposalCurrency": "BRL",
"interval": "month",
"intervalLabel": "Mensal",
"activationPolicy": "on_accept",
"activationPolicyLabel": "Ativação após aceite",
"offerId": "offer_20260513_001",
"offerUrl": "https://app.ailian.com.br/billing/offers/offer_20260513_001",
"expiresAt": "2026-05-20T18:30:00.000-03:00"
}
}
}