/v1/payment-schedules/{id}/pausePause collection on a schedule
Stops collecting on a schedule and clears its next payment date. Body: an optional reason, kept as the schedule's last modification reason. Legal from active only, so a second press changes nothing and answers not found — which is also what makes the modification count honest. Restart it with post_payment_schedules_id_resume; to close a schedule out for good use post_payment_schedules_id_complete, and to stop a merchant's debits at the source revoke the authorisation with post_servicing_authorizations_id_revoke.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
the action's answer
{
"data": {
"actualEndDate": "string",
"collectionRate": "string",
"completedAt": "string",
"consecutiveMissed": 1,
"contractId": 1,
"createdAt": "string",
"currency": "string",
"daysDelinquent": 1,
"dealRowId": "",
"detail": {},
"expectedEndDate": "string",
"facilityId": 1,
"factorRate": "string",
"fundedAmountMinor": 1,
"fundingRecordId": 1,
"id": 1,
"interestRate": "string",
"internalNotes": "string",
"isDelinquent": true,
"lastModifiedReason": "string",
"modificationsCount": 1,
"nextPaymentDate": "string",
"offerId": 1,
"originationFeeMinor": 1,
"otherFeesMinor": 1,
"pausedAt": "string",
"paymentAmountMinor": 1,
"paymentFrequency": "string",
"paymentMethod": "string",
"paymentsMade": 1,
"paymentsRemaining": 1,
"paymentsWaived": 1,
"scheduleNumber": "string",
"startDate": "string",
"status": "string",
"totalCollectedMinor": 1,
"totalMissedMinor": 1,
"totalOutstandingMinor": 1,
"totalPaybackMinor": 1,
"totalPayments": 1,
"updatedAt": "string"
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}