Skip to main content

Recurring Repayment Events

Unit raises events related to recurring repayments that you can subscribe to via webhooks. These events allow you to track the lifecycle of recurring repayments and respond to status changes in real-time.

Available Events

EventDescription
recurringRepayment.createdRaised when a new recurring repayment is created.
recurringRepayment.statusChangedRaised when the status of a recurring repayment changes (e.g., from Active to Disabled).
recurringRepayment.failedRaised when a recurring repayment fails to create a scheduled repayment.
recurringRepayment.skippedRaised when a scheduled repayment is skipped (e.g., due to zero balance).

Event Payloads

recurringRepayment.created

This event is raised when a recurring repayment is successfully created.

Related resource types:

recurringRepayment.statusChanged

This event is raised when the status of a recurring repayment changes. Common status transitions include:

  • ActiveDisabled (Recurring repayment disabled manually or due to account closure)
  • DisabledActive (Recurring repayment re-enabled)

Related resource types:

recurringRepayment.failed

This event is raised when a recurring repayment schedule fails to create a repayment. This may occur due to issues with the counterparty account, insufficient funds, or other payment failures.

Related resource types:

recurringRepayment.skipped

This event is raised when a scheduled repayment is skipped because the remaining amount due on the credit account is 0.

Related resource types:

When working with recurring repayments, you may also want to subscribe to these related events:

EventDescription
repayment.createdRaised when a repayment is created by the recurring repayment schedule.
repayment.statusChangedRaised when the status of the underlying repayment changes.
payment.createdRaised when the underlying payment for a native repayment is created.
payment.sentRaised when the underlying payment is sent/completed.
payment.returnedRaised when the underlying ACH payment is returned.

For more details on all available events and their payloads, see the Events API reference.