Subscription (payload v2.0)

Payload enviado nos eventos subscription.*.

Estrutura geral

string

Identificador único da conta (hash da conta, 10 caracteres).

string

Nome do evento de assinatura (ex.: subscription.created, subscription.payment_failed).

string

Data/hora do registro da assinatura no formato ISO 8601.

string

Nome da empresa/plataforma associada à conta.

object

Dados da assinatura.

object

Dados do assinante. Mesma estrutura documentada em Customer.

object

Produto vinculado à assinatura.

object

Oferta vinculada à assinatura.

object | null

Última transação relacionada à assinatura (pode ser null).

object

Dados de rastreamento (UTM / src).

string | null

IP do cliente (pode ser nulo).

string | null

Cookie Facebook Pixel fbp (pode ser nulo).

string | null

Cookie Facebook Click ID fbc (pode ser nulo).

Objeto `subscription`

string

Hash único da assinatura.

string

Status atual da assinatura (veja Status de assinatura).

string

Intervalo de cobrança (ex.: monthly, quarterly, semi-annual, yearly).

string

Valor recorrente em reais (ex.: "9.99").

string | null

Valor da primeira cobrança em reais, quando diferente do recorrente. Pode ser null.

string

Próxima data de cobrança no formato ISO 8601.

integer

Número de parcelas configurado na assinatura.

string

Método de pagamento (ex.: credit_card, pix, billet).

integer

Quantidade de tentativas de cobrança já realizadas.

string

Data de início da assinatura no formato ISO 8601.

Objeto `product`

string

Hash do produto.

string

Título do produto.

string

Preço do produto em reais (ex.: "0.00").

Objeto `offer`

string

Hash da oferta.

string | null

Título da oferta (pode ser null).

string

Preço da oferta em reais (ex.: "9.99").

Objeto `transaction`

Presente quando existe uma última transação vinculada; caso contrário, vem null.

string

Hash da transação.

string

Status do pagamento (ex.: paid, refused, waiting_payment).

string

Método de pagamento da transação.

string

Valor cobrado em reais (ex.: "9.99").

string

Data de criação da transação (ISO 8601).

string | null

Data de pagamento (ISO 8601). null se ainda não pago.

Exemplo

{
  "token": "qq4en2vnsp",
  "event": "subscription.payment_failed",
  "created_at": "2026-09-08T13:53:05.000000Z",
  "platform": "Pepper",
  "subscription": {
    "id": "ecyxg6fqvt",
    "status": "unpaid",
    "interval": "monthly",
    "price": "9.99",
    "first_billing": null,
    "next_billing_day": "2026-09-08T03:00:00.000000Z",
    "installments": 1,
    "payment_method": "credit_card",
    "count_tries": 1,
    "start_at": "2026-08-08T03:00:00.000000Z"
  },
  "customer": {
    "id": "bybx0mibwp",
    "name": "Cliente Exemplo",
    "email": "cliente@example.com",
    "phone": "+5511999999999",
    "document": "12345678901",
    "zip_code": "07500000",
    "street_name": "Rua Exemplo",
    "number": "100",
    "complement": null,
    "neighborhood": "Centro",
    "city": "Santa Isabel",
    "state": "SP"
  },
  "product": {
    "id": "4qpy8gkvkg",
    "title": "Produto de assinatura",
    "price": "0.00"
  },
  "offer": {
    "id": "xvhrs",
    "title": "Plano Mensal",
    "price": "9.99"
  },
  "transaction": {
    "id": "clubxip9qdj",
    "status": "refused",
    "method": "credit_card",
    "amount": "9.99",
    "created_at": "2026-09-08T13:53:05.000000Z",
    "paid_at": null
  },
  "tracking": {
    "src": null,
    "utm_source": null,
    "utm_campaign": null,
    "utm_medium": null,
    "utm_term": null,
    "utm_content": null
  },
  "ip": null,
  "fbp": null,
  "fbc": null
}

Consulte também Eventos de assinatura para saber quando cada valor de event é disparado.

Webhooks

Payload v2.0 (atual)

Payload v1.0

Subscription

Subscription (payload v2.0)

Estrutura geral

Objeto `subscription`

Objeto `product`

Objeto `offer`

Objeto `transaction`

Exemplo

​Subscription (payload v2.0)

​Estrutura geral

​Objeto subscription

​Objeto product

​Objeto offer

​Objeto transaction

​Exemplo

Subscription (payload v2.0)

Estrutura geral

Objeto `subscription`

Objeto `product`

Objeto `offer`

Objeto `transaction`

Exemplo