HomeGuidesAPI Reference

EndOfMonthSchedule

Payitoff API: EndOfMonthSchedule Schema

An EndOfMonthSchedule object can be used when creating or editing a PaymentSeries to define the recurring schedule you want an automated PaymentSeries to follow.

Schema Definition

Properties in bold are required.

PropertyTypeFormatDescription
end_datestringformatAn ISO Date string indicating when this PaymentSeries should end.
end_of_monthbooleanCan only be true to indicate you wish the payment to always occur on the last day of the month.
start_datestringdateAn ISO Date string indicating when this PaymentSeries should begin.

Example

{
  "end_date": "2022-09-01",
  "end_of_month": true,
  "start_date": "2021-09-01"
}