Skip to main content
GET
Load a recurring billing schedule

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.

Path Parameters

recurringBillingId
integer<int64>
required

Recurring billing schedule id.

Response

OK

recurringBillingID
integer<int64>
engagementID
integer<int32> | null
entityID
integer<int32>
isOnboardingEntity
boolean
entityName
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
brandingThemeID
string | null
dueDays
integer<int32>
refNo
string | null
isActive
boolean
sendBill
boolean
billNow
integer<int32>
createdOn
string<date-time>
updatedOn
string<date-time>
lineItems
object[] | null