API Reference

Update Payment Plan

patch
https://{your-totality-url}.com/api/payment-plans/

Update an existing payment plan. Only collectorUserId, contactMethod, and isActive can be changed. Setting contactMethod to null removes the existing contact record. Permission: Update Payment Plans

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The UUID of the payment plan to update.

Body Params
integer | null

ID of the user (collector) the plan is assigned to. Must reference an existing user. Pass null to clear.

string | null
enum

How the customer was contacted to set up the plan. One of: Automation, Email, Phone, SMS, Self-Service Portal, Webchat, Other. Pass null to remove the contact method record.

Allowed:
boolean

Whether the payment plan is active.

Headers
string
required
Defaults to application/vnd.totality.v1+json

Must be application/vnd.totality.v1+json.

string
required
Defaults to application/json

Must be application/json.

Responses

404

Resource not found

500

Internal server error

Updated 12 days ago

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 12 days ago