suspend agreement

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

A supplied unique ID

Body Params
string
enum
required

Reason for the agreement being suspended

Allowed:
string | null

Free text field to store a description to accompany the given reason_code

sandbox
object

SANDBOX ONLY: Parameter that allows you to simulate certain scenarios in regards to the created agreement suspension to aid integrators while testing their control flows.

Headers
string
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses
202

accepted

403

forbidden

404

Not Found

500

Internal Server Error

Callbacks
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json