v1
latestOpenAPI 3.1.02026-07-243113441.2 MBPreview pay schedule dates
Provides a preview of a pay schedule with the specified parameters for the next 18 months. Use this before creating or updating a pay schedule to show expected check dates, pay period boundaries, and payroll deadlines.
Related guides
scope: pay_schedules:write
Path parameters
The UUID of the company
Query parameters
The frequency that employees on this pay schedule are paid with Gusto.
The first date that employees on this pay schedule are paid with Gusto.
The last date of the first pay period. This can be the same date as the anchor pay date.
An integer between 1 and 31 indicating the first day of the month that employees are paid. This field is only relevant for pay schedules with the "Twice per month" and "Monthly" frequencies. It will be null for pay schedules with other frequencies.
An integer between 1 and 31 indicating the second day of the month that employees are paid. This field is the second pay date for pay schedules with the "Twice per month" frequency. For semi-monthly pay schedules, set this field to 31. For months shorter than 31 days, the second pay date is set to the last day of the month. It will be null for pay schedules with other frequencies.
End date for the preview range. If given, this date must be in the future. When unspecified, defaults to 18 months from today.
Optional UUID of an existing pay schedule. When supplied, the preview is seeded from the persisted schedule — including internal flags (such as arrears handling) that affect period boundaries but are not exposed as request parameters. Any other query parameters override individual attributes on top of the loaded schedule.
Headers
Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Response
Successful