Unit.Resource.RecurringPayment (Unit v1.0.0)

Copy Markdown View Source

Represents a recurring payment schedule.

Types

  • recurringCreditAchPayment — recurring ACH credit
  • recurringDebitAchPayment — recurring ACH debit
  • recurringCreditBookPayment — recurring book credit
  • recurringRepayment — recurring credit account repayment

Statuses

  • Active — scheduled and will run
  • Completed — all scheduled occurrences sent
  • Disabled — paused

Summary

Types

t()

Types

t()

@type t() :: %Unit.Resource.RecurringPayment{
  account_id: String.t() | nil,
  amount: integer(),
  counterparty_account_id: String.t() | nil,
  counterparty_id: String.t() | nil,
  created_at: DateTime.t() | nil,
  credit_account_id: String.t() | nil,
  customer_id: String.t() | nil,
  description: String.t() | nil,
  id: String.t(),
  interval: String.t() | nil,
  next_scheduled_action: Date.t() | nil,
  number_of_payments: integer() | nil,
  schedule: map() | nil,
  status: String.t() | nil,
  tags: map(),
  type: String.t(),
  updated_at: DateTime.t() | nil
}