Get payment plan
Get a single payment plan by its id.
Required scope: read:payment-plans
Authorizations
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
Id of the tenant the payment plans belong to
Id of the payment plan
Response
Successful operation
Id of the payment plan
Id of the case the plan belongs to
Status of the plan. Deleted plans keep their row with status DELETED and a deletedAt timestamp.
CREATED, ACTIVE, FINISHED, CANCELED, DELETED Whether the plan activates automatically when the debtor accepts it
Timestamp the plan was created at
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.
Timestamp the plan was deleted at
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.
Whether the plan document has been signed
Id of the plan document
Timestamp the plan document was signed at
Id of the signed plan document file
Id of the payment method the plan settles with
Status of the payment method
Type of the payment method
Payment provider behind the payment method
Configuration the plan was generated from
Entries of the plan, oldest first