Cancel agreement
POST/api/v1/agreements/:id/cancel
Cancels an agreement, recording cancelledAt and the reason, and cancels pending/overdue installments. completed or already-cancelled agreements return 409.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 429
- 500
Agreement cancelled (returns the agreement with its installments).
Invalid request (validation error).
Missing, invalid, expired or revoked API key.
The key lacks the scope required by this operation.
Resource not found or outside your organization.
Conflict with the current resource state (or reused idempotency key).
Rate limit exceeded. Wait and retry.
Internal error. Retry; if it persists, contact support.