Pular para o conteúdo principal

subscription.renewed

Disparado quando uma assinatura é criada (primeira cobrança) ou renovada (cobranças recorrentes).

Quando é disparado

  • Cliente assina um plano e a primeira cobrança é aprovada.
  • O job de renovação cobra a próxima parcela e o pagamento é aprovado.

Exemplo de payload

{
"event": "subscription.renewed",
"data": {
"subscriptionId": "uuid-da-assinatura",
"transactionId": "uuid-da-transacao",
"productId": "uuid-do-produto",
"productName": "Nome do Produto",
"amount": 47.00,
"currency": "BRL",
"frequency": "monthly",
"customer": {
"email": "cliente@email.com",
"name": "Nome do Cliente",
"document": "12345678900",
"phone": "11999999999"
},
"currentPeriodStart": "2025-01-28T00:00:00.000Z",
"currentPeriodEnd": "2025-02-28T00:00:00.000Z",
"nextBillingDate": "2025-02-28T00:00:00.000Z",
"status": "active",
"createdAt": "2025-01-28T12:00:00.000Z"
},
"timestamp": "2025-01-28T12:00:00.000Z",
"webhookId": "uuid-do-webhook"
}

Campos do data

CampoTipoDescrição
subscriptionIdstringID da assinatura no TukanoPay.
transactionIdstringID da transação desta cobrança.
productIdstringID do produto.
productNamestringNome do produto.
amountnumberValor cobrado em reais.
currencystringMoeda.
frequencystringFrequência: monthly, yearly, etc.
customerobjectDados do assinante.
currentPeriodStartstringInício do período vigente em ISO 8601.
currentPeriodEndstringFim do período vigente em ISO 8601.
nextBillingDatestringPróxima data de cobrança em ISO 8601.
statusstringStatus da assinatura (ex.: active).
createdAtstringData de criação da transação em ISO 8601.