Skip to main content
Quando o evento é do tipo subscription.*, o campo data da requisição de webhook contém um objeto assinatura no formato abaixo.

​
Estrutura

{
  "id": "sub_xyz789abc",
  "livemode": false,
  "customer": "cus_ahwDXrgYvur89iPs",
  "paymentMethod": "pm_abc123xyz",
  "status": "active",
  "currency": "BRL",
  "interval": "month",
  "intervalCount": 1,
  "cancelAtPeriodEnd": false,
  "startDate": 1731622178441,
  "endDate": null,
  "trialStartDate": null,
  "trialEndDate": null,
  "currentPeriodStart": 1731622178441,
  "currentPeriodEnd": 1734300578441,
  "createdAt": 1731622178441,
  "updatedAt": 1731622178441,
  "canceledAt": null,
  "items": [
    {
      "id": "si_abc123",
      "product": "prod_xyz",
      "price": "pri_xyz",
      "name": "Plano Mensal",
      "amount": 9900,
      "quantity": 1,
      "createdAt": 1731622178441,
      "updatedAt": 1731622178441
    }
  ]
}

​
Atributos

{
  "id": "sub_xyz789abc",
}
id : string.
Identificador único da assinatura, começando com sub_
{
  "livemode": false,
}
livemode : boolean.
Indica se a assinatura está em modo de produção (true) ou teste (false)
{
  "customer": "cus_ahwDXrgYvur89iPs",
}
customer : string.
ID do cliente, começando com cus_
{
  "paymentMethod": "pm_abc123xyz",
}
paymentMethod : string.
ID do método de pagamento, começando com pm_
{
  "status": "active",
}
status : string.
Status atual da assinatura (ex.: active, canceled, past_due, trialing, incomplete, paused, void)
{
  "currency": "BRL",
}
currency : string.
Código da moeda (ex.: BRL)
{
  "interval": "month",
}
interval : string.
Intervalo de cobrança (ex.: day, month, year)
{
  "intervalCount": 1,
}
intervalCount : number.
Quantidade de intervalos entre cada cobrança
{
  "cancelAtPeriodEnd": false,
}
cancelAtPeriodEnd : boolean.
Se a assinatura será cancelada ao final do período atual
{
  "startDate": 1731622178441,
}
startDate : number.
Timestamp Unix de início da assinatura
{
  "endDate": null,
}
endDate : number | null.
Timestamp Unix de fim da assinatura. Pode ser null
{
  "trialStartDate": null,
}
trialStartDate : number | null.
Início do período de trial. Pode ser null
{
  "trialEndDate": null,
}
trialEndDate : number | null.
Fim do período de trial. Pode ser null
{
  "currentPeriodStart": 1731622178441,
}
currentPeriodStart : number.
Início do período atual de cobrança (timestamp Unix)
{
  "currentPeriodEnd": 1734300578441,
}
currentPeriodEnd : number.
Fim do período atual de cobrança (timestamp Unix)
{
  "createdAt": 1731622178441,
}
createdAt : number.
Timestamp Unix de criação
{
  "updatedAt": 1731622178441,
}
updatedAt : number.
Timestamp Unix da última atualização
{
  "canceledAt": null,
}
canceledAt : number | null.
Timestamp Unix do cancelamento. Pode ser null
{
  "items": [
    {
      "id": "si_abc123",
      "product": "prod_xyz",
      "price": "pri_xyz",
      "name": "Plano Mensal",
      "amount": 9900,
      "quantity": 1,
      "createdAt": 1731622178441,
      "updatedAt": 1731622178441
    }
  ]
}
items : array.
Lista de itens da assinatura. Cada item contém: id (string, prefixo si_), product (ID do produto), price (ID do preço), name, amount (centavos), quantity, createdAt, updatedAt