Skip to main content
GET
List recurring billing schedules

Authorizations

Authorization
string
header
required

Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.

Query Parameters

searchFilter
string

Free-text search across common schedule fields.

isActive
integer<int32>

-1 = all, 0 = inactive, 1 = active (default).

pageNumber
integer<int32>

1-based page index (1–10000). Default 1.

Response

OK

recurringBillingID
integer<int64>
engagementID
integer<int32> | null
engagementName
string | null
engagementStatusID
integer<int32> | null
isEngagementFinalised
boolean
entityID
integer<int32>
isOnboardingEntity
boolean
clientName
string | null
currencyID
integer<int32>
frequency
string | null
startDate
string<date>
endDate
string<date> | null
nextRunDate
string<date>
billAmount
number<double>
billTax
number<double>
billTotal
number<double>
billDetails
string | null
packageNumber
integer<int32> | null
dueDays
integer<int32>
refNo
string | null
isActive
boolean
createdOn
string<date-time>
updatedOn
string<date-time>