---
title: "suspend agreement"
method: POST
path: "/payto/agreements/{agreement_uid}/suspension"
tags: ["Agreement modification"]
---

# suspend agreement

`POST /payto/agreements/{agreement_uid}/suspension`

## Request body

- PaytoSuspensionRequest
  - `reason` 'customer_requested' | 'initiating_party_requested' | 'mandate_suspended_final_collection' | 'mandate_suspended_one_collection', required — Reason for the agreement being suspended
  - `narrative` string, nullable — 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.
    - `simulate` 'agreement_cancelled' | 'successful_suspension', required
    - `delay` integer — An optional attribute that will delay the requested simulation by the given amount of seconds. If `delay` is not provided (default behaviour), the simulated action will happen instantly.

## Response `202`

accepted

## Other responses

- `400` — Bad Request
- `401` — unauthorized
- `403` — forbidden
- `404` — Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/zeptopayments/apis/zepto-api.md) · [All operations](https://skmtc.net/zeptopayments/apis/zepto-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zeptopayments/zepto-api/revisions/6353e9b9af6f/schema)