Pagarme - Subscription

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

Eventos Disponíveis

• subscription.active
• subscription.canceled

Estrutura do Payload

{
  "type": "subscription.active",
  "data": {
    "id": "SUB-123456",
    "status": "paid",
    "created_at": 1705319000,
    "updated_at": 1705319000,
    "canceled_at": null,
    "currency": "BRL",
    "items": [
      {
        "description": "Plano Mensal",
        "amount": 4900
      }
    ],
    "cycle": {
      "cycle": 1,
      "start_at": 1705319000,
      "end_at": 1707944400
    },
    "customer": {
      "id": "CUST-001",
      "name": "João Silva",
      "document": "12345678900",
      "email": "[email protected]"
    }
  }
}

---

Componentes do Payload

Customer

Campo	Tipo	Descrição
id	string | null	ID do cliente
name	string | null	Nome do cliente
document	string | null	Número do documento (CPF/CNPJ)
email	string | null	Email do cliente
phoneNumbers	Collection	Coleção de telefones
address	Address	Endereço do cliente

Subcomponentes

Campo	Tipo	Descrição
street	string | null	Nome da rua
number	string | null	Número
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado (UF)
country	string | null	País
postalCode	string | null	CEP

---

Telefones

Campo	Tipo	Descrição
formattedPhone	PhoneFactory | null	Telefone formatado
type	null	Sempre null
rawNumber	string | null	Número bruto
areaCode	string | null	Código de área
internationalDialingCode	null	Sempre null

---

Subscription

Campo	Tipo	Descrição
id	string | null	ID da assinatura
name	string | null	Nome da assinatura
status	SubscriptionStatus | null	Status normalizado da assinatura
createdAt	Carbon	Data de criação
updatedAt	Carbon	Data de atualização
canceledAt	Carbon | null	Data do cancelamento
chargedTimes	null	Sempre null
cancellationReason	null	Sempre null
currentCycle	int | null	Ciclo atual
currentCycleStart	Carbon | null	Início do ciclo atual
currentCycleEnd	Carbon | null	Fim do ciclo atual

Status Normalizados (SubscriptionStatus)

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

Valor	Descrição
active	Ativa
paused	Pausada
canceled	Cancelada

---

Payment

Campo	Tipo	Descrição
currency	string | null	Moeda da transação
total	int | null	Valor total do pedido
totalProductsValue	int | null	Soma dos valores dos produtos
discountValue	int | null	Valor do desconto
shippingValue	int | null	Valor do frete
coupons	Collection	Coleção de cupons
paymentMethod	PaymentMethod | null	Método de pagamento

Métodos de Pagamento

Campo	Tipo	Descrição
brand	string | null	Bandeira do cartão
lastDigits	string | null	Últimos 4 dígitos
expirationMonth	int | null	Mês de expiração
expirationYear	int | null	Ano de expiração

---

Campo	Tipo	Descrição
brand	string | null	Bandeira do cartão
lastDigits	string | null	Últimos 4 dígitos
expirationMonth	int | null	Mês de expiração
expirationYear	int | null	Ano de expiração

---

Campo	Tipo	Descrição
qrcodeUrl	string | null	URL do QR Code Pix
qrcodeSignature	string | null	Assinatura do QR Code Pix
expirationDate	Carbon | null	Data de expiração
pixKey	null	Sempre null
pixKeyType	null	Sempre null

---

Campo	Tipo	Descrição
digitableLine	string | null	Linha digitável do boleto
url	string | null	URL do boleto ou PDF
expirationDate	Carbon | null	Data de vencimento

---

Campo	Tipo	Descrição
type	string	Sempre bank_transfer

---

Campo	Tipo	Descrição
type	string	Sempre cash

---

Product

Campo	Tipo	Descrição
id	string | null	ID do produto
name	string | null	Nome do produto
quantity	int | null	Quantidade
unitValue	int | null	Valor unitário em centavos
totalValue	int | null	Valor total
imageUrl	null	Sempre null
type	string	Tipo do produto (product ou subscription_plan)
offerType	string	Sempre main

---

Checkout

Campo	Tipo	Descrição
id	null	Sempre null
url	string | null	URL do checkout

Status Normalizados (OrderStatus)

A Pagarme retorna os seguintes valores normalizados para o status:

Valor	Descrição
paid	Pago
waiting_payment	Aguardando pagamento
payment_processing	Processando pagamento
refunded	Reembolsado
failed	Falhou
canceled	Cancelado

---

LeadTracking

Campo	Tipo	Descrição
src	null	Sempre null
sck	null	Sempre null
utmSource	null	Sempre null
utmCampaign	null	Sempre null
utmMedium	null	Sempre null
utmContent	null	Sempre null
utmTerm	null	Sempre null
utmId	null	Sempre null
metaFbp	null	Sempre null
googleGaId	null	Sempre null
googleGclid	null	Sempre null
googleGclsrc	null	Sempre null
googleDclid	null	Sempre null
googleGbraid	null	Sempre null
googleWbraid	null	Sempre null
tiktokTtlid	null	Sempre null
ip	null	Sempre null

Campo	Tipo	Descrição
src	null	Sempre null
sck	null	Sempre null
utm_source	null	Sempre null
utm_campaign	null	Sempre null
utm_medium	null	Sempre null
utm_content	null	Sempre null
utm_term	null	Sempre null
utm_id	null	Sempre null
meta_fbp	null	Sempre null
google_ga_id	null	Sempre null
google_gclid	null	Sempre null
google_gclsrc	null	Sempre null
google_dclid	null	Sempre null
google_gbraid	null	Sempre null
google_wbraid	null	Sempre null
tiktok_ttlid	null	Sempre null
ip	null	Sempre null

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

---

Voltar para visão geral da integração