Digital Manager Guru - Subscription

Eventos da família subscription.* na integração Digital Manager Guru.

Veja também Estrutura geral dos eventos Subscription para referência completa.

Eventos Disponíveis

• subscription.active
• subscription.canceled
• subscription.completed
• subscription.paused
• subscription.past_due
• subscription.trial

Estrutura do Payload

{
  "customer": {
    "id": "a0edb722-45a0-4716-8e0c-0f5a801869b7",
    "name": "João Silva",
    "email": "[email protected]",
    "document": "12345678900",
    "phone": "+5511999999999",
    "address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": "Apto 45",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "postal_code": "01000-000"
    }
  },
  "subscription": {
    "id": "sub_qsfiGHwq5Mls7fEG",
    "status": "active",
    "name": "Plano Mensal Premium",
    "created_at": 1705319000,
    "updated_at": 1705405400,
    "canceled_at": null,
    "cancellation_reason": null,
    "charged_times": 3
  },
  "products": [
    {
      "id": "1690323026",
      "name": "Plano Mensal Premium",
      "type": "subscription_plan",
      "offer_type": "main",
      "quantity": 1,
      "unit_value": 9900,
      "total_value": 9900,
      "image_url": "https://example.com/product.jpg"
    }
  ],
  "payment": {
    "currency": "BRL",
    "total": 9900,
    "discount_value": 0,
    "shipping_value": 0,
    "total_products_value": 9900,
    "payment_method": {
      "type": "credit_card",
      "brand": "visa",
      "last_digits": "1234"
    },
    "coupons": []
  },
  "charge": {
    "id": "charge_001",
    "created_at": 1705319000,
    "subscription_cycle": 1,
    "cycle_start": 1705319000,
    "cycle_end": 1707911000,
    "status": "paid",
    "type": "cycle",
    "value": 9900
  }
}

---

Componentes do Payload

Customer

Informações do cliente.

Campo	Tipo	Descricao
id	string	ID unico do cliente na DMG
name	string	Nome completo do cliente
email	string | null	E-mail do cliente
document	string | null	CPF ou CNPJ do cliente
phone_numbers	Phone[] | null	Colecao de telefones do cliente
address	Address	Endereco do cliente

Address

Endereco do cliente.

Campo	Tipo	Descrição
street	string | null	Logradouro (rua, avenida, etc.)
number	string | null	Número do endereço
complement	string | null	Complemento (apartamento, bloco, etc.)
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado/UF (ex: SP, RJ)
country	string | null	País em formato ISO 3166-1 alpha-2 (ex: BR)
postal_code	string | null	CEP ou código postal

Phone

Telefone do cliente. DMG envia um unico telefone (quando disponivel).

Campo	Tipo	Descrição
formatted_phone	string | null	Telefone formatado em E.164
type	null	Sempre null
raw_number	string | null	Número sem formatação
area_code	string | null	Código de área (DDD)
international_dialing_code	null	Sempre null

---

Subscription

Dados da assinatura.

Campo	Tipo	Descrição
id	string	ID único da assinatura na DMG
status	string	Status normalizado (active, canceled, paused, etc.)
name	string | null	Nome do plano de assinatura
created_at	integer	Timestamp de criação da assinatura (Unix em segundos)
updated_at	integer	Timestamp da última atualização
canceled_at	integer | null	Timestamp do cancelamento (se cancelada)
cancellation_reason	string | null	Motivo do cancelamento
charged_times	integer	Número de vezes que a assinatura foi cobrada

---

Product

Plano de assinatura.

Campo	Tipo	Descrição
id	string	ID do produto
name	string	Nome do produto
type	string	Tipo: product, subscription_plan
offer_type	string	Tipo de oferta: main, order_bump
quantity	integer	Quantidade
unit_value	integer	Valor unitário em centavos
total_value	integer	Valor total (quantidade × unitário) em centavos
image_url	string | null	URL da imagem do produto

---

Payment

Dados financeiros.

Campo	Tipo	Descrição
currency	string	Moeda em formato ISO 4217 (ex: BRL, USD)
total	integer	Valor total do pedido em centavos
discount_value	integer | null	Valor do desconto em centavos
shipping_value	integer | null	Valor do frete em centavos
total_products_value	integer	Valor total dos produtos em centavos
payment_method	object | null	Método de Pagamento
coupons	array	Array de cupons aplicados

Valores Normalizados

PaymentMethod

A DMG suporta os seguintes métodos de pagamento:

Valor	Descrição
credit_card	Cartão de crédito
pix	PIX
boleto	Boleto

CouponIncidence

Valor	Descrição
products	Aplicado em produtos
shipping	Aplicado em frete
total	Aplicado no total

CouponIncidenceType

Valor	Descrição
value	Desconto em valor (dinheiro)
percentage	Desconto em percentual

Subcomponentes

Campo	Tipo	Descrição
id	string	ID do cupom
code	string	Código do cupom
value	integer	Valor do desconto em centavos
percentage	float | null	Percentual do desconto (ex: 10.0 = 10%)
incidence	string	Onde aplicado: products, shipping, total
incidence_type	string	Tipo: value, percentage
expiration_date	null	Sempre null - Não rastreado pela DMG

---

Charge

Dados da cobrança da assinatura. Nota: Este componente só está presente em eventos que incluem uma transação/cobrança.

Dados da cobrança da assinatura.

Campo	Tipo	Descrição
id	string | null	ID único da cobrança
created_at	integer | null	Timestamp de criação da cobrança
subscription_cycle	integer | null	Número do ciclo da assinatura
cycle_start	integer | null	Timestamp de início do ciclo
cycle_end	integer | null	Timestamp de término do ciclo
status	string | null	Status da cobrança
type	string | null	Tipo: first_payment, cycle, external
value	integer | null	Valor da cobrança em centavos

---

Voltar para visão geral da integração