Skip to main content
PATCH
Update recurring schedule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

consumer
integer
required

Consumer account ID.

Body

application/json
installment_type
enum<string>
required

New recurring schedule frequency.

Available options:
weekly,
bimonthly,
monthly
Example:

"weekly"

new_first_pay_date
string<date>
required

First date for the rebuilt recurring schedule. Must be after tomorrow.

Example:

"2026-06-20"

Response

Recurring schedule updated.

message
string
required
Examples:

"Payment rescheduled for today."

"Payment skipped."

"Payment scheduled for today was not skipped."

"Payment date updated."

"Settlement date updated."

"Awesome! Your offer was sent to your creditor!"

"Recurring payment schedule updated."

"Payment plan cancelled."

"Settlement cancelled."

"Payment processed."

"Partial payment processed."

"Remaining balance paid."

"Extra payment processed."

data
object
required
Last modified on July 19, 2026