Recurring schedules: Retrieves a filtered list of recurring invoice schedules.

GET /api/invoicing/recurring-schedules deprecated

Requires: Invoicing.RecurringSchedules, merchant scope.

The paging shape of this endpoint is provisional and is expected to move to continuation tokens (Cosmos charges request units for every skipped row), so integrators should not rely on the current offset parameters as a stable contract. Filter by biller, status, and creation time instead of paging deeply.

Parameters

Name	In	Type	Description
`BillerId` required	query	string (uuid)	Filter by billing entity. Required for partition-scoped queries.
`Status` required	query	WinkPGInvoicingRecurringInvoiceScheduleStatus	Filter by series status.
`MinCreationTime` required	query	string (date-time)	Filter to series created on or after this time (CreationTime date-range chip lower bound).
`MaxCreationTime` required	query	string (date-time)	Filter to series created on or before this time (CreationTime date-range chip upper bound).
`Filter` required	query	string	Gets or sets a general filter string for the result set.
`Name` required	query	string	Gets or sets the name filter for the result set.
`IncludeDeleted` required	query	boolean	Gets or sets a value indicating whether to include deleted entities in the result set.
`IncludeInactive` required	query	boolean	Gets or sets a value indicating whether to include inactive entities in the result set.
`Ids` required	query	array of string (uuid)	Gets or sets a list of entity IDs to filter the result set.
`Sorting` required	query	string
`SkipCount` required	query	integer (int32)
`MaxResultCount` required	query	integer (int32)
`ExtraProperties` required	query	object
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.