Skip to main content
PATCH
Update Payment Plan Payments

Authorizations

Authorization
string
header
required

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

Headers

Accept-Encoding
string

We can compress a response with gzip.

Example:

"gzip deflate"

API-Version
string

API API Version. See Versioning page for more details.

Example:

"2024-07-01"

Path Parameters

id
integer
required

An userId.

Example:

1

payment_plan_id
integer
required

An payment plan ID.

Example:

1

payment_id
integer
required

An payment plan payment ID.

Example:

1

Body

application/json
status
enum<string>
required

The payment plan payment status.

Available options:
upcoming,
paid
Example:

"paid"

Response

Returns an updated payment plan payment

id
integer
required

Payment Plan Payment ID

Example:

1

amount
integer
required

Payment amount in cents

Example:

10000

status
enum<string>
required

Indicates whether payment is paid or upcoming

Available options:
upcoming,
paid
Example:

"upcoming"

type
enum<string>
required

Indicates type of payment.

Available options:
minimum,
priority,
final
Example:

"priority"

payment_date
string
required

When payment should be made

Example:

"2026-06-06"

account_id
integer
required

Account ID for which payment should be made

Example:

2

estimated_balance
integer

Expected amount of loan after payment

Example:

4313500

estimated_payoff_date
string

Expected payoff date for the loan

Example:

"2031-06-01"