Skip to main content
POST
Create an approved payment plan

Authorizations

Authorization
string
header
required

OAuth2 access token or static API token. See Authorization for how to obtain one.

Body

Create an approved payment plan

administration_id
string
required

Administration identifier

terms
object[]
required

List of terms for payment plan

cc_email_address
string

Email address to send a copy of the payment plan

invoice_numbers
string[]

List of invoices by invoice_number to include in the payment plan

invoice_identifiers
string[]

List of invoices by invoice_identifier to include

credit_case_numbers
string[]

List of credit cases by credit_case_number to include

Response

Created payment plan

CustomerApi_V1_PaymentPlanEntity model

auto_activated
boolean
required

Whether the payment plan was auto-activated

administration_id
string
required

Owning administration identifier

debtor_id
string
required

Associated debtor identifier

id
string
required

Unique identifier

created_at
string<date-time>
required

Timestamp at which the payment plan was created

updated_at
string<date-time>
required

Timestamp at which the payment_plan was last updated

payment_terms
object[]

Payment terms

active
boolean

Whether the payment plan is active

reason
string

Reason for proposing payment plan provided by debtor

rejected_by_user
object

User who rejected the proposed payment plan

approved_at
string<date-time>

Timestamp at which the payment plan was approved

deactivated_at
string<date-time>

Timestamp at which the payment plan was deactivated

proposed_at
string<date-time>

Timestamp at which the payment plan was proposed

rejected_at
string<date-time>

Timestamp at which the payment plan was rejected

public_url
string

Link to the debtor portal (request with the 'fields' parameter)

Last modified on August 13, 2026