# ContractSchedule

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

## Fields
- `frequency` ([Frequency](https://devportal.signapay-sbx.winkpg.io/docs/api/models/Frequency.md)): The type of the recurrence rule.
  Values:
  - `Secondly`
  - `Minutely`
  - `Hourly`
  - `Daily`
  - `Weekly`
  - `Monthly`
  - `Yearly`
- `count` (integer(int32)): The number of occurrences in a particular recurrence. (nullable)
- `until` (string(date-time)): The datetime that bounds the current recurrence. (nullable)
- `interval` (integer(int32)): The recurrence interval.
- `bySecond` (array<integer(int32)>): BySecond rule modifier. (nullable)
- `byMinute` (array<integer(int32)>): BySecond rule modifier. (nullable)
- `byHour` (array<integer(int32)>): BySecond rule modifier. (nullable)
- `byDay` (array<[ContractScheduleByDayRule](https://devportal.signapay-sbx.winkpg.io/docs/api/models/ContractScheduleByDayRule.md)>): Week day rule modifier. (nullable)
  Fields of each item:
  - `day` ([DayOfWeek](https://devportal.signapay-sbx.winkpg.io/docs/api/models/DayOfWeek.md)): The day of the week
    Values:
    - `Sunday`
    - `Monday`
    - `Tuesday`
    - `Wednesday`
    - `Thursday`
    - `Friday`
    - `Saturday`
  - `offset` (integer(int32)): The day of week offset
- `byMonth` (array<integer(int32)>): Month day rule modifier. (nullable)
- `byMonthDay` (array<integer(int32)>): Month days rule modifier. (nullable)
- `byYearDay` (array<integer(int32)>): Year days rule modifier. (nullable)
- `byWeekNumber` (array<integer(int32)>): Week number rule modifier. (nullable)
- `bySetPosition` (array<integer(int32)>): BySetPosition rule modifier. (nullable)
- `firstDayOfWeek` ([DayOfWeek](https://devportal.signapay-sbx.winkpg.io/docs/api/models/DayOfWeek.md)): The first day of week, used in calculating weekday-based recurrences (nullable)
  Values:
  - `Sunday`
  - `Monday`
  - `Tuesday`
  - `Wednesday`
  - `Thursday`
  - `Friday`
  - `Saturday`
- `nextScheduledRun` (string(date-time)): The next computed billing date, updated after each billing run. Null for contracts that have never been scheduled or have ended. (nullable)
- `startDate` (string(date-time)): The earliest date on which this contract is eligible to bill. Set by the user when creating the contract (defaults to the creation date) and may be set to a future date to delay first billing. The recurrence engine anchors expansion to this date and the daily billing job will not fire a contract whose `startDate` is in the future.              Null on contracts created before this field existed. When it is null, the server anchors the schedule on the contract's creation time, or on the current time when that is also absent; callers that compute a schedule themselves should apply the same fallback. (nullable)

## See also

- [All documentation](https://devportal.signapay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.