Pause Schedule

Stop a recurring payment from generating payments until a specified date.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

To confirm that a schedule has been paused, retrieve the recurring payment object and check the ScheduleStatus field. Paused schedules will have a ScheduleStatus of Suspended and the PauseUntilDate field will reflect the date entered in your request.

A paused schedule can be manually resumed at any time by calling Resume Schedule , and can also be suspended indefinitely by calling Suspend.

Path Params
string
required

Id of the recurring payment to pause.

Query Params
date
required

Date the schedule will resume. (Date format YYYY-MM-DD)

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json