Assinatura
Atualizado
Isto foi útil?
Atualizado
Isto foi útil?
Evento disparado quando uma assinatura é criada com sucesso. Isso não significa que a assinatura está ativa.
Evento disparado quando a assinatura é ativada com sucesso. Isso significa que o membro possuí créditos disponíveis.
Evento disparado quando
Evento disparado quando a assinatura é desativada com sucesso. Isso significa que o usuário não possuí créditos disponíveis.
Evento disparado quando a renovação automática de uma assinatura é desativada com sucesso. Isso significa que a assinatura não irá ser renovada automaticamente e quando chegar da data do vencimento ela irá ser desativada.
Evento disparado quando a renovação automática de uma assinatura desativada anteriormente, volta a ficar ativa.
Os eventos de assinatura seguem um padrão de payload e propriedades, sendo elas:
type string
Tipo do evento de Webhook
subscription.created
Assinatura criada
subscription.activated
Assinatura ativada
subscription.deactivated
Assinatura desativada
subscription.expiring
Assinatura expirada
subscription.renewal_disabled
Renovação automática desativada
subscription.renewal_enabled
Renovação automática ativada
version string
Versão do contrato do payload. Neste caso o valor esperado será sempre 2.0.0
.
event.product object
Representa as informações do produto comprado
event.product.id string
Identificador único do produto
event.product.name string
Nome do produto no momento da compra
event.subscription.id string
Identificador único da assinatura
event.subscription.sellerId string
Identificador único do vendedor
event.subscription.payerId string
Identificador único do comprador
event.subscription.type string
Tipo da assinatura
recurring
Renovação
one_time
Pagamento único
free
Assinatura gratuita
event.subscription.status string
Status da assinatura
active
Assinatura está ativa e possuí créditos
inactive
Assinatura está inativa e não possuí créditos
event.subscription.billingCycleMonths integer
Quantidade de meses que a assinatura renova
1
Mensal
3
Trimestral
6
Semestral
12
Anual
event.subscription.credits integer
Quantidade de créditos disponíveis na assinatura. Cada unidade de crédito representa um dia.
event.subscription.paymentMethod string
Metodo de pagamento utilizado
credit_card
Cartão de crédito
pix
Pix
bank_slip
Boleto
event.subscription.autoRenew boolean
Representa se a assinatura está com a renovação automática ativada, caso esteja desativa quando se esgotarem os créditos não irá efetuar a renovação automática
event.subscription.freeTrial boolean
Representa se a assinatura está em um período de teste
event.subscription.activatedAt string
Representa a última data que a assinatura ficou com o status ativa, segue o padrão de ISO-8601 com UTC 0
event.subscription.inactivatedAt string
Representa a última data que a assinatura ficou com o status inativa, segue o padrão de ISO-8601 com UTC 0
event.subscription.deactivatedAutoRenewAt string
Representa a última data do cancelamento da renovação automática, segue o padrão de ISO-8601 com UTC 0
event.subscription.reactivatedAutoRenewAt string
Representa a última data de reativação da renovação automática, segue o padrão de ISO-8601 com UTC 0
event.subscription.modifiedAt string
Representa a data da última atualização da assinatura, segue o padrão de ISO-8601 com UTC 0
event.subscription.createdAt string
Quando a assinatura foi criada, segue o padrão de ISO-8601 com UTC 0
event.subscription.version integer
Contador que reflete a versão atual da assinatura. Para uma assinatura que foi atualizada 50 vezes, espera que o seu valor seja 50.
event.subscription.firstPaymentSession object
Representa as informações capturadas do comprador no momento da compra.
event.subscription.firstPaymentSession.ip string
IP do comprador no momento de compra
event.subscription.firstPaymentSession.utm.source string
Representa o valor de utm_source
capturado no momento da compra
event.subscription.firstPaymentSession.utm.medium string
Representa o valor de utm_medium
capturado no momento da compra
event.subscription.firstPaymentSession.utm.campaign string
Representa o valor de utm_campaign
capturado no momento da compra
event.subscription.firstPaymentSession.utm.content string
Representa o valor de utm_content
capturado no momento da compra
event.subscription.firstPaymentSession.utm.term string
Representa o valor de utm_term
capturado no momento da compra
event.subscription.billingAddress object
Representa as informações de endereço capturadas do comprador no momento da compra, essas informações são opcionais dependendo da configuração dos campos obrigatórios no checkout.
event.subscription.billingAddress.countryCode string
Código do país seguindo o ISO 3166-1 alpha-2
event.subscription.billingAddress.state string
Nome do estado, condado, província ou região
event.subscription.billingAddress.city string
Nome da cidade, distrito, subúrbio, vila ou vila
event.subscription.billingAddress. string
Nome do bairro
event.subscription.billingAddress.street string
Nome da rua
event.subscription.billingAddress.number string
O número do imóvel
event.subscription.billingAddress.complement string
Complemento que pode ajudar a encontrar o endereço
event.subscription.billingAddress.postalCode string
CEP / Código Postal
event.user object
Representa as informações de usuário cadastradas na plataforma
event.user.id string
Identificador único do comprador
event.user.firstName string
Primeiro nome do comprador
event.user.lastName string
Sobrenome nome do comprador
event.user.document string
Representa o documento de identificação do comprador, podendo ser do tipo CPF, CNPJ ou nulo
event.user.email string
Email do comprador
event.user.phone string
Telefone com DDI e DDD do comprador