Change Agreement Status
PATCH/agreements/:id/status
There are three types of agreement states changes that could be requested; 'cancel', 'suspend' and 'release'.
The status can only be changed when the agreement is currently active or suspended.
To release an Agreement is to activate a suspended agreement. Releasing a suspended agreement can only be performed by the party that suspended the agreement.
To suspend an Agreement is equivalent to pausing payments for the agreement.
A cancelled agreement cannot be further updated.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 500
- 503
OK
Response Headers
Bad Request
Request is not well-formed, syntactically incorrect, or violates schema.
Response Headers
Unauthorized
Requires authentication
Response Headers
Forbidden
Token is missing required authorization scope
Response Headers
Not Found
Response Headers
Unprocessable Entity
The API cannot complete the requested action, or the request action is semantically incorrect or fails business validation.
Response Headers
Internal Server Error
An internal server error has occurred.
Response Headers
Service Unavailable - Temporarily Unavailable