> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pepper.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Subscription

> Formato do payload de webhooks de assinatura (v2.0)

# Subscription (payload v2.0)

Payload enviado nos eventos `subscription.*`.

## Estrutura geral

**token** `string`

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

**event** `string`

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

**created\_at** `string`

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

**platform** `string`

Nome da empresa/plataforma associada à conta.

**subscription** `object`

Dados da assinatura.

**customer** `object`

Dados do assinante. Mesma estrutura documentada em [Customer](/webhooks/v2/customer).

**product** `object`

Produto vinculado à assinatura.

**offer** `object`

Oferta vinculada à assinatura.

**transaction** `object | null`

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

**tracking** `object`

Dados de rastreamento (UTM / src).

**ip** `string | null`

IP do cliente (pode ser nulo).

**fbp** `string | null`

Cookie Facebook Pixel `fbp` (pode ser nulo).

**fbc** `string | null`

Cookie Facebook Click ID `fbc` (pode ser nulo).

## Objeto `subscription`

**subscription.id** `string`

Hash único da assinatura.

**subscription.status** `string`

Status atual da assinatura (veja [Status de assinatura](/webhooks/status-de-assinatura)).

**subscription.interval** `string`

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

**subscription.price** `string`

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

**subscription.first\_billing** `string | null`

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

**subscription.next\_billing\_day** `string`

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

**subscription.installments** `integer`

Número de parcelas configurado na assinatura.

**subscription.payment\_method** `string`

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

**subscription.count\_tries** `integer`

Quantidade de tentativas de cobrança já realizadas.

**subscription.start\_at** `string`

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

## Objeto `product`

**product.id** `string`

Hash do produto.

**product.title** `string`

Título do produto.

**product.price** `string`

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

## Objeto `offer`

**offer.id** `string`

Hash da oferta.

**offer.title** `string | null`

Título da oferta (pode ser `null`).

**offer.price** `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`.

**transaction.id** `string`

Hash da transação.

**transaction.status** `string`

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

**transaction.method** `string`

Método de pagamento da transação.

**transaction.amount** `string`

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

**transaction.created\_at** `string`

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

**transaction.paid\_at** `string | null`

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

## Exemplo

```json theme={null}
{
  "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
}
```

> [!NOTE]
>
> Consulte também [Eventos de assinatura](/webhooks/eventos-de-assinatura) para saber quando cada valor de `event` é disparado.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.