Skip to main content
GET
Get payment plan

Authorizations

Authorization
string
header
required

Authentication can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}.

Path Parameters

tenantId
string<uuid>
required

Id of the tenant the payment plans belong to

paymentPlanId
string<uuid>
required

Id of the payment plan

Response

Successful operation

paymentPlanId
string<uuid>

Id of the payment plan

caseId
string<uuid>

Id of the case the plan belongs to

status
enum<string>

Status of the plan. Deleted plans keep their row with status DELETED and a deletedAt timestamp.

Available options:
CREATED,
ACTIVE,
FINISHED,
CANCELED,
DELETED
activationTrigger
boolean

Whether the plan activates automatically when the debtor accepts it

createdAt
string

Timestamp the plan was created at

createdBy
object | null

Who created the plan. Always carries a type (e.g. USER, KEY, WORKFLOW, AI, SYSTEM); most types add an id, and some carry extra type-specific fields. null when unknown.

deletedAt
string | null

Timestamp the plan was deleted at

deletedBy
object | null

Who deleted the plan. Always carries a type (e.g. USER, KEY, WORKFLOW, AI, SYSTEM); most types add an id, and some carry extra type-specific fields. null when unknown.

signed
boolean

Whether the plan document has been signed

documentId
string<uuid> | null

Id of the plan document

documentSignedAt
string | null

Timestamp the plan document was signed at

documentFileId
string<uuid> | null

Id of the signed plan document file

paymentMethodId
string<uuid> | null

Id of the payment method the plan settles with

paymentMethodStatus
string | null

Status of the payment method

paymentMethodType
string | null

Type of the payment method

provider
string | null

Payment provider behind the payment method

config
object | null

Configuration the plan was generated from

plan
object[]

Entries of the plan, oldest first