Greenn - Subscription

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

Eventos Disponíveis

• subscription.completed

Estrutura do Payload

{
  "event": "contractUpdated",
  "type": "contract",
  "client": {
    "id": "12345",
    "name": "João Silva",
    "email": "[email protected]",
    "document": "12345678900",
    "cellphone": "5511999999999"
  },
  "product": {
    "id": "PROD-001",
    "name": "Plano Mensal",
    "amount": 4970
  },
  "sale": {
    "id": "SALE-123",
    "subscription_id": "SUB-456",
    "status": "paid",
    "amount": 4970,
    "method": "CREDIT_CARD"
  }
}

---

Componentes do Payload

Customer

Campo	Tipo	Descrição
id	string | null	ID do cliente
name	string | null	Nome do cliente
email	string | null	E-mail do cliente
document	string | null	Documento (CPF/CNPJ)
phone_numbers	Collection	Coleção de telefones
address	EmptyAddress	Sempre vazio

Telefone

Campo	Tipo	Descrição
formatted_phone	string | null	Telefone formatado
type	null	Sempre null
raw_number	string | null	Número bruto
area_code	null	Sempre null
international_dialing_code	null	Sempre null

---

Subscription

Campo	Tipo	Descrição
id	string | null	ID da assinatura
name	null	Sempre null
created_at	null	Sempre null
updated_at	null	Sempre null
canceled_at	null	Sempre null
cancellation_reason	null	Sempre null
charged_times	null	Sempre null
current_cycle	null	Sempre null
current_cycle_start	null	Sempre null
current_cycle_end	null	Sempre null
status	string | null	Status normalizado da assinatura

Status Normalizados (SubscriptionStatus)

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

Valor	Descrição
active	Ativa
canceled	Cancelada

---

Payment

Campo	Tipo	Descrição
currency	string	Sempre BRL
total	integer | null	Valor total (em centavos)
discount_value	null	Sempre null
shipping_value	integer | null	Valor do frete (em centavos)
total_products_value	null	Sempre null
payment_method	PaymentMethod	Método de pagamento
coupons	Collection	Coleção de cupons

Cupom

Campo	Tipo	Descrição
id	string | null	ID do cupom
code	string | null	Código do cupom
value	integer | null	Valor do desconto (em centavos)
percentage	float | null	Percentual do desconto
incidence	string	Sempre total
incidence_type	string	Tipo de incidência (percentage ou value)
expiration_date	null	Sempre null

---

Product

Campo	Tipo	Descrição
id	string | null	ID do produto
name	string | null	Nome do produto
quantity	integer	Sempre 1
unit_value	integer | null	Valor unitário (em centavos)
total_value	integer | null	Valor total (em centavos)
image_url	null	Sempre null
type	string	Sempre product
offer_type	string	Sempre main

---

Charge (vazio)

Campo	Tipo	Descrição
id	null	Sempre null
created_at	null	Sempre null
status	null	Sempre null
type	null	Sempre null
value	null	Sempre null

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

---

Voltar para visão geral da integração