Subscription Recurrence Webhook Events

POSThttps://your-server.com/webhooks/easyflow

Listen to subscription recurrence events to keep your integration always synchronized.

Your application receives a notification whenever the status of an individual recurrence (payment attempt) within a subscription changes.

Recurrence Events

subscriptionRecurrence.canceled — Recurrence payment canceled.
subscriptionRecurrence.delayed — Recurrence payment delayed.
subscriptionRecurrence.failed — Recurrence payment failed.
subscriptionRecurrence.paid — Recurrence payment successfully paid.

Example payload

{
  "event": "subscriptionRecurrence.paid",
  "occurredAt": "2026-02-15T09:00:12.000Z",
  "payload": {
    "id": "5d6e7f8a-9b0c-4d1e-8f2a-3b4c5d6e7f8a",
    "subscriptionId": "4c5d6e7f-8a9b-4c0d-9e1f-2a3b4c5d6e7f",
    "status": "paid",
    "billingDate": "2026-02-15T09:00:00.000Z",
    "createdAt": "2026-01-15T14:30:00.000Z",
    "dueDate": "2026-02-15T09:00:00.000Z",
    "paidAt": "2026-02-15T09:00:08.000Z",
    "recurrence": 2,
    "recurrenceValueInCents": 1990,
    "retry": {
      "retries": 0
    },
    "payments": [
      {
        "id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
        "paymentMethod": "credit-card",
        "status": "paid",
        "valueInCents": 1990,
        "valuePaidInCents": 1990,
        "fineValueInCents": 0,
        "interestValueInCents": 0,
        "installments": 1,
        "creditCard": {
          "last4Numbers": "1111",
          "flag": "visa",
          "expiresAtMonth": 12,
          "expiresAtYear": 2032,
          "holderName": "MARIA SILVA"
        }
      }
    ]
  }
}

Events4

subscriptionRecurrence.canceled
subscriptionRecurrence.delayed
subscriptionRecurrence.failed
subscriptionRecurrence.paid

Easyflow sends an HTTP request with this payload to the URL registered for your webhook.

Payloadrequired

Webhook payload with the data of the subscription recurrence event.

Content typeapplication/jsonobject

eventstring
Name of the event received.

Possible values:subscriptionRecurrence.canceledsubscriptionRecurrence.delayedsubscriptionRecurrence.failedsubscriptionRecurrence.paid
occurredAtstring · date-time
Date and time when the notification was sent, in UTC.
payloadobject
Complete recurrence data.
Show child attributesHide child attributes
- idstring · uuid
- subscriptionIdstring · uuid
- statusstring
  Possible values:pendingchargeddelayedfailedpaidcanceledrefunded
- billingDatestring · date-time
- createdAtstring · date-time
- dueDatestring · date-time
- paidAtstring · date-timenullable
- recurrenceinteger
- recurrenceValueInCentsinteger
- retryobject
  Show child attributesHide child attributes
  lastRetrystring · date-time
  nextRetrystring · date-time
  retriesinteger
- paymentsarray of objects
  In this event, pix, bankBillet and creditCard are always objects. Their fields are absent when they do not apply to the payment method.
  Show child attributesHide child attributes
  idstring
  paymentMethodstring
  Payment method, such as credit-card, pix or bank-billet.
  
  statusstring
  Possible values:pendingin-processingauthorizedpaidpartially-paidrefusedabortedcanceledcharged-backchargeback-in-disputeunpaidaccepteddeniedreversedrefunded
  valueInCentsinteger
  valuePaidInCentsinteger
  fineValueInCentsinteger
  interestValueInCentsinteger
  installmentsinteger
  pixobjectnullable
  Show child attributesHide child attributes
  copyAndPasteCodestringnullable
  qrCodestringnullable
  expireAtstring · date-timenullable
  bankBilletobjectnullable
  Show child attributesHide child attributes
  expireAtstring · date-timenullable
  barCodestringnullable
  linkstringnullable
  linestringnullable
  creditCardobjectnullable
  Show child attributesHide child attributes
  last4Numbersstring
  flagstring
  Possible values:visamastercardamerican-expressdiners-clubdiscoverjcbunionpaymaestromirelohiperhipercard
  expiresAtYearinteger
  expiresAtMonthinteger
  holderNamestring
  nicknamestring
  refuseobjectnullable
  Reason why the payment was refused.
  
  Show child attributesHide child attributes
  rawDescriptionstring
  typestringnullable