Get a payment run schedule

Gets details about a particular payment run schedule.

Note: The Collections Window, Notes, Advanced Payment Manager, Payment Plans, and Statement Generator features are entering end of support on June 3, 2024. For more information, please refer to the Product and Feature End of Support page.

Request
path Parameters
schedule_id
required
integer

The schedule ID

Responses
200
get/api/v1/payment_run_schedules/{schedule_id}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "id": 6,
  • "status": "Active",
  • "filter": "Account.BillCycleDay = 8",
  • "schedule": "At 6:00 AM, only on Monday and Tuesday"
}