Pular para o conteúdo

Monetizze - Subscription

Eventos da família subscription.* na integração Monetizze.

Eventos Disponíveis

  • subscription.active
  • subscription.past_due
  • subscription.canceled

Estrutura do Payload

{
"codigo_venda": "12345",
"postback_evento": "101",
"tipoEvento": {
"codigo": "101"
},
"comprador": {
"nome": "João Silva",
"email": "[email protected]",
"cnpj_cpf": "12345678900",
"telefone": "5511999999999"
},
"assinatura": {
"codigo": "ASSIN-456",
"status": "101",
"data_assinatura": 1705319000,
"parcela": 3
},
"plano": {
"nome": "Plano Mensal"
},
"venda": {
"codigo": "12345",
"status": "101",
"valor": 4970,
"quantidade": 1
},
"produtos": [
{
"produto": "PROD-001",
"nome": "Plano Mensal",
"valor": 4970,
"quantidade": 1
}
]
}

Componentes do Payload

Customer

CampoTipoDescrição
idnullSempre null
namestring | nullNome do comprador
emailstring | nullE-mail do comprador
documentstring | nullCPF ou CNPJ
phone_numbersCollectionColeção de telefones
addressAddressEndereço do comprador

Telefone

CampoTipoDescrição
formatted_phonestring | nullTelefone formatado
typenullSempre null
raw_numberstring | nullNúmero bruto
area_codenullSempre null
international_dialing_codenullSempre null

Endereço

CampoTipoDescrição
streetstring | nullRua
numberstring | nullNúmero
complementstring | nullComplemento
neighborhoodstring | nullBairro
citystring | nullCidade
statestring | nullEstado
countrystring | nullPaís
postal_codestring | nullCEP

Subscription

CampoTipoDescrição
idstring | nullID da assinatura
namestring | nullNome do plano
created_atinteger | nullTimestamp de início da assinatura
updated_atnullSempre null
canceled_atnullSempre null
cancellation_reasonnullSempre null
charged_timesinteger | nullNúmero de parcelas/cobranças
current_cyclenullSempre null
current_cycle_startnullSempre null
current_cycle_endnullSempre null
statusstring | nullStatus normalizado da assinatura

Status Normalizados (SubscriptionStatus)

A Monetizze retorna os seguintes valores normalizados para o status da assinatura:

ValorDescrição
activeAtiva
past_duePagamento atrasado
canceledCancelada

Payment

CampoTipoDescrição
currencystringSempre BRL
totalinteger | nullValor total (em centavos)
discount_valueinteger | nullValor do desconto (em centavos)
shipping_valueinteger | nullValor do frete (em centavos)
total_products_valueinteger | nullValor total dos produtos (em centavos)
payment_methodPaymentMethodMétodo de pagamento
couponsCollectionColeção de cupons

Cupom

CampoTipoDescrição
idnullSempre null
codestring | nullCódigo do cupom
valueinteger | nullValor do desconto (em centavos)
percentagenullSempre null
incidencestringSempre products
incidence_typestringSempre value
expiration_datenullSempre null

Métodos de Pagamento (PaymentMethod)

A Monetizze retorna os seguintes métodos de pagamento:

ValorDescrição
credit_cardCartão de Crédito
pixPIX
boletoBoleto Bancário

Product

CampoTipoDescrição
idstring | nullID do produto
namestring | nullNome do produto
quantityinteger | nullQuantidade
unit_valueinteger | nullValor unitário (em centavos)
total_valueinteger | nullValor total (em centavos)
image_urlnullSempre null
typestringTipo do produto (product ou subscription_plan)
offer_typestringTipo de oferta (main ou order_bump)

Checkout

CampoTipoDescrição
idstring | nullID do checkout
urlstring | nullURL de recuperação do checkout

Lead Tracking (vazio)

Este componente nunca possui dados úteis na Monetizze. Todos os campos retornam null.

CampoTipoDescrição
srcnullSempre null
scknullSempre null
utm_sourcenullSempre null
utm_campaignnullSempre null
utm_mediumnullSempre null
utm_contentnullSempre null
utm_termnullSempre null
utm_idnullSempre null
meta_fbpnullSempre null
google_ga_idnullSempre null
google_gclidnullSempre null
google_gclsrcnullSempre null
google_dclidnullSempre null
google_gbraidnullSempre null
google_wbraidnullSempre null
tiktok_ttlidnullSempre null
ipnullSempre null

[!NOTE] Essa integração não disponibiliza informações de lead tracking.


Charge (vazio)

CampoTipoDescrição
idnullSempre null
created_atnullSempre null
statusnullSempre null
typenullSempre null
valuenullSempre null

[!NOTE] Essa integração não disponibiliza informações de cobrança.


Voltar para visão geral da integração