Compraspurchase.*
purchase.abandoned
Quando um purchase fica inativo no checkout sem ter sido pago. Ocorre quando a pessoa deixou seus dados, ou cancelou um boleto ou pix, ou teve um pagamento recusado, e não realizou nenhuma ação nova dentro da janela de inatividade configurada. Pode ocorrer mais de uma vez para o mesmo purchase, e o campo abandonment.stage do payload identifica de qual etapa a pessoa saiu.
A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: a compra ficou parada no checkout sem pagamento; o bloco abandonment diz em que etapa.
Campos
_idstringsempre presenteID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).
abandonmentobjectsempre presente4 camposSó no purchase.abandoned: em que ponto a pessoa parou e há quanto tempo.
abandonCountintegersempre presenteQuantas vezes esta compra já gerou purchase.abandoned, contando este envio. Se a pessoa volta, age e para de novo, o evento é enviado outra vez com o número maior.
idleForMinutesintegersempre presenteHá quantos minutos a pessoa está parada, contados de idleSince até o envio deste evento.
idleSincestring (data)sempre presenteData da última ação da pessoa nesta compra, a partir da qual ela ficou parada. Data e hora em ISO 8601, no fuso UTC.
stagestringsempre presenteEtapa em que a pessoa parou. lead_captured: deixou os dados e não seguiu. payment_canceled: gerou boleto ou PIX e cancelou. payment_refused: teve o cartão recusado e não tentou de novo.
lead_capturedpayment_canceledpayment_refused
checkoutobjectsempre presente5 camposO checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.
_idstringsempre presenteID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.
descriptionstring ou nullsempre presenteDescrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.
purchaseChoicesobjectsempre presente1 campoOpções de venda do checkout.
choicesarray de objectsempre presente9 camposLista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.
_idstringsempre presenteID da opção de venda.
appearanceobjectsempre presente7 camposComo a opção de venda aparece para o comprador no checkout.
_idstringsempre presenteID da configuração de aparência.
badgeTextstringSelo de destaque exibido na opção (ex.: "Mais vendido").
createdAtstring (data)sempre presenteData em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.
descriptionstringTexto de apoio exibido abaixo do nome da opção.
namestringsempre presenteNome da opção de venda exibido no checkout (ex.: "Plano anual").
updatedAtstring (data)sempre presenteData da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.
valueDisplayobjectsempre presente6 camposComo o valor da opção é mostrado no checkout.
_idstringsempre presenteID da configuração de exibição do valor.
createdAtstring (data)sempre presenteData em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.
priceTextstringSó em CUSTOM: texto exibido no lugar do valor.
supportTextstringSó em CUSTOM: texto de apoio exibido junto ao valor.
typestringsempre presenteAUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.
AUTOMATICCUSTOMupdatedAtstring (data)sempre presenteData da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.
defaultbooleansempre presentetrue na opção que aparece selecionada quando a pessoa abre o checkout.
invoiceDiscountedAmountintegersempre presenteTotal de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceDiscountsarray de object8 camposDescontos configurados na opção de venda. Só aparece quando a opção tem algum.
_idstringsempre presenteID do desconto.
amountintegersempre presenteValor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
descriptionstringsempre presenteTexto do desconto, como aparece para o comprador (ex.: "Primeira compra").
percentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject8 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
createdAtstring (data)sempre presenteData em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.
descriptionstring ou nullsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray ou nullsempre presenteMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
namestringsempre presenteNome do produto.
priceobjectsempre presente7 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente5 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
createdAtstring (data)Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
updatedAtstring (data)Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.
createdAtstring (data)sempre presenteData em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente6 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
createdAtstring (data)Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRINGupdatedAtstring (data)Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.
updatedAtstring (data)sempre presenteData da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHERupdatedAtstring (data)sempre presenteData da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsAmountintegersempre presenteSoma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceTotalAmountintegersempre presenteValor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.
ACTIVEINACTIVE
sharedIdstringsempre presenteID do checkout, o mesmo de checkoutSharedId na raiz.
statusstringsempre presenteStatus do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.
ACTIVEINACTIVE
checkoutPurchaseChoiceIdstringsempre presenteID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.
checkoutSharedIdstringsempre presenteID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.
createdAtstring (data)sempre presenteData em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.
eventTypestring = "purchase.abandoned"sempre presenteNome do evento que gerou este envio.
invoiceobject ou null10 camposA fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.
_idstringsempre presenteID da fatura.
discountedAmountintegersempre presenteTotal de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).
discountsarray de objectsempre presente11 camposDescontos aplicados na fatura.
_idstringsempre presenteID do desconto.
amountintegersempre presenteValor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
descriptionstringTexto do desconto, como aparece para o comprador (ex.: "Primeira compra").
installmentnullSó em PAYMENT_METHOD: número de parcelas a que o desconto se aplica. null quando vale para qualquer parcelamento.
paymentMethodstringSó em PAYMENT_METHOD: forma de pagamento que dá direito ao desconto.
BANK_SLIPCREDIT_CARDMONEYPIXpercentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
updatedBystringID de quem alterou o desconto pela última vez.
dueAmountintegersempre presenteValor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).
itemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject6 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
descriptionstring ou nullsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray ou nullsempre presenteMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
namestringsempre presenteNome do produto.
priceobjectsempre presente5 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente5 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
createdAtstring (data)Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
updatedAtstring (data)Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente6 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
createdAtstring (data)Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRINGupdatedAtstring (data)Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHER
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
itemsAmountintegersempre presenteSoma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
paidAmountintegersempre presenteValor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).
refundedAmountintegersempre presenteValor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da fatura.
DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOIDtotalAmountintegersempre presenteValor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).
organizationstringsempre presenteID da sua organização na EngagED.
paymentsarray de objectsempre presente12 camposTodas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.
_idstringsempre presenteID do pagamento.
additionalAdvanceFeeintegersempre presenteJuros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).
amountintegersempre presenteValor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).
codestringSó em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.
createdAtstring (data)sempre presenteData em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do pagamento, em código ISO 4217 (ex.: BRL).
expirationDatestring (data)Só em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.
installmentsintegersempre presenteNúmero de parcelas. Em boleto e PIX é sempre 1.
paymentMethodstringsempre presenteForma de pagamento. BANK_SLIP é boleto.
BANK_SLIPCREDIT_CARDMONEYPIXrefundedAmountintegersempre presenteValor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.
ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENTstatusAtstring (data)sempre presenteData em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.
queryParamsobjectsempre presenteParâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.
statusstringsempre presenteStatus da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).
DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOIDupdatedAtstring (data)sempre presenteData da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.
userobjectsempre presente6 camposA pessoa que fez a compra.
_idstringsempre presenteID da pessoa na EngagED. É o mesmo em todas as compras dela.
customFieldsAnswersobject1 campoRespostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.
{chave}object5 camposResposta a um campo personalizado.
_idstringsempre presenteID da resposta.
documentTypestringSó em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.
BR_CNPJBR_CPFtypestringsempre presenteTipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).
DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORTupdatedAtstring (data)sempre presenteData da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.
valueinteger | stringsempre presenteA resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.
emailstringsempre presenteE-mail informado no checkout.
namestringsempre presenteNome completo informado no checkout.
phoneNumberstringsempre presenteTelefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.
phoneNumberCountrystringsempre presentePaís do telefone, em código ISO 3166 de duas letras (ex.: BR).
userPaymentProfileobject ou null9 camposDados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.
_idstringsempre presenteID do perfil de cobrança.
addressobject ou nullsempre presente8 camposEndereço de cobrança. Vem null quando o checkout não pede endereço.
cityobjectsempre presente2 camposCidade.
metadataarray de objectsempre presente2 camposCódigos oficiais da cidade, em pares chave e valor.
keystringsempre presenteNome do código (ex.: ibge_id).
valuestringsempre presenteValor do código (ex.: o código IBGE da cidade).
namestringsempre presenteNome da cidade.
complementstringComplemento. Só aparece quando foi preenchido.
countrystringsempre presentePaís do endereço, em código ISO 3166 de duas letras (ex.: BR).
neighborhoodstringsempre presenteBairro.
numberstring ou nullsempre presenteNúmero. Pode vir null.
stateobjectsempre presente3 camposEstado.
codestringsempre presenteSigla do estado (ex.: PR).
metadataarray de objectsempre presente2 camposCódigos oficiais do estado, em pares chave e valor.
keystringsempre presenteNome do código (ex.: ibge_id).
valuestringsempre presenteValor do código (ex.: o código IBGE do estado).
namestringsempre presenteNome do estado.
streetstringsempre presenteLogradouro.
zipcodestringsempre presenteCEP, só com dígitos.
countrystringsempre presentePaís do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).
namestringsempre presenteNome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).
taxIdsarray de objectsempre presente6 camposDocumentos fiscais do titular.
_idstringsempre presenteID do documento.
countrystringsempre presentePaís do documento, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do documento. No Brasil: BR_CPF ou BR_CNPJ.
BR_CNPJBR_CPFPASSPORTupdatedAtstring (data)sempre presenteData da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteNúmero do documento, só com dígitos (sem pontos, traço ou barra).
typestringsempre presenteTipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).
COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFITupdatedAtstring (data)sempre presenteData da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.
Dados fictícios, com a mesma estrutura de um envio real.
purchase.chargedback
Quando uma compra tem seu pagamento com status CHARGEDBACK. Isso ocorre quando o titular do cartão contesta a compra junto ao emissor e o valor é estornado. É um evento final: o pagamento não muda mais de status depois dele.
A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: o pagamento contestado está em CHARGEDBACK. É um status final: o pagamento não muda mais depois dele.
Campos
_idstringsempre presenteID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).
checkoutobjectsempre presente5 camposO checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.
_idstringsempre presenteID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.
descriptionstringsempre presenteDescrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.
purchaseChoicesobjectsempre presente1 campoOpções de venda do checkout.
choicesarray de objectsempre presente8 camposLista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.
_idstringsempre presenteID da opção de venda.
appearanceobjectsempre presente5 camposComo a opção de venda aparece para o comprador no checkout.
_idstringsempre presenteID da configuração de aparência.
createdAtstring (data)sempre presenteData em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.
namestringsempre presenteNome da opção de venda exibido no checkout (ex.: "Plano anual").
updatedAtstring (data)sempre presenteData da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.
valueDisplayobjectsempre presente6 camposComo o valor da opção é mostrado no checkout.
_idstringsempre presenteID da configuração de exibição do valor.
createdAtstring (data)sempre presenteData em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.
priceTextstringSó em CUSTOM: texto exibido no lugar do valor.
supportTextstringSó em CUSTOM: texto de apoio exibido junto ao valor.
typestringsempre presenteAUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.
AUTOMATICCUSTOMupdatedAtstring (data)sempre presenteData da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.
defaultbooleansempre presentetrue na opção que aparece selecionada quando a pessoa abre o checkout.
invoiceDiscountedAmountintegersempre presenteTotal de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceItemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject8 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
createdAtstring (data)sempre presenteData em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.
descriptionstringsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray ou nullsempre presenteMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
namestringsempre presenteNome do produto.
priceobjectsempre presente7 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente3 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente4 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRING
updatedAtstring (data)sempre presenteData da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHERupdatedAtstring (data)sempre presenteData da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsAmountintegersempre presenteSoma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceTotalAmountintegersempre presenteValor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.
ACTIVEINACTIVE
sharedIdstringsempre presenteID do checkout, o mesmo de checkoutSharedId na raiz.
statusstringsempre presenteStatus do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.
ACTIVEINACTIVE
checkoutPurchaseChoiceIdstringsempre presenteID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.
checkoutSharedIdstringsempre presenteID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.
createdAtstring (data)sempre presenteData em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.
eventTypestring = "purchase.chargedback"sempre presenteNome do evento que gerou este envio.
invoiceobjectsempre presente10 camposA fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.
_idstringsempre presenteID da fatura.
discountedAmountintegersempre presenteTotal de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).
discountsarray de objectsempre presente9 camposDescontos aplicados na fatura.
_idstringsempre presenteID do desconto.
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
percentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
redemptionobjectsempre presente6 camposSó em VOUCHER: o resgate do cupom nesta compra.
_idstringsempre presenteID do resgate.
createdAtstring (data)sempre presenteData em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.
discountedAmountintegersempre presenteValor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).
redeemedAtstring (data)sempre presenteData em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.
redeemedCodestringsempre presenteCódigo do cupom como o comprador digitou.
updatedAtstring (data)sempre presenteData da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
updatedBystringsempre presenteID de quem alterou o desconto pela última vez.
voucherstringsempre presenteSó em VOUCHER: ID do cupom usado.
dueAmountintegersempre presenteValor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).
itemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject6 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
descriptionstringsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray ou nullsempre presenteMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
namestringsempre presenteNome do produto.
priceobjectsempre presente5 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente3 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente4 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRING
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHER
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
itemsAmountintegersempre presenteSoma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
paidAmountintegersempre presenteValor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).
refundedAmountintegersempre presenteValor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da fatura.
DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOIDtotalAmountintegersempre presenteValor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).
organizationstringsempre presenteID da sua organização na EngagED.
paymentsarray de objectsempre presente10 camposTodas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.
_idstringsempre presenteID do pagamento.
additionalAdvanceFeeintegersempre presenteJuros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).
amountintegersempre presenteValor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do pagamento, em código ISO 4217 (ex.: BRL).
installmentsintegersempre presenteNúmero de parcelas. Em boleto e PIX é sempre 1.
paymentMethodstringsempre presenteForma de pagamento. BANK_SLIP é boleto.
BANK_SLIPCREDIT_CARDMONEYPIXrefundedAmountintegersempre presenteValor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.
ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENTstatusAtstring (data)sempre presenteData em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.
queryParamsobjectsempre presenteParâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.
statusstringsempre presenteStatus da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).
DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOIDupdatedAtstring (data)sempre presenteData da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.
userobjectsempre presente6 camposA pessoa que fez a compra.
_idstringsempre presenteID da pessoa na EngagED. É o mesmo em todas as compras dela.
customFieldsAnswersobject1 campoRespostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.
{chave}object5 camposResposta a um campo personalizado.
_idstringsempre presenteID da resposta.
documentTypestringSó em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.
BR_CNPJBR_CPFtypestringsempre presenteTipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).
DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORTupdatedAtstring (data)sempre presenteData da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.
valueinteger | stringsempre presenteA resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.
emailstringsempre presenteE-mail informado no checkout.
namestringsempre presenteNome completo informado no checkout.
phoneNumberstringsempre presenteTelefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.
phoneNumberCountrystringsempre presentePaís do telefone, em código ISO 3166 de duas letras (ex.: BR).
userPaymentProfileobjectsempre presente9 camposDados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.
_idstringsempre presenteID do perfil de cobrança.
addressnullsempre presenteEndereço de cobrança. Vem null quando o checkout não pede endereço.
countrystringsempre presentePaís do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).
namestringsempre presenteNome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).
taxIdsarray de objectsempre presente6 camposDocumentos fiscais do titular.
_idstringsempre presenteID do documento.
countrystringsempre presentePaís do documento, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do documento. No Brasil: BR_CPF ou BR_CNPJ.
BR_CNPJBR_CPFPASSPORTupdatedAtstring (data)sempre presenteData da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteNúmero do documento, só com dígitos (sem pontos, traço ou barra).
typestringsempre presenteTipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).
COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFITupdatedAtstring (data)sempre presenteData da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.
Dados fictícios, com a mesma estrutura de um envio real.
purchase.expired
Quando uma compra tem seu status EXPIRED, e o pagamento também vai para EXPIRED.Isso ocorre quando um Boleto ou PIX expira (passa do vencimento).
A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: status = EXPIRED: o boleto ou PIX venceu sem pagamento.
Campos
_idstringsempre presenteID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).
checkoutobjectsempre presente5 camposO checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.
_idstringsempre presenteID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.
descriptionstring ou nullsempre presenteDescrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.
purchaseChoicesobject1 campoOpções de venda do checkout.
choicesarray de objectsempre presente9 camposLista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.
_idstringsempre presenteID da opção de venda.
appearanceobjectsempre presente7 camposComo a opção de venda aparece para o comprador no checkout.
_idstringsempre presenteID da configuração de aparência.
badgeTextstringSelo de destaque exibido na opção (ex.: "Mais vendido").
createdAtstring (data)sempre presenteData em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.
descriptionstringTexto de apoio exibido abaixo do nome da opção.
namestringsempre presenteNome da opção de venda exibido no checkout (ex.: "Plano anual").
updatedAtstring (data)sempre presenteData da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.
valueDisplayobjectsempre presente6 camposComo o valor da opção é mostrado no checkout.
_idstringsempre presenteID da configuração de exibição do valor.
createdAtstring (data)sempre presenteData em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.
priceTextstringSó em CUSTOM: texto exibido no lugar do valor.
supportTextstringSó em CUSTOM: texto de apoio exibido junto ao valor.
typestringsempre presenteAUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.
AUTOMATICCUSTOMupdatedAtstring (data)sempre presenteData da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.
defaultbooleansempre presentetrue na opção que aparece selecionada quando a pessoa abre o checkout.
invoiceDiscountedAmountintegersempre presenteTotal de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceDiscountsarray de object8 camposDescontos configurados na opção de venda. Só aparece quando a opção tem algum.
_idstringsempre presenteID do desconto.
amountintegersempre presenteValor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
descriptionstringsempre presenteTexto do desconto, como aparece para o comprador (ex.: "Primeira compra").
percentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject8 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
createdAtstring (data)sempre presenteData em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.
descriptionstring ou nullsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray ou nullsempre presenteMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
namestringsempre presenteNome do produto.
priceobjectsempre presente7 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente5 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
createdAtstring (data)Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
updatedAtstring (data)Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.
createdAtstring (data)sempre presenteData em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente6 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
createdAtstring (data)Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRINGupdatedAtstring (data)Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.
updatedAtstring (data)sempre presenteData da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHERupdatedAtstring (data)sempre presenteData da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsAmountintegersempre presenteSoma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceTotalAmountintegersempre presenteValor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.
ACTIVEINACTIVE
sharedIdstringsempre presenteID do checkout, o mesmo de checkoutSharedId na raiz.
statusstringsempre presenteStatus do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.
ACTIVEINACTIVE
checkoutPurchaseChoiceIdstringID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.
checkoutSharedIdstringsempre presenteID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.
createdAtstring (data)sempre presenteData em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.
eventTypestring = "purchase.expired"sempre presenteNome do evento que gerou este envio.
invoiceobjectsempre presente10 camposA fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.
_idstringsempre presenteID da fatura.
discountedAmountintegersempre presenteTotal de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).
discountsarray de objectsempre presente13 camposDescontos aplicados na fatura.
_idstringsempre presenteID do desconto.
amountintegerValor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
descriptionstringTexto do desconto, como aparece para o comprador (ex.: "Primeira compra").
installmentnullSó em PAYMENT_METHOD: número de parcelas a que o desconto se aplica. null quando vale para qualquer parcelamento.
paymentMethodstringSó em PAYMENT_METHOD: forma de pagamento que dá direito ao desconto.
BANK_SLIPCREDIT_CARDMONEYPIXpercentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
redemptionobject6 camposSó em VOUCHER: o resgate do cupom nesta compra.
_idstringsempre presenteID do resgate.
createdAtstring (data)sempre presenteData em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.
discountedAmountintegersempre presenteValor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).
redeemedAtstring (data)sempre presenteData em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.
redeemedCodestringsempre presenteCódigo do cupom como o comprador digitou.
updatedAtstring (data)sempre presenteData da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
updatedBystringID de quem alterou o desconto pela última vez.
voucherstringSó em VOUCHER: ID do cupom usado.
dueAmountintegersempre presenteValor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).
itemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject6 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
descriptionstring ou nullsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray ou nullsempre presenteMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
namestringsempre presenteNome do produto.
priceobjectsempre presente5 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente3 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente4 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRING
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHER
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
itemsAmountintegersempre presenteSoma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
paidAmountintegersempre presenteValor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).
refundedAmountintegersempre presenteValor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da fatura.
DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOIDtotalAmountintegersempre presenteValor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).
organizationstringsempre presenteID da sua organização na EngagED.
paymentsarray de objectsempre presente13 camposTodas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.
_idstringsempre presenteID do pagamento.
additionalAdvanceFeeintegersempre presenteJuros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).
amountintegersempre presenteValor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).
codestring ou nullsempre presenteSó em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.
createdAtstring (data)sempre presenteData em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do pagamento, em código ISO 4217 (ex.: BRL).
expirationDatestring (data)sempre presenteSó em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.
installmentsintegersempre presenteNúmero de parcelas. Em boleto e PIX é sempre 1.
paymentMethodstringsempre presenteForma de pagamento. BANK_SLIP é boleto.
BANK_SLIPCREDIT_CARDMONEYPIXqrCodeUrlnullSó em PIX: URL da imagem do QR Code.
refundedAmountintegersempre presenteValor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.
ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENTstatusAtstring (data)sempre presenteData em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.
queryParamsobjectsempre presente1 campoParâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.
{chave}stringValor do parâmetro de URL, com o mesmo nome que estava no link (ex.: utm_source, utm_campaign).
statusstringsempre presenteStatus da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).
DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOIDupdatedAtstring (data)sempre presenteData da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.
userobjectsempre presente6 camposA pessoa que fez a compra.
_idstringsempre presenteID da pessoa na EngagED. É o mesmo em todas as compras dela.
customFieldsAnswersobject1 campoRespostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.
{chave}object5 camposResposta a um campo personalizado.
_idstringsempre presenteID da resposta.
documentTypestringSó em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.
BR_CNPJBR_CPFtypestringsempre presenteTipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).
DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORTupdatedAtstring (data)sempre presenteData da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteA resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.
emailstringsempre presenteE-mail informado no checkout.
namestringsempre presenteNome completo informado no checkout.
phoneNumberstringsempre presenteTelefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.
phoneNumberCountrystringsempre presentePaís do telefone, em código ISO 3166 de duas letras (ex.: BR).
userPaymentProfileobjectsempre presente9 camposDados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.
_idstringsempre presenteID do perfil de cobrança.
addressobject ou nullsempre presente8 camposEndereço de cobrança. Vem null quando o checkout não pede endereço.
cityobjectsempre presente2 camposCidade.
metadataarray de objectsempre presente2 camposCódigos oficiais da cidade, em pares chave e valor.
keystringsempre presenteNome do código (ex.: ibge_id).
valuestringsempre presenteValor do código (ex.: o código IBGE da cidade).
namestringsempre presenteNome da cidade.
complementstringComplemento. Só aparece quando foi preenchido.
countrystringsempre presentePaís do endereço, em código ISO 3166 de duas letras (ex.: BR).
neighborhoodstringsempre presenteBairro.
numberstringsempre presenteNúmero. Pode vir null.
stateobjectsempre presente3 camposEstado.
codestringsempre presenteSigla do estado (ex.: PR).
metadataarray de objectsempre presente2 camposCódigos oficiais do estado, em pares chave e valor.
keystringsempre presenteNome do código (ex.: ibge_id).
valuestringsempre presenteValor do código (ex.: o código IBGE do estado).
namestringsempre presenteNome do estado.
streetstringsempre presenteLogradouro.
zipcodestringsempre presenteCEP, só com dígitos.
countrystringsempre presentePaís do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).
namestringsempre presenteNome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).
taxIdsarray de objectsempre presente6 camposDocumentos fiscais do titular.
_idstringsempre presenteID do documento.
countrystringsempre presentePaís do documento, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do documento. No Brasil: BR_CPF ou BR_CNPJ.
BR_CNPJBR_CPFPASSPORTupdatedAtstring (data)sempre presenteData da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteNúmero do documento, só com dígitos (sem pontos, traço ou barra).
typestringsempre presenteTipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).
COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFITupdatedAtstring (data)sempre presenteData da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.
Dados fictícios, com a mesma estrutura de um envio real.
purchase.lead_captured
Quando uma compra tem seu status DRAFT. Isso ocorre quando um lead deixa suas informações na modal de captura de leads.
A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: status = DRAFT, sem pagamento nem fatura. Traz os dados que a pessoa deixou na captura de lead.
Campos
_idstringsempre presenteID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).
checkoutobjectsempre presente5 camposO checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.
_idstringsempre presenteID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.
descriptionstring ou nullsempre presenteDescrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.
purchaseChoicesobject1 campoOpções de venda do checkout.
choicesarray de objectsempre presente9 camposLista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.
_idstringsempre presenteID da opção de venda.
appearanceobjectsempre presente7 camposComo a opção de venda aparece para o comprador no checkout.
_idstringID da configuração de aparência.
badgeTextstringSelo de destaque exibido na opção (ex.: "Mais vendido").
createdAtstring (data)Data em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.
descriptionstringTexto de apoio exibido abaixo do nome da opção.
namestringsempre presenteNome da opção de venda exibido no checkout (ex.: "Plano anual").
updatedAtstring (data)Data da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.
valueDisplayobjectsempre presente6 camposComo o valor da opção é mostrado no checkout.
_idstringID da configuração de exibição do valor.
createdAtstring (data)Data em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.
priceTextstringSó em CUSTOM: texto exibido no lugar do valor.
supportTextstringSó em CUSTOM: texto de apoio exibido junto ao valor.
typestringsempre presenteAUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.
AUTOMATICCUSTOMupdatedAtstring (data)Data da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.
defaultbooleansempre presentetrue na opção que aparece selecionada quando a pessoa abre o checkout.
invoiceDiscountedAmountintegersempre presenteTotal de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceDiscountsarray de object8 camposDescontos configurados na opção de venda. Só aparece quando a opção tem algum.
_idstringsempre presenteID do desconto.
amountintegersempre presenteValor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
descriptionstringsempre presenteTexto do desconto, como aparece para o comprador (ex.: "Primeira compra").
percentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject8 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
createdAtstring (data)sempre presenteData em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.
descriptionstring ou nullsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray ou nullsempre presenteMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
namestringsempre presenteNome do produto.
priceobjectsempre presente7 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente5 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
createdAtstring (data)Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
updatedAtstring (data)Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.
createdAtstring (data)sempre presenteData em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente6 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
createdAtstring (data)Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRINGupdatedAtstring (data)Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.
updatedAtstring (data)sempre presenteData da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHERupdatedAtstring (data)sempre presenteData da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsAmountintegersempre presenteSoma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceTotalAmountintegersempre presenteValor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.
ACTIVEINACTIVE
sharedIdstringsempre presenteID do checkout, o mesmo de checkoutSharedId na raiz.
statusstringsempre presenteStatus do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.
ACTIVEINACTIVE
checkoutPurchaseChoiceIdstring ou nullID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.
checkoutSharedIdstringsempre presenteID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.
createdAtstring (data)sempre presenteData em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.
eventTypestring = "purchase.lead_captured"sempre presenteNome do evento que gerou este envio.
organizationstringsempre presenteID da sua organização na EngagED.
paymentsarraysempre presenteTodas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.
queryParamsobjectsempre presente1 campoParâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.
{chave}stringValor do parâmetro de URL, com o mesmo nome que estava no link (ex.: utm_source, utm_campaign).
statusstringsempre presenteStatus da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).
DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOIDupdatedAtstring (data)sempre presenteData da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.
userobjectsempre presente6 camposA pessoa que fez a compra.
_idstringsempre presenteID da pessoa na EngagED. É o mesmo em todas as compras dela.
customFieldsAnswersobject1 campoRespostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.
{chave}object5 camposResposta a um campo personalizado.
_idstringsempre presenteID da resposta.
documentTypestringSó em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.
BR_CNPJBR_CPFtypestringsempre presenteTipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).
DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORTupdatedAtstring (data)sempre presenteData da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.
valueinteger | stringsempre presenteA resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.
emailstringsempre presenteE-mail informado no checkout.
namestringsempre presenteNome completo informado no checkout.
phoneNumberstring ou nullsempre presenteTelefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.
phoneNumberCountrystring ou nullsempre presentePaís do telefone, em código ISO 3166 de duas letras (ex.: BR).
Dados fictícios, com a mesma estrutura de um envio real.
purchase.open.payment.canceled
Quando uma compra é cancelada após ter sido gerada no Checkout. Isso ocorre quando um PIX ou Boleto é gerado, e o usuário pagador opta por cancelar para voltar ao checkout e optar por outro método de pagamento.
A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: status = OPEN e o boleto ou PIX gerado foi cancelado (pagamento em CANCELED).
Campos
_idstringsempre presenteID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).
checkoutobjectsempre presente5 camposO checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.
_idstringsempre presenteID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.
descriptionstring ou nullsempre presenteDescrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.
purchaseChoicesobject1 campoOpções de venda do checkout.
choicesarray de objectsempre presente8 camposLista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.
_idstringsempre presenteID da opção de venda.
appearanceobjectsempre presente7 camposComo a opção de venda aparece para o comprador no checkout.
_idstringsempre presenteID da configuração de aparência.
badgeTextstringSelo de destaque exibido na opção (ex.: "Mais vendido").
createdAtstring (data)sempre presenteData em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.
descriptionstringTexto de apoio exibido abaixo do nome da opção.
namestringsempre presenteNome da opção de venda exibido no checkout (ex.: "Plano anual").
updatedAtstring (data)sempre presenteData da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.
valueDisplayobjectsempre presente6 camposComo o valor da opção é mostrado no checkout.
_idstringsempre presenteID da configuração de exibição do valor.
createdAtstring (data)sempre presenteData em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.
priceTextstringSó em CUSTOM: texto exibido no lugar do valor.
supportTextstringSó em CUSTOM: texto de apoio exibido junto ao valor.
typestringsempre presenteAUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.
AUTOMATICCUSTOMupdatedAtstring (data)sempre presenteData da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.
defaultbooleansempre presentetrue na opção que aparece selecionada quando a pessoa abre o checkout.
invoiceDiscountedAmountintegersempre presenteTotal de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceItemsarray de objectsempre presente7 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
productobjectsempre presente8 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
createdAtstring (data)sempre presenteData em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.
descriptionstring ou nullsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray ou nullsempre presenteMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
namestringsempre presenteNome do produto.
priceobjectsempre presente7 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente5 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
createdAtstring (data)Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
updatedAtstring (data)Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.
createdAtstring (data)sempre presenteData em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente6 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
createdAtstring (data)Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRINGupdatedAtstring (data)Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.
updatedAtstring (data)sempre presenteData da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHERupdatedAtstring (data)sempre presenteData da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.
productPricestringsempre presenteID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsAmountintegersempre presenteSoma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceTotalAmountintegersempre presenteValor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.
ACTIVEINACTIVE
sharedIdstringsempre presenteID do checkout, o mesmo de checkoutSharedId na raiz.
statusstringsempre presenteStatus do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.
ACTIVEINACTIVE
checkoutPurchaseChoiceIdstringID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.
checkoutSharedIdstringsempre presenteID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.
createdAtstring (data)sempre presenteData em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.
eventTypestring = "purchase.open.payment.canceled"sempre presenteNome do evento que gerou este envio.
invoiceobjectsempre presente10 camposA fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.
_idstringsempre presenteID da fatura.
discountedAmountintegersempre presenteTotal de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).
discountsarray de objectsempre presente11 camposDescontos aplicados na fatura.
_idstringsempre presenteID do desconto.
amountintegersempre presenteValor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
descriptionstringTexto do desconto, como aparece para o comprador (ex.: "Primeira compra").
installmentnullSó em PAYMENT_METHOD: número de parcelas a que o desconto se aplica. null quando vale para qualquer parcelamento.
paymentMethodstringSó em PAYMENT_METHOD: forma de pagamento que dá direito ao desconto.
BANK_SLIPCREDIT_CARDMONEYPIXpercentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
updatedBystringID de quem alterou o desconto pela última vez.
dueAmountintegersempre presenteValor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).
itemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject6 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
descriptionstring ou nullsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray ou nullsempre presenteMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
namestringsempre presenteNome do produto.
priceobjectsempre presente5 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente5 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
createdAtstring (data)Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
updatedAtstring (data)Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente6 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
createdAtstring (data)Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRINGupdatedAtstring (data)Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHER
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
itemsAmountintegersempre presenteSoma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
paidAmountintegersempre presenteValor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).
refundedAmountintegersempre presenteValor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da fatura.
DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOIDtotalAmountintegersempre presenteValor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).
organizationstringsempre presenteID da sua organização na EngagED.
paymentsarray de objectsempre presente13 camposTodas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.
_idstringsempre presenteID do pagamento.
additionalAdvanceFeeintegersempre presenteJuros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).
amountintegersempre presenteValor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).
codestringsempre presenteSó em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.
createdAtstring (data)sempre presenteData em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do pagamento, em código ISO 4217 (ex.: BRL).
expirationDatestring (data)sempre presenteSó em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.
installmentsintegersempre presenteNúmero de parcelas. Em boleto e PIX é sempre 1.
paymentMethodstringsempre presenteForma de pagamento. BANK_SLIP é boleto.
BANK_SLIPCREDIT_CARDMONEYPIXqrCodeUrlstringSó em PIX: URL da imagem do QR Code.
refundedAmountintegersempre presenteValor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.
ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENTstatusAtstring (data)sempre presenteData em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.
queryParamsobjectsempre presente1 campoParâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.
{chave}stringValor do parâmetro de URL, com o mesmo nome que estava no link (ex.: utm_source, utm_campaign).
statusstringsempre presenteStatus da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).
DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOIDupdatedAtstring (data)sempre presenteData da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.
userobjectsempre presente6 camposA pessoa que fez a compra.
_idstringsempre presenteID da pessoa na EngagED. É o mesmo em todas as compras dela.
customFieldsAnswersobject1 campoRespostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.
{chave}object5 camposResposta a um campo personalizado.
_idstringsempre presenteID da resposta.
documentTypestringSó em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.
BR_CNPJBR_CPFtypestringsempre presenteTipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).
DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORTupdatedAtstring (data)sempre presenteData da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteA resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.
emailstringsempre presenteE-mail informado no checkout.
namestringsempre presenteNome completo informado no checkout.
phoneNumberstringsempre presenteTelefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.
phoneNumberCountrystringsempre presentePaís do telefone, em código ISO 3166 de duas letras (ex.: BR).
userPaymentProfileobjectsempre presente9 camposDados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.
_idstringsempre presenteID do perfil de cobrança.
addressobject ou nullsempre presente8 camposEndereço de cobrança. Vem null quando o checkout não pede endereço.
cityobjectsempre presente2 camposCidade.
metadataarray de objectsempre presente2 camposCódigos oficiais da cidade, em pares chave e valor.
keystringsempre presenteNome do código (ex.: ibge_id).
valuestringsempre presenteValor do código (ex.: o código IBGE da cidade).
namestringsempre presenteNome da cidade.
complementstringComplemento. Só aparece quando foi preenchido.
countrystringsempre presentePaís do endereço, em código ISO 3166 de duas letras (ex.: BR).
neighborhoodstringsempre presenteBairro.
numberstring ou nullsempre presenteNúmero. Pode vir null.
stateobjectsempre presente3 camposEstado.
codestringsempre presenteSigla do estado (ex.: PR).
metadataarray de objectsempre presente2 camposCódigos oficiais do estado, em pares chave e valor.
keystringsempre presenteNome do código (ex.: ibge_id).
valuestringsempre presenteValor do código (ex.: o código IBGE do estado).
namestringsempre presenteNome do estado.
streetstringsempre presenteLogradouro.
zipcodestringsempre presenteCEP, só com dígitos.
countrystringsempre presentePaís do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).
namestringsempre presenteNome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).
taxIdsarray de objectsempre presente6 camposDocumentos fiscais do titular.
_idstringsempre presenteID do documento.
countrystringsempre presentePaís do documento, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do documento. No Brasil: BR_CPF ou BR_CNPJ.
BR_CNPJBR_CPFPASSPORTupdatedAtstring (data)sempre presenteData da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteNúmero do documento, só com dígitos (sem pontos, traço ou barra).
typestringsempre presenteTipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).
COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFITupdatedAtstring (data)sempre presenteData da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.
Dados fictícios, com a mesma estrutura de um envio real.
purchase.open.payment.waiting_payment
Quando uma compra tem seu status OPEN, e o pagamento vai para WAITING_PAYMENT.Isso ocorre quando um Boleto ou PIX é gerado no Checkout.
A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: status = OPEN e o pagamento mais recente em WAITING_PAYMENT, com código e vencimento do boleto ou PIX.
Campos
_idstringsempre presenteID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).
checkoutobjectsempre presente5 camposO checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.
_idstringsempre presenteID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.
descriptionstring ou nullsempre presenteDescrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.
purchaseChoicesobject1 campoOpções de venda do checkout.
choicesarray de objectsempre presente9 camposLista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.
_idstringsempre presenteID da opção de venda.
appearanceobjectsempre presente7 camposComo a opção de venda aparece para o comprador no checkout.
_idstringsempre presenteID da configuração de aparência.
badgeTextstringSelo de destaque exibido na opção (ex.: "Mais vendido").
createdAtstring (data)sempre presenteData em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.
descriptionstringTexto de apoio exibido abaixo do nome da opção.
namestringsempre presenteNome da opção de venda exibido no checkout (ex.: "Plano anual").
updatedAtstring (data)sempre presenteData da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.
valueDisplayobjectsempre presente6 camposComo o valor da opção é mostrado no checkout.
_idstringsempre presenteID da configuração de exibição do valor.
createdAtstring (data)sempre presenteData em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.
priceTextstringSó em CUSTOM: texto exibido no lugar do valor.
supportTextstringSó em CUSTOM: texto de apoio exibido junto ao valor.
typestringsempre presenteAUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.
AUTOMATICCUSTOMupdatedAtstring (data)sempre presenteData da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.
defaultbooleansempre presentetrue na opção que aparece selecionada quando a pessoa abre o checkout.
invoiceDiscountedAmountintegersempre presenteTotal de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceDiscountsarray de object8 camposDescontos configurados na opção de venda. Só aparece quando a opção tem algum.
_idstringsempre presenteID do desconto.
amountintegersempre presenteValor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
descriptionstringsempre presenteTexto do desconto, como aparece para o comprador (ex.: "Primeira compra").
percentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject8 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
createdAtstring (data)sempre presenteData em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.
descriptionstring ou nullsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray de object ou nullsempre presente5 camposMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
_idstringsempre presenteID do metadado.
createdAtstring (data)sempre presenteData em que o metadado foi criado. Data e hora em ISO 8601, no fuso UTC.
keystringsempre presenteChave do metadado, como foi cadastrada no produto.
updatedAtstring (data)sempre presenteData da última alteração do metadado. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteValor do metadado.
namestringsempre presenteNome do produto.
priceobjectsempre presente7 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente5 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
createdAtstring (data)Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
updatedAtstring (data)Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.
createdAtstring (data)sempre presenteData em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente6 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
createdAtstring (data)Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRINGupdatedAtstring (data)Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.
updatedAtstring (data)sempre presenteData da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHERupdatedAtstring (data)sempre presenteData da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsAmountintegersempre presenteSoma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceTotalAmountintegersempre presenteValor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.
ACTIVEINACTIVE
sharedIdstringsempre presenteID do checkout, o mesmo de checkoutSharedId na raiz.
statusstringsempre presenteStatus do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.
ACTIVEINACTIVE
checkoutPurchaseChoiceIdstringID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.
checkoutSharedIdstringsempre presenteID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.
createdAtstring (data)sempre presenteData em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.
eventTypestring = "purchase.open.payment.waiting_payment"sempre presenteNome do evento que gerou este envio.
invoiceobjectsempre presente10 camposA fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.
_idstringsempre presenteID da fatura.
discountedAmountintegersempre presenteTotal de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).
discountsarray de objectsempre presente13 camposDescontos aplicados na fatura.
_idstringsempre presenteID do desconto.
amountintegerValor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
descriptionstringTexto do desconto, como aparece para o comprador (ex.: "Primeira compra").
installmentnullSó em PAYMENT_METHOD: número de parcelas a que o desconto se aplica. null quando vale para qualquer parcelamento.
paymentMethodstringSó em PAYMENT_METHOD: forma de pagamento que dá direito ao desconto.
BANK_SLIPCREDIT_CARDMONEYPIXpercentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
redemptionobject6 camposSó em VOUCHER: o resgate do cupom nesta compra.
_idstringsempre presenteID do resgate.
createdAtstring (data)sempre presenteData em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.
discountedAmountintegersempre presenteValor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).
redeemedAtstring (data)sempre presenteData em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.
redeemedCodestringsempre presenteCódigo do cupom como o comprador digitou.
updatedAtstring (data)sempre presenteData da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
updatedBystringID de quem alterou o desconto pela última vez.
voucherstringSó em VOUCHER: ID do cupom usado.
dueAmountintegersempre presenteValor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).
itemsarray de objectsempre presente10 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
orderBumpIdstringSó nos itens que entraram pela oferta adicional (order bump) do checkout: ID dessa oferta. Itens escolhidos normalmente não têm este campo.
productobject6 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
descriptionstring ou nullsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray de object ou nullsempre presente5 camposMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
_idstringsempre presenteID do metadado.
createdAtstring (data)sempre presenteData em que o metadado foi criado. Data e hora em ISO 8601, no fuso UTC.
keystringsempre presenteChave do metadado, como foi cadastrada no produto.
updatedAtstring (data)sempre presenteData da última alteração do metadado. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteValor do metadado.
namestringsempre presenteNome do produto.
priceobjectsempre presente5 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente5 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
createdAtstring (data)Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
updatedAtstring (data)Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente6 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
createdAtstring (data)Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRINGupdatedAtstring (data)Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHER
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
itemsAmountintegersempre presenteSoma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
paidAmountintegersempre presenteValor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).
refundedAmountintegersempre presenteValor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da fatura.
DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOIDtotalAmountintegersempre presenteValor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).
organizationstringsempre presenteID da sua organização na EngagED.
paymentsarray de objectsempre presente13 camposTodas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.
_idstringsempre presenteID do pagamento.
additionalAdvanceFeeintegersempre presenteJuros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).
amountintegersempre presenteValor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).
codestring ou nullSó em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.
createdAtstring (data)sempre presenteData em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do pagamento, em código ISO 4217 (ex.: BRL).
expirationDatestring (data) ou nullSó em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.
installmentsintegersempre presenteNúmero de parcelas. Em boleto e PIX é sempre 1.
paymentMethodstringsempre presenteForma de pagamento. BANK_SLIP é boleto.
BANK_SLIPCREDIT_CARDMONEYPIXqrCodeUrlstring ou nullSó em PIX: URL da imagem do QR Code.
refundedAmountintegersempre presenteValor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.
ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENTstatusAtstring (data)sempre presenteData em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.
queryParamsobjectsempre presente1 campoParâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.
{chave}stringValor do parâmetro de URL, com o mesmo nome que estava no link (ex.: utm_source, utm_campaign).
statusstringsempre presenteStatus da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).
DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOIDupdatedAtstring (data)sempre presenteData da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.
userobjectsempre presente6 camposA pessoa que fez a compra.
_idstringsempre presenteID da pessoa na EngagED. É o mesmo em todas as compras dela.
customFieldsAnswersobject1 campoRespostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.
{chave}object5 camposResposta a um campo personalizado.
_idstringsempre presenteID da resposta.
documentTypestringSó em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.
BR_CNPJBR_CPFtypestringsempre presenteTipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).
DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORTupdatedAtstring (data)sempre presenteData da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.
valueinteger | stringsempre presenteA resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.
emailstringsempre presenteE-mail informado no checkout.
namestringsempre presenteNome completo informado no checkout.
phoneNumberstringsempre presenteTelefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.
phoneNumberCountrystringsempre presentePaís do telefone, em código ISO 3166 de duas letras (ex.: BR).
userPaymentProfileobjectsempre presente9 camposDados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.
_idstringsempre presenteID do perfil de cobrança.
addressobject ou nullsempre presente8 camposEndereço de cobrança. Vem null quando o checkout não pede endereço.
cityobjectsempre presente2 camposCidade.
metadataarray de objectsempre presente2 camposCódigos oficiais da cidade, em pares chave e valor.
keystringsempre presenteNome do código (ex.: ibge_id).
valuestringsempre presenteValor do código (ex.: o código IBGE da cidade).
namestringsempre presenteNome da cidade.
complementstringComplemento. Só aparece quando foi preenchido.
countrystringsempre presentePaís do endereço, em código ISO 3166 de duas letras (ex.: BR).
neighborhoodstringsempre presenteBairro.
numberstring ou nullsempre presenteNúmero. Pode vir null.
stateobjectsempre presente3 camposEstado.
codestringsempre presenteSigla do estado (ex.: PR).
metadataarray de objectsempre presente2 camposCódigos oficiais do estado, em pares chave e valor.
keystringsempre presenteNome do código (ex.: ibge_id).
valuestringsempre presenteValor do código (ex.: o código IBGE do estado).
namestringsempre presenteNome do estado.
streetstringsempre presenteLogradouro.
zipcodestringsempre presenteCEP, só com dígitos.
countrystringsempre presentePaís do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).
namestringsempre presenteNome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).
taxIdsarray de objectsempre presente6 camposDocumentos fiscais do titular.
_idstringsempre presenteID do documento.
countrystringsempre presentePaís do documento, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do documento. No Brasil: BR_CPF ou BR_CNPJ.
BR_CNPJBR_CPFPASSPORTupdatedAtstring (data)sempre presenteData da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteNúmero do documento, só com dígitos (sem pontos, traço ou barra).
typestringsempre presenteTipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).
COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFITupdatedAtstring (data)sempre presenteData da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.
Dados fictícios, com a mesma estrutura de um envio real.
purchase.paid
Quando uma compra é efetivada no Checkout.
A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: status = PAID e o pagamento mais recente em PAID. Se algum produto for recorrente, vem também o bloco subscription.
Campos
_idstringsempre presenteID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).
checkoutobjectsempre presente5 camposO checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.
_idstringsempre presenteID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.
descriptionstring ou nullsempre presenteDescrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.
purchaseChoicesobject1 campoOpções de venda do checkout.
choicesarray de objectsempre presente9 camposLista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.
_idstringsempre presenteID da opção de venda.
appearanceobjectsempre presente7 camposComo a opção de venda aparece para o comprador no checkout.
_idstringsempre presenteID da configuração de aparência.
badgeTextstringSelo de destaque exibido na opção (ex.: "Mais vendido").
createdAtstring (data)sempre presenteData em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.
descriptionstringTexto de apoio exibido abaixo do nome da opção.
namestringsempre presenteNome da opção de venda exibido no checkout (ex.: "Plano anual").
updatedAtstring (data)sempre presenteData da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.
valueDisplayobjectsempre presente6 camposComo o valor da opção é mostrado no checkout.
_idstringsempre presenteID da configuração de exibição do valor.
createdAtstring (data)sempre presenteData em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.
priceTextstringSó em CUSTOM: texto exibido no lugar do valor.
supportTextstringSó em CUSTOM: texto de apoio exibido junto ao valor.
typestringsempre presenteAUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.
AUTOMATICCUSTOMupdatedAtstring (data)sempre presenteData da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.
defaultbooleansempre presentetrue na opção que aparece selecionada quando a pessoa abre o checkout.
invoiceDiscountedAmountintegersempre presenteTotal de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceDiscountsarray de object8 camposDescontos configurados na opção de venda. Só aparece quando a opção tem algum.
_idstringsempre presenteID do desconto.
amountintegersempre presenteValor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
descriptionstringsempre presenteTexto do desconto, como aparece para o comprador (ex.: "Primeira compra").
percentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject8 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
createdAtstring (data)sempre presenteData em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.
descriptionstring ou nullsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray de object ou nullsempre presente5 camposMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
_idstringsempre presenteID do metadado.
createdAtstring (data)sempre presenteData em que o metadado foi criado. Data e hora em ISO 8601, no fuso UTC.
keystringsempre presenteChave do metadado, como foi cadastrada no produto.
updatedAtstring (data)sempre presenteData da última alteração do metadado. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteValor do metadado.
namestringsempre presenteNome do produto.
priceobjectsempre presente7 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente5 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
createdAtstring (data)Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
updatedAtstring (data)Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.
createdAtstring (data)sempre presenteData em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente6 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
createdAtstring (data)Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRINGupdatedAtstring (data)Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.
updatedAtstring (data)sempre presenteData da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHERupdatedAtstring (data)sempre presenteData da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsAmountintegersempre presenteSoma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceTotalAmountintegersempre presenteValor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.
ACTIVEINACTIVE
sharedIdstringsempre presenteID do checkout, o mesmo de checkoutSharedId na raiz.
statusstringsempre presenteStatus do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.
ACTIVEINACTIVE
checkoutPurchaseChoiceIdstringID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.
checkoutSharedIdstringsempre presenteID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.
createdAtstring (data)sempre presenteData em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.
eventTypestring = "purchase.paid"sempre presenteNome do evento que gerou este envio.
invoiceobjectsempre presente10 camposA fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.
_idstringsempre presenteID da fatura.
discountedAmountintegersempre presenteTotal de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).
discountsarray de objectsempre presente13 camposDescontos aplicados na fatura.
_idstringsempre presenteID do desconto.
amountintegerValor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
descriptionstringTexto do desconto, como aparece para o comprador (ex.: "Primeira compra").
installmentinteger ou nullSó em PAYMENT_METHOD: número de parcelas a que o desconto se aplica. null quando vale para qualquer parcelamento.
paymentMethodstringSó em PAYMENT_METHOD: forma de pagamento que dá direito ao desconto.
BANK_SLIPCREDIT_CARDMONEYPIXpercentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
redemptionobject6 camposSó em VOUCHER: o resgate do cupom nesta compra.
_idstringsempre presenteID do resgate.
createdAtstring (data)sempre presenteData em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.
discountedAmountintegersempre presenteValor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).
redeemedAtstring (data)sempre presenteData em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.
redeemedCodestringsempre presenteCódigo do cupom como o comprador digitou.
updatedAtstring (data)sempre presenteData da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
updatedBystringID de quem alterou o desconto pela última vez.
voucherstringSó em VOUCHER: ID do cupom usado.
dueAmountintegersempre presenteValor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).
itemsarray de objectsempre presente10 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
orderBumpIdstringSó nos itens que entraram pela oferta adicional (order bump) do checkout: ID dessa oferta. Itens escolhidos normalmente não têm este campo.
productobject6 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
descriptionstring ou nullsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray de object ou nullsempre presente5 camposMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
_idstringsempre presenteID do metadado.
createdAtstring (data)sempre presenteData em que o metadado foi criado. Data e hora em ISO 8601, no fuso UTC.
keystringsempre presenteChave do metadado, como foi cadastrada no produto.
updatedAtstring (data)sempre presenteData da última alteração do metadado. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteValor do metadado.
namestringsempre presenteNome do produto.
priceobjectsempre presente5 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente5 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
createdAtstring (data)Data em que a configuração de valor foi criada. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
updatedAtstring (data)Data da última alteração da configuração de valor. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente6 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
createdAtstring (data)Data em que a configuração de cobrança foi criada. Data e hora em ISO 8601, no fuso UTC.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)Data em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)Data da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRINGupdatedAtstring (data)Data da última alteração da configuração de cobrança. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHER
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
itemsAmountintegersempre presenteSoma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
paidAmountintegersempre presenteValor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).
refundedAmountintegersempre presenteValor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da fatura.
DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOIDtotalAmountintegersempre presenteValor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).
organizationstringsempre presenteID da sua organização na EngagED.
paymentsarray de objectsempre presente13 camposTodas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.
_idstringsempre presenteID do pagamento.
additionalAdvanceFeeintegersempre presenteJuros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).
amountintegersempre presenteValor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).
codestring ou nullSó em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.
createdAtstring (data)sempre presenteData em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do pagamento, em código ISO 4217 (ex.: BRL).
expirationDatestring (data) ou nullSó em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.
installmentsintegersempre presenteNúmero de parcelas. Em boleto e PIX é sempre 1.
paymentMethodstringsempre presenteForma de pagamento. BANK_SLIP é boleto.
BANK_SLIPCREDIT_CARDMONEYPIXqrCodeUrlstring ou nullSó em PIX: URL da imagem do QR Code.
refundedAmountintegersempre presenteValor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.
ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENTstatusAtstring (data)sempre presenteData em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.
queryParamsobjectsempre presente1 campoParâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.
{chave}stringValor do parâmetro de URL, com o mesmo nome que estava no link (ex.: utm_source, utm_campaign).
statusstringsempre presenteStatus da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).
DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOIDsubscriptionobject7 camposSó no purchase.paid de uma compra com produto recorrente: a assinatura criada por esta compra, com o cronograma de cobranças.
_idstringsempre presenteID da assinatura. É o mesmo que aparece nos eventos subscription.* e subscription.charge.*.
billingobjectsempre presente2 camposCobranças da assinatura.
chargesarray de objectsempre presente8 camposCronograma de cobranças da assinatura, das já geradas às futuras, em ordem de data.
_idstringsempre presenteID da cobrança.
amountintegersempre presenteValor da cobrança. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que a cobrança entrou no cronograma. Data e hora em ISO 8601, no fuso UTC.
expirationDatestring (data)sempre presenteData de vencimento da cobrança. Data e hora em ISO 8601, no fuso UTC.
generationDatestring (data)sempre presenteData em que a cobrança é gerada (no boleto, quando o boleto é emitido). Data e hora em ISO 8601, no fuso UTC.
invoiceIdstring ou nullsempre presenteID da fatura desta cobrança. Só aparece nas cobranças já geradas.
paymentMethodstringsempre presenteForma de pagamento da cobrança.
BANK_SLIPCREDIT_CARDMONEYPIXupdatedAtstring (data)sempre presenteData da última alteração da cobrança. Data e hora em ISO 8601, no fuso UTC.
nextInvoiceobjectsempre presente5 camposA próxima cobrança a ser gerada. É um dos itens de charges.
_idstringsempre presenteID da cobrança.
amountintegersempre presenteValor da cobrança. Valor em centavos (ex.: 9990 = R$ 99,90).
expirationDatestring (data)sempre presenteData de vencimento da cobrança. Data e hora em ISO 8601, no fuso UTC.
generationDatestring (data)sempre presenteData em que a cobrança é gerada (no boleto, quando o boleto é emitido). Data e hora em ISO 8601, no fuso UTC.
paymentMethodstringsempre presenteForma de pagamento da cobrança.
BANK_SLIPCREDIT_CARDMONEYPIX
createdAtstring (data)sempre presenteData em que a assinatura foi criada. Data e hora em ISO 8601, no fuso UTC.
intervalobjectsempre presente2 camposDe quanto em quanto tempo a assinatura é cobrada.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês).
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEAR
statusstringsempre presenteStatus da assinatura.
ACTIVECANCELEDFINISHEDLATEstatusAtstring (data)sempre presenteData em que a assinatura entrou no status atual. Data e hora em ISO 8601, no fuso UTC.
updatedAtstring (data)sempre presenteData da última alteração da assinatura. Data e hora em ISO 8601, no fuso UTC.
updatedAtstring (data)sempre presenteData da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.
userobjectsempre presente6 camposA pessoa que fez a compra.
_idstringsempre presenteID da pessoa na EngagED. É o mesmo em todas as compras dela.
customFieldsAnswersobject1 campoRespostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.
{chave}object5 camposResposta a um campo personalizado.
_idstringsempre presenteID da resposta.
documentTypestringSó em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.
BR_CNPJBR_CPFtypestringsempre presenteTipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).
DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORTupdatedAtstring (data)sempre presenteData da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.
valuearray de string | integer | string ou nullsempre presenteA resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.
emailstringsempre presenteE-mail informado no checkout.
namestringsempre presenteNome completo informado no checkout.
phoneNumberstringsempre presenteTelefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.
phoneNumberCountrystringsempre presentePaís do telefone, em código ISO 3166 de duas letras (ex.: BR).
userPaymentProfileobjectsempre presente9 camposDados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.
_idstringsempre presenteID do perfil de cobrança.
addressobject ou nullsempre presente8 camposEndereço de cobrança. Vem null quando o checkout não pede endereço.
cityobjectsempre presente2 camposCidade.
metadataarray de objectsempre presente2 camposCódigos oficiais da cidade, em pares chave e valor.
keystringsempre presenteNome do código (ex.: ibge_id).
valuestringsempre presenteValor do código (ex.: o código IBGE da cidade).
namestringsempre presenteNome da cidade.
complementstringComplemento. Só aparece quando foi preenchido.
countrystringsempre presentePaís do endereço, em código ISO 3166 de duas letras (ex.: BR).
neighborhoodstringsempre presenteBairro.
numberstring ou nullsempre presenteNúmero. Pode vir null.
stateobjectsempre presente3 camposEstado.
codestringsempre presenteSigla do estado (ex.: PR).
metadataarray de objectsempre presente2 camposCódigos oficiais do estado, em pares chave e valor.
keystringsempre presenteNome do código (ex.: ibge_id).
valuestringsempre presenteValor do código (ex.: o código IBGE do estado).
namestringsempre presenteNome do estado.
streetstringsempre presenteLogradouro.
zipcodestringsempre presenteCEP, só com dígitos.
countrystringsempre presentePaís do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).
namestringsempre presenteNome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).
taxIdsarray de objectsempre presente6 camposDocumentos fiscais do titular.
_idstringsempre presenteID do documento.
countrystringsempre presentePaís do documento, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do documento. No Brasil: BR_CPF ou BR_CNPJ.
BR_CNPJBR_CPFPASSPORTupdatedAtstring (data)sempre presenteData da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteNúmero do documento, só com dígitos (sem pontos, traço ou barra).
typestringsempre presenteTipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).
COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFITupdatedAtstring (data)sempre presenteData da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.
Dados fictícios, com a mesma estrutura de um envio real.
purchase.partially_refunded
Quando uma compra tem seu status PARTIALLY_REFUNDED, e o pagamento também vai para PARTIALLY_REFUNDED. Isso ocorre quando parte do valor de uma compra já paga é devolvida ao pagador. Pode ocorrer mais de uma vez para a mesma compra, e o campo refundedAmount do pagamento é acumulado.
A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: o pagamento está em PARTIALLY_REFUNDED e refundedAmount mostra o total já devolvido. Cada novo reembolso parcial gera um novo evento.
Campos
_idstringsempre presenteID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).
checkoutobjectsempre presente5 camposO checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.
_idstringsempre presenteID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.
descriptionstringsempre presenteDescrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.
purchaseChoicesobjectsempre presente1 campoOpções de venda do checkout.
choicesarray de objectsempre presente8 camposLista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.
_idstringsempre presenteID da opção de venda.
appearanceobjectsempre presente5 camposComo a opção de venda aparece para o comprador no checkout.
_idstringsempre presenteID da configuração de aparência.
createdAtstring (data)sempre presenteData em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.
namestringsempre presenteNome da opção de venda exibido no checkout (ex.: "Plano anual").
updatedAtstring (data)sempre presenteData da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.
valueDisplayobjectsempre presente6 camposComo o valor da opção é mostrado no checkout.
_idstringsempre presenteID da configuração de exibição do valor.
createdAtstring (data)sempre presenteData em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.
priceTextstringSó em CUSTOM: texto exibido no lugar do valor.
supportTextstringSó em CUSTOM: texto de apoio exibido junto ao valor.
typestringsempre presenteAUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.
AUTOMATICCUSTOMupdatedAtstring (data)sempre presenteData da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.
defaultbooleansempre presentetrue na opção que aparece selecionada quando a pessoa abre o checkout.
invoiceDiscountedAmountintegersempre presenteTotal de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceItemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject8 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
createdAtstring (data)sempre presenteData em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.
descriptionstringsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray ou nullsempre presenteMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
namestringsempre presenteNome do produto.
priceobjectsempre presente7 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente3 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente4 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRING
updatedAtstring (data)sempre presenteData da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHERupdatedAtstring (data)sempre presenteData da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsAmountintegersempre presenteSoma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceTotalAmountintegersempre presenteValor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.
ACTIVEINACTIVE
sharedIdstringsempre presenteID do checkout, o mesmo de checkoutSharedId na raiz.
statusstringsempre presenteStatus do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.
ACTIVEINACTIVE
checkoutPurchaseChoiceIdstringsempre presenteID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.
checkoutSharedIdstringsempre presenteID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.
createdAtstring (data)sempre presenteData em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.
eventTypestring = "purchase.partially_refunded"sempre presenteNome do evento que gerou este envio.
invoiceobjectsempre presente10 camposA fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.
_idstringsempre presenteID da fatura.
discountedAmountintegersempre presenteTotal de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).
discountsarray de objectsempre presente9 camposDescontos aplicados na fatura.
_idstringsempre presenteID do desconto.
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
percentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
redemptionobjectsempre presente6 camposSó em VOUCHER: o resgate do cupom nesta compra.
_idstringsempre presenteID do resgate.
createdAtstring (data)sempre presenteData em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.
discountedAmountintegersempre presenteValor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).
redeemedAtstring (data)sempre presenteData em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.
redeemedCodestringsempre presenteCódigo do cupom como o comprador digitou.
updatedAtstring (data)sempre presenteData da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
updatedBystringsempre presenteID de quem alterou o desconto pela última vez.
voucherstringsempre presenteSó em VOUCHER: ID do cupom usado.
dueAmountintegersempre presenteValor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).
itemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject6 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
descriptionstringsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray ou nullsempre presenteMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
namestringsempre presenteNome do produto.
priceobjectsempre presente5 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente3 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente4 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRING
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHER
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
itemsAmountintegersempre presenteSoma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
paidAmountintegersempre presenteValor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).
refundedAmountintegersempre presenteValor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da fatura.
DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOIDtotalAmountintegersempre presenteValor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).
organizationstringsempre presenteID da sua organização na EngagED.
paymentsarray de objectsempre presente11 camposTodas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.
_idstringsempre presenteID do pagamento.
additionalAdvanceFeeintegersempre presenteJuros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).
amountintegersempre presenteValor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do pagamento, em código ISO 4217 (ex.: BRL).
installmentsintegersempre presenteNúmero de parcelas. Em boleto e PIX é sempre 1.
paymentMethodstringsempre presenteForma de pagamento. BANK_SLIP é boleto.
BANK_SLIPCREDIT_CARDMONEYPIXrefundedAmountintegersempre presenteValor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).
refundsarray de object7 camposHistórico de reembolsos deste pagamento, do mais antigo para o mais recente, com todos os status (inclusive os que falharam). Só aparece quando o pagamento teve algum reembolso. Não some os amount daqui para saber o total devolvido; use refundedAmount.
_idstringsempre presenteID do reembolso.
amountintegersempre presenteValor deste reembolso isolado. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o reembolso foi solicitado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do reembolso, em código ISO 4217 (ex.: BRL).
descriptionstringsempre presenteObservação livre escrita pelo administrador ao fazer o reembolso. Só aparece quando foi preenchida.
reasonstringsempre presenteMotivo do reembolso informado pelo administrador.
DUPLICATEFRAUDULENTOTHERREQUESTED_BY_CUSTOMERstatusstringsempre presenteStatus do reembolso. PAID é o reembolso concluído.
CANCELEDFAILEDPAIDPENDING
statusstringsempre presenteStatus do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.
ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENTstatusAtstring (data)sempre presenteData em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.
queryParamsobjectsempre presenteParâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.
statusstringsempre presenteStatus da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).
DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOIDupdatedAtstring (data)sempre presenteData da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.
userobjectsempre presente6 camposA pessoa que fez a compra.
_idstringsempre presenteID da pessoa na EngagED. É o mesmo em todas as compras dela.
customFieldsAnswersobject1 campoRespostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.
{chave}object5 camposResposta a um campo personalizado.
_idstringsempre presenteID da resposta.
documentTypestringSó em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.
BR_CNPJBR_CPFtypestringsempre presenteTipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).
DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORTupdatedAtstring (data)sempre presenteData da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.
valueinteger | stringsempre presenteA resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.
emailstringsempre presenteE-mail informado no checkout.
namestringsempre presenteNome completo informado no checkout.
phoneNumberstringsempre presenteTelefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.
phoneNumberCountrystringsempre presentePaís do telefone, em código ISO 3166 de duas letras (ex.: BR).
userPaymentProfileobjectsempre presente9 camposDados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.
_idstringsempre presenteID do perfil de cobrança.
addressnullsempre presenteEndereço de cobrança. Vem null quando o checkout não pede endereço.
countrystringsempre presentePaís do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).
namestringsempre presenteNome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).
taxIdsarray de objectsempre presente6 camposDocumentos fiscais do titular.
_idstringsempre presenteID do documento.
countrystringsempre presentePaís do documento, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do documento. No Brasil: BR_CPF ou BR_CNPJ.
BR_CNPJBR_CPFPASSPORTupdatedAtstring (data)sempre presenteData da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteNúmero do documento, só com dígitos (sem pontos, traço ou barra).
typestringsempre presenteTipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).
COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFITupdatedAtstring (data)sempre presenteData da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.
Dados fictícios, com a mesma estrutura de um envio real.
purchase.refunded
Quando uma compra tem seu status REFUNDED, e o pagamento também vai para REFUNDED. Isso ocorre quando o valor total de uma compra já paga é devolvido ao pagador.
A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: o pagamento reembolsado está em REFUNDED; veja payments[].refunds para o histórico.
Campos
_idstringsempre presenteID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).
checkoutobjectsempre presente5 camposO checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.
_idstringsempre presenteID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.
descriptionstringsempre presenteDescrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.
purchaseChoicesobjectsempre presente1 campoOpções de venda do checkout.
choicesarray de objectsempre presente8 camposLista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.
_idstringsempre presenteID da opção de venda.
appearanceobjectsempre presente5 camposComo a opção de venda aparece para o comprador no checkout.
_idstringID da configuração de aparência.
createdAtstring (data)Data em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.
namestringsempre presenteNome da opção de venda exibido no checkout (ex.: "Plano anual").
updatedAtstring (data)Data da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.
valueDisplayobjectsempre presente6 camposComo o valor da opção é mostrado no checkout.
_idstringID da configuração de exibição do valor.
createdAtstring (data)Data em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.
priceTextstringSó em CUSTOM: texto exibido no lugar do valor.
supportTextstringSó em CUSTOM: texto de apoio exibido junto ao valor.
typestringsempre presenteAUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.
AUTOMATICCUSTOMupdatedAtstring (data)Data da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.
defaultbooleansempre presentetrue na opção que aparece selecionada quando a pessoa abre o checkout.
invoiceDiscountedAmountintegersempre presenteTotal de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceItemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject8 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
createdAtstring (data)sempre presenteData em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.
descriptionstringsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray de object ou nullsempre presente5 camposMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
_idstringsempre presenteID do metadado.
createdAtstring (data)sempre presenteData em que o metadado foi criado. Data e hora em ISO 8601, no fuso UTC.
keystringsempre presenteChave do metadado, como foi cadastrada no produto.
updatedAtstring (data)sempre presenteData da última alteração do metadado. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteValor do metadado.
namestringsempre presenteNome do produto.
priceobjectsempre presente7 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente3 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente4 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRING
updatedAtstring (data)sempre presenteData da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHERupdatedAtstring (data)sempre presenteData da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsAmountintegersempre presenteSoma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceTotalAmountintegersempre presenteValor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.
ACTIVEINACTIVE
sharedIdstringsempre presenteID do checkout, o mesmo de checkoutSharedId na raiz.
statusstringsempre presenteStatus do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.
ACTIVEINACTIVE
checkoutPurchaseChoiceIdstring ou nullsempre presenteID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.
checkoutSharedIdstringsempre presenteID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.
createdAtstring (data)sempre presenteData em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.
eventTypestring = "purchase.refunded"sempre presenteNome do evento que gerou este envio.
invoiceobjectsempre presente10 camposA fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.
_idstringsempre presenteID da fatura.
discountedAmountintegersempre presenteTotal de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).
discountsarray de objectsempre presente12 camposDescontos aplicados na fatura.
_idstringsempre presenteID do desconto.
amountintegerValor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
installmentnullSó em PAYMENT_METHOD: número de parcelas a que o desconto se aplica. null quando vale para qualquer parcelamento.
paymentMethodstringSó em PAYMENT_METHOD: forma de pagamento que dá direito ao desconto.
BANK_SLIPCREDIT_CARDMONEYPIXpercentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
redemptionobject6 camposSó em VOUCHER: o resgate do cupom nesta compra.
_idstringsempre presenteID do resgate.
createdAtstring (data)sempre presenteData em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.
discountedAmountintegersempre presenteValor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).
redeemedAtstring (data)sempre presenteData em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.
redeemedCodestringsempre presenteCódigo do cupom como o comprador digitou.
updatedAtstring (data)sempre presenteData da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
updatedBystringsempre presenteID de quem alterou o desconto pela última vez.
voucherstringSó em VOUCHER: ID do cupom usado.
dueAmountintegersempre presenteValor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).
itemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject6 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
descriptionstringsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray de object ou nullsempre presente5 camposMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
_idstringsempre presenteID do metadado.
createdAtstring (data)sempre presenteData em que o metadado foi criado. Data e hora em ISO 8601, no fuso UTC.
keystringsempre presenteChave do metadado, como foi cadastrada no produto.
updatedAtstring (data)sempre presenteData da última alteração do metadado. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteValor do metadado.
namestringsempre presenteNome do produto.
priceobjectsempre presente5 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente3 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente4 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRING
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHER
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
itemsAmountintegersempre presenteSoma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
paidAmountintegersempre presenteValor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).
refundedAmountintegersempre presenteValor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da fatura.
DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOIDtotalAmountintegersempre presenteValor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).
organizationstringsempre presenteID da sua organização na EngagED.
paymentsarray de objectsempre presente14 camposTodas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.
_idstringsempre presenteID do pagamento.
additionalAdvanceFeeintegersempre presenteJuros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).
amountintegersempre presenteValor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).
codestringSó em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.
createdAtstring (data)sempre presenteData em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do pagamento, em código ISO 4217 (ex.: BRL).
expirationDatestring (data)Só em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.
installmentsintegersempre presenteNúmero de parcelas. Em boleto e PIX é sempre 1.
paymentMethodstringsempre presenteForma de pagamento. BANK_SLIP é boleto.
BANK_SLIPCREDIT_CARDMONEYPIXqrCodeUrlstringSó em PIX: URL da imagem do QR Code.
refundedAmountintegersempre presenteValor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).
refundsarray de object7 camposHistórico de reembolsos deste pagamento, do mais antigo para o mais recente, com todos os status (inclusive os que falharam). Só aparece quando o pagamento teve algum reembolso. Não some os amount daqui para saber o total devolvido; use refundedAmount.
_idstringsempre presenteID do reembolso.
amountintegersempre presenteValor deste reembolso isolado. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o reembolso foi solicitado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do reembolso, em código ISO 4217 (ex.: BRL).
descriptionstringObservação livre escrita pelo administrador ao fazer o reembolso. Só aparece quando foi preenchida.
reasonstringsempre presenteMotivo do reembolso informado pelo administrador.
DUPLICATEFRAUDULENTOTHERREQUESTED_BY_CUSTOMERstatusstringsempre presenteStatus do reembolso. PAID é o reembolso concluído.
CANCELEDFAILEDPAIDPENDING
statusstringsempre presenteStatus do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.
ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENTstatusAtstring (data)sempre presenteData em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.
queryParamsobjectsempre presenteParâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.
statusstringsempre presenteStatus da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).
DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOIDupdatedAtstring (data)sempre presenteData da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.
userobjectsempre presente6 camposA pessoa que fez a compra.
_idstringsempre presenteID da pessoa na EngagED. É o mesmo em todas as compras dela.
customFieldsAnswersobject1 campoRespostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.
{chave}object5 camposResposta a um campo personalizado.
_idstringsempre presenteID da resposta.
documentTypestringSó em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.
BR_CNPJBR_CPFtypestringsempre presenteTipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).
DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORTupdatedAtstring (data)sempre presenteData da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.
valueinteger | stringsempre presenteA resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.
emailstringsempre presenteE-mail informado no checkout.
namestringsempre presenteNome completo informado no checkout.
phoneNumberstringsempre presenteTelefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.
phoneNumberCountrystringsempre presentePaís do telefone, em código ISO 3166 de duas letras (ex.: BR).
userPaymentProfileobjectsempre presente9 camposDados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.
_idstringsempre presenteID do perfil de cobrança.
addressnullsempre presenteEndereço de cobrança. Vem null quando o checkout não pede endereço.
countrystringsempre presentePaís do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).
namestringsempre presenteNome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).
taxIdsarray de objectsempre presente6 camposDocumentos fiscais do titular.
_idstringsempre presenteID do documento.
countrystringsempre presentePaís do documento, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do documento. No Brasil: BR_CPF ou BR_CNPJ.
BR_CNPJBR_CPFPASSPORTupdatedAtstring (data)sempre presenteData da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteNúmero do documento, só com dígitos (sem pontos, traço ou barra).
typestringsempre presenteTipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).
COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFITupdatedAtstring (data)sempre presenteData da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.
Dados fictícios, com a mesma estrutura de um envio real.
purchase.refused
Quando uma compra é recusada no Checkout.Isso ocorre quando uma compra no Cartão de Crédito é recusada.
A compra (purchase) no Checkout EngagED, como estava no momento do evento. Uma compra é o carrinho da pessoa no checkout: mantém o mesmo _id do primeiro dado deixado até o pagamento, mesmo depois de várias tentativas. Neste evento: status = REFUSED e o pagamento mais recente em REFUSED (cartão recusado pelo emissor).
Campos
_idstringsempre presenteID da compra. É o mesmo em todos os eventos da mesma compra, então use-o para ligar os eventos entre si (ex.: o purchase.refunded de uma compra que antes gerou purchase.paid).
checkoutobjectsempre presente5 camposO checkout em que a compra aconteceu, com todas as opções de venda configuradas nele, inclusive as desativadas.
_idstringsempre presenteID interno da versão do checkout. O checkout é versionado: para identificar o checkout use sharedId, que não muda entre versões.
descriptionstringsempre presenteDescrição interna do checkout, cadastrada no painel. Vem null quando não foi preenchida.
purchaseChoicesobjectsempre presente1 campoOpções de venda do checkout.
choicesarray de objectsempre presente9 camposLista das opções de venda do checkout (ex.: plano mensal e plano anual). A opção que a pessoa escolheu é a de _id igual a checkoutPurchaseChoiceId.
_idstringsempre presenteID da opção de venda.
appearanceobjectsempre presente5 camposComo a opção de venda aparece para o comprador no checkout.
_idstringsempre presenteID da configuração de aparência.
createdAtstring (data)sempre presenteData em que a aparência foi criada. Data e hora em ISO 8601, no fuso UTC.
namestringsempre presenteNome da opção de venda exibido no checkout (ex.: "Plano anual").
updatedAtstring (data)sempre presenteData da última alteração da aparência. Data e hora em ISO 8601, no fuso UTC.
valueDisplayobjectsempre presente6 camposComo o valor da opção é mostrado no checkout.
_idstringsempre presenteID da configuração de exibição do valor.
createdAtstring (data)sempre presenteData em que a configuração foi criada. Data e hora em ISO 8601, no fuso UTC.
priceTextstringSó em CUSTOM: texto exibido no lugar do valor.
supportTextstringSó em CUSTOM: texto de apoio exibido junto ao valor.
typestringsempre presenteAUTOMATIC mostra o valor calculado a partir dos preços dos produtos. CUSTOM mostra um texto livre definido no painel (campos priceText e supportText). O valor cobrado é sempre o dos preços dos produtos.
AUTOMATICCUSTOMupdatedAtstring (data)sempre presenteData da última alteração da configuração. Data e hora em ISO 8601, no fuso UTC.
defaultbooleansempre presentetrue na opção que aparece selecionada quando a pessoa abre o checkout.
invoiceDiscountedAmountintegersempre presenteTotal de descontos configurados na opção. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceDiscountsarray de object8 camposDescontos configurados na opção de venda. Só aparece quando a opção tem algum.
_idstringsempre presenteID do desconto.
amountintegersempre presenteValor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
descriptionstringsempre presenteTexto do desconto, como aparece para o comprador (ex.: "Primeira compra").
percentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject8 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
createdAtstring (data)sempre presenteData em que o produto foi criado. Data e hora em ISO 8601, no fuso UTC.
descriptionstring ou nullsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray ou nullsempre presenteMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
namestringsempre presenteNome do produto.
priceobjectsempre presente7 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente3 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o preço foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente4 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRING
updatedAtstring (data)sempre presenteData da última alteração do preço. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHERupdatedAtstring (data)sempre presenteData da última alteração do produto. Data e hora em ISO 8601, no fuso UTC.
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
invoiceItemsAmountintegersempre presenteSoma dos itens da opção, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
invoiceTotalAmountintegersempre presenteValor final da opção, já com os descontos configurados. Não inclui cupom nem juros de parcelamento; o que a pessoa pagou de fato está em invoice e payments. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da opção de venda. INACTIVE é uma opção desativada que não aparece mais no checkout.
ACTIVEINACTIVE
sharedIdstringsempre presenteID do checkout, o mesmo de checkoutSharedId na raiz.
statusstringsempre presenteStatus do checkout. ACTIVE está aceitando vendas; INACTIVE foi desativado.
ACTIVEINACTIVE
checkoutPurchaseChoiceIdstringsempre presenteID da opção de venda escolhida pelo comprador. Procure-o em checkout.purchaseChoices.choices[]._id para saber qual opção foi comprada. Pode vir null em compras antigas.
checkoutSharedIdstringsempre presenteID do checkout em que a compra aconteceu. É o código que aparece na URL do checkout e serve para montar o link de retomada da compra.
createdAtstring (data)sempre presenteData em que a compra foi criada, ou seja, quando a pessoa iniciou o checkout. Data e hora em ISO 8601, no fuso UTC.
eventTypestring = "purchase.refused"sempre presenteNome do evento que gerou este envio.
invoiceobjectsempre presente10 camposA fatura da compra: o que foi cobrado, os descontos aplicados e os valores. Quando a compra tem mais de uma fatura, vem a mais recente. Não vem no purchase.lead_captured, porque o lead ainda não tem fatura.
_idstringsempre presenteID da fatura.
discountedAmountintegersempre presenteTotal de descontos aplicados na fatura (cupom, forma de pagamento e manual). Valor em centavos (ex.: 9990 = R$ 99,90).
discountsarray de objectsempre presente11 camposDescontos aplicados na fatura.
_idstringsempre presenteID do desconto.
amountintegerValor do desconto. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o desconto foi aplicado. Data e hora em ISO 8601, no fuso UTC.
createdBystringsempre presenteID de quem criou o desconto. Em descontos MANUAL é o administrador que o aplicou.
descriptionstringTexto do desconto, como aparece para o comprador (ex.: "Primeira compra").
percentnumberSó em MANUAL: desconto em percentual, de 0 a 1 (0.1 = 10%), quando foi definido assim em vez de valor fixo.
redemptionobject6 camposSó em VOUCHER: o resgate do cupom nesta compra.
_idstringsempre presenteID do resgate.
createdAtstring (data)sempre presenteData em que o resgate foi registrado. Data e hora em ISO 8601, no fuso UTC.
discountedAmountintegersempre presenteValor descontado por este cupom nesta compra. Valor em centavos (ex.: 9990 = R$ 99,90).
redeemedAtstring (data)sempre presenteData em que o cupom foi aplicado. Data e hora em ISO 8601, no fuso UTC.
redeemedCodestringsempre presenteCódigo do cupom como o comprador digitou.
updatedAtstring (data)sempre presenteData da última alteração do resgate. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteOrigem do desconto. VOUCHER é um cupom digitado no checkout. PAYMENT_METHOD é o desconto por forma de pagamento (ex.: desconto no PIX). MANUAL é um desconto definido pelo administrador.
MANUALPAYMENT_METHODVOUCHERupdatedAtstring (data)sempre presenteData da última alteração do desconto. Data e hora em ISO 8601, no fuso UTC.
updatedBystringID de quem alterou o desconto pela última vez.
voucherstringSó em VOUCHER: ID do cupom usado.
dueAmountintegersempre presenteValor que ainda falta pagar. Fica em 0 quando a fatura está paga. Valor em centavos (ex.: 9990 = R$ 99,90).
itemsarray de objectsempre presente9 camposItens cobrados, um por produto ou item avulso.
_idstringsempre presenteID do item.
amountintegerSó em itens INLINE: valor do item avulso. Valor em centavos (ex.: 9990 = R$ 99,90).
createdAtstring (data)sempre presenteData em que o item foi criado. Data e hora em ISO 8601, no fuso UTC.
namestringSó em itens INLINE: nome do item avulso.
productobject6 camposSó em itens PRODUCT: o produto vendido, como estava cadastrado no momento do evento.
_idstringsempre presenteID do produto.
descriptionstring ou nullsempre presenteDescrição do produto. Vem null quando não foi preenchida.
metadataarray ou nullsempre presenteMetadados que você cadastrou no produto, em pares chave e valor. Útil para ligar o produto ao seu sistema (ex.: o SKU do seu e-commerce). Pode vir null ou vazio.
namestringsempre presenteNome do produto.
priceobjectsempre presente5 camposPreço do produto usado neste item. Um produto pode ter vários preços; aqui vem só o escolhido.
_idstringsempre presenteID do preço.
billingConfigobjectsempre presente3 camposComo o valor do preço é calculado.
_idstringsempre presenteID da configuração de valor.
typestringsempre presenteModelo de cálculo do valor. PER_UNIT é um valor fixo por unidade (campo unitAmount), e é o modelo usado no checkout hoje.
ADJUSTEDGRADUATEDPACKAGEPER_UNITVOLUMEunitAmountintegersempre presenteValor de uma unidade do produto, antes de descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
currencystringsempre presenteMoeda do preço, em código ISO 4217 (ex.: BRL).
descriptionstring ou nullsempre presenteDescrição interna do preço (ex.: "Valor anual"). Vem null quando não foi preenchida.
paymentConfigobjectsempre presente4 camposComo o preço é cobrado ao longo do tempo: uma vez ou de forma recorrente.
_idstringsempre presenteID da configuração de cobrança.
chargeLimitintegerSó em RECURRING: número máximo de cobranças da assinatura. Ausente quando a assinatura não tem limite.
intervalobject5 camposSó em RECURRING: de quanto em quanto tempo a assinatura é cobrada.
_idstringsempre presenteID do intervalo.
amountintegersempre presenteQuantidade de unidades do intervalo (ex.: 1 com unit MONTH = todo mês; 3 com unit MONTH = a cada três meses).
createdAtstring (data)sempre presenteData em que o intervalo foi criado. Data e hora em ISO 8601, no fuso UTC.
unitstringsempre presenteUnidade de tempo do intervalo.
DAYMINUTEMONTHWEEKYEARupdatedAtstring (data)sempre presenteData da última alteração do intervalo. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteForma de cobrança. ONE_TIME é pagamento único. RECURRING é assinatura, cobrada a cada intervalo (campo interval). GIVEN_TIME é um número fixo de cobranças.
GIVEN_TIMEONE_TIMERECURRING
typestringsempre presenteTipo do produto. ACCESS libera acesso a conteúdo da área de membros. OTHER é um produto que não libera acesso (serviço, material físico etc.).
ACCESSOTHER
productPricestringID do preço do produto usado neste item. É o mesmo valor de product.price._id.
quantityintegersempre presenteQuantidade do produto neste item.
typestringsempre presenteTipo do item. PRODUCT é um produto cadastrado no painel (vem com o objeto product). INLINE é um item avulso, com nome e valor próprios, sem produto associado.
INLINEPRODUCTupdatedAtstring (data)sempre presenteData da última alteração do item. Data e hora em ISO 8601, no fuso UTC.
itemsAmountintegersempre presenteSoma dos itens da fatura, antes dos descontos. Valor em centavos (ex.: 9990 = R$ 99,90).
paidAmountintegersempre presenteValor efetivamente pago. Inclui os juros de parcelamento quando o comprador parcelou no cartão, por isso pode ser maior que totalAmount. Valor em centavos (ex.: 9990 = R$ 99,90).
refundedAmountintegersempre presenteValor já reembolsado, somando todos os reembolsos. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus da fatura.
DRAFTEXPIREDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDVOIDtotalAmountintegersempre presenteValor da fatura já com os descontos. É o valor da compra sem juros de parcelamento. Valor em centavos (ex.: 9990 = R$ 99,90).
organizationstringsempre presenteID da sua organização na EngagED.
paymentsarray de objectsempre presente12 camposTodas as tentativas de pagamento da compra. Uma compra pode ter várias (ex.: um cartão recusado e depois um PIX pago). Para achar a mais recente, compare createdAt. Vem vazio no purchase.lead_captured.
_idstringsempre presenteID do pagamento.
additionalAdvanceFeeintegersempre presenteJuros de parcelamento repassados ao comprador neste pagamento, já incluídos em amount. Fica em 0 quando não houve parcelamento com juros. Valor em centavos (ex.: 9990 = R$ 99,90).
amountintegersempre presenteValor cobrado neste pagamento, incluindo os juros de parcelamento quando houver. Valor em centavos (ex.: 9990 = R$ 99,90).
codestringSó em boleto e PIX: linha digitável do boleto ou código PIX copia e cola.
createdAtstring (data)sempre presenteData em que o pagamento foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do pagamento, em código ISO 4217 (ex.: BRL).
expirationDatestring (data)Só em boleto e PIX: data de vencimento. Data e hora em ISO 8601, no fuso UTC.
installmentsintegersempre presenteNúmero de parcelas. Em boleto e PIX é sempre 1.
paymentMethodstringsempre presenteForma de pagamento. BANK_SLIP é boleto.
BANK_SLIPCREDIT_CARDMONEYPIXrefundedAmountintegersempre presenteValor já reembolsado deste pagamento, somando todos os reembolsos. É o valor a usar para saber quanto foi devolvido. Valor em centavos (ex.: 9990 = R$ 99,90).
statusstringsempre presenteStatus do pagamento. PAID pago; WAITING_PAYMENT boleto ou PIX aguardando; REFUSED recusado pelo emissor do cartão; CANCELED boleto ou PIX cancelado; EXPIRED boleto ou PIX vencido; REFUNDED e PARTIALLY_REFUNDED reembolsado total ou parcialmente; CHARGEDBACK contestado pelo titular do cartão.
ANALYZINGAUTHORIZEDCANCELEDCHARGEDBACKEXPIREDFAILEDPAIDPARTIALLY_REFUNDEDPENDINGPENDING_REFUNDPENDING_REVIEWPROCESSINGREFUNDEDREFUSEDWAITING_PAYMENTstatusAtstring (data)sempre presenteData em que o pagamento entrou no status atual. Data e hora em ISO 8601, no fuso UTC.
queryParamsobjectsempre presenteParâmetros de URL que estavam no link do checkout quando a pessoa entrou (UTMs, código de afiliado, parâmetros próprios). Cada parâmetro vira uma chave. Vem vazio quando o link não tinha parâmetros.
statusstringsempre presenteStatus da compra no momento do evento. Os mais comuns: DRAFT (lead capturado, sem pagamento), OPEN (boleto ou PIX gerado, aguardando pagamento), PAID (paga), REFUSED (cartão recusado), EXPIRED (boleto ou PIX vencido), REFUNDED e PARTIALLY_REFUNDED (reembolsada total ou parcialmente).
DRAFTEXPIREDFAILEDLATEOPENPAIDPARTIALLY_PAIDPARTIALLY_REFUNDEDREFUNDEDREFUSEDVOIDupdatedAtstring (data)sempre presenteData da última alteração da compra. Data e hora em ISO 8601, no fuso UTC.
userobjectsempre presente6 camposA pessoa que fez a compra.
_idstringsempre presenteID da pessoa na EngagED. É o mesmo em todas as compras dela.
customFieldsAnswersobject1 campoRespostas da pessoa aos campos personalizados do checkout. Cada chave é o identificador do campo, como foi configurado no painel. Só aparece quando há alguma resposta.
{chave}object5 camposResposta a um campo personalizado.
_idstringsempre presenteID da resposta.
documentTypestringSó em IDENTIFICATION_DOCUMENT: qual documento a pessoa informou em value, BR_CPF ou BR_CNPJ. O campo pode ser configurado para aceitar só CPF, só CNPJ ou os dois; quando aceita os dois, é por aqui que você sabe qual veio.
BR_CNPJBR_CPFtypestringsempre presenteTipo do campo personalizado: TEXT_SHORT (texto curto), TEXT_LONG (texto longo), NUMERIC (número), FILE_ATTACHMENT (anexo), DROPDOWN (seleção de uma opção), IDENTIFICATION_DOCUMENT (documento) ou DATE_PICKER (data).
DATE_PICKERDROPDOWNFILE_ATTACHMENTIDENTIFICATION_DOCUMENTNUMERICTEXT_LONGTEXT_SHORTupdatedAtstring (data)sempre presenteData da última alteração da resposta. Data e hora em ISO 8601, no fuso UTC.
valueinteger | stringsempre presenteA resposta, sempre como valor direto. O formato depende do type: texto em TEXT_SHORT e TEXT_LONG; número em NUMERIC; lista de URLs dos arquivos em FILE_ATTACHMENT; texto da opção escolhida em DROPDOWN; número do documento, só com dígitos, em IDENTIFICATION_DOCUMENT (o tipo do documento vem em documentType); e data em DATE_PICKER. A data do DATE_PICKER é a meia-noite do dia escolhido no fuso do navegador da pessoa, convertida para UTC: no horário de Brasília chega como T03:00:00.000Z. Para obter o dia escolhido, converta para o fuso de Brasília antes de ler a data.
emailstringsempre presenteE-mail informado no checkout.
namestringsempre presenteNome completo informado no checkout.
phoneNumberstringsempre presenteTelefone com código do país (ex.: +5541999990000). Vem null quando não foi informado.
phoneNumberCountrystringsempre presentePaís do telefone, em código ISO 3166 de duas letras (ex.: BR).
userPaymentProfileobjectsempre presente9 camposDados de cobrança informados no checkout: nome, documento e endereço. Não vem no purchase.lead_captured quando a pessoa ainda não preencheu esses dados.
_idstringsempre presenteID do perfil de cobrança.
addressobject ou nullsempre presente8 camposEndereço de cobrança. Vem null quando o checkout não pede endereço.
cityobjectsempre presente2 camposCidade.
metadataarray de objectsempre presente2 camposCódigos oficiais da cidade, em pares chave e valor.
keystringsempre presenteNome do código (ex.: ibge_id).
valuestringsempre presenteValor do código (ex.: o código IBGE da cidade).
namestringsempre presenteNome da cidade.
complementstringComplemento. Só aparece quando foi preenchido.
countrystringsempre presentePaís do endereço, em código ISO 3166 de duas letras (ex.: BR).
neighborhoodstringsempre presenteBairro.
numberstring ou nullsempre presenteNúmero. Pode vir null.
stateobjectsempre presente3 camposEstado.
codestringsempre presenteSigla do estado (ex.: PR).
metadataarray de objectsempre presente2 camposCódigos oficiais do estado, em pares chave e valor.
keystringsempre presenteNome do código (ex.: ibge_id).
valuestringsempre presenteValor do código (ex.: o código IBGE do estado).
namestringsempre presenteNome do estado.
streetstringsempre presenteLogradouro.
zipcodestringsempre presenteCEP, só com dígitos.
countrystringsempre presentePaís do perfil de cobrança, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o perfil de cobrança foi criado. Data e hora em ISO 8601, no fuso UTC.
currencystringsempre presenteMoeda do perfil de cobrança, em código ISO 4217 (ex.: BRL).
namestringsempre presenteNome do titular da cobrança. Pode ser diferente de user.name (ex.: compra no CNPJ da empresa).
taxIdsarray de objectsempre presente6 camposDocumentos fiscais do titular.
_idstringsempre presenteID do documento.
countrystringsempre presentePaís do documento, em código ISO 3166 de duas letras (ex.: BR).
createdAtstring (data)sempre presenteData em que o documento foi registrado. Data e hora em ISO 8601, no fuso UTC.
typestringsempre presenteTipo do documento. No Brasil: BR_CPF ou BR_CNPJ.
BR_CNPJBR_CPFPASSPORTupdatedAtstring (data)sempre presenteData da última alteração do documento. Data e hora em ISO 8601, no fuso UTC.
valuestringsempre presenteNúmero do documento, só com dígitos (sem pontos, traço ou barra).
typestringsempre presenteTipo de pessoa. INDIVIDUAL é pessoa física (CPF); COMPANY é pessoa jurídica (CNPJ).
COMPANYGOVERNMENT_ENTITYINDIVIDUALNON_PROFITupdatedAtstring (data)sempre presenteData da última alteração do perfil de cobrança. Data e hora em ISO 8601, no fuso UTC.
Dados fictícios, com a mesma estrutura de um envio real.