Cancel agreement
POST/v1/agreements/:id/cancel
Cancels an agreement, recording cancelled_at and the reason, and cancels pending/overdue installments. completed or already-cancelled agreements return 409.
Request​
Responses​
- 200
- 400
- 401
- 403
- 404
- 409
- 413
- 429
- 500
Agreement cancelled (returns the agreement with its installments).
Invalid request (validation error).
Missing, invalid, expired or revoked token.
The token lacks the scope required by this operation.
Resource not found or outside your organization.
Conflict with the current resource state (or reused idempotency key).
Request body larger than 2 MB.
Rate limit exceeded (600 per minute per key; 60 invalid attempts per minute per IP). Wait for Retry-After.
Internal error. Retry; if it persists, contact support.