Skip to main content
POST
Create payment-plan offer

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
first_pay_date
string<date>
required

First payment date. Must be after today and no later than the server-computed max first-payment date.

Example:

"2026-06-10"

action_context
object

Response

Payment-plan offer created.

message
string
required
Examples:

"Settlement offer created."

"Payment plan offer created."

"Custom offer accepted."

"Custom offer sent."

"Creditor offer accepted."

"Counter offer sent."

data
object
required
Last modified on July 19, 2026