---
title: "Manage Agreement"
method: POST
path: "/gateway/ManageAgreement.json"
---

# Manage Agreement

`POST /gateway/ManageAgreement.json`

Freeze or unfreeze an agreement within a specified date range.

## Request body

- union
  - FreezeAgreement — When the `action` is `freeze`, the `startdate` and `enddate` define the freeze period. The agreement will be frozen from the `startdate` until the `enddate`. The `NextScheduledDate` and `NextPaymentDate` will be set to the day after the `enddate`.
    - `ManageAgreement` object
      - `storeid` string, required — Your store ID.
      - `authkey` string, required — Your authentication key to access the API. You can find the authentication key by navigating to: Merchant Admin -> Integrations -> Hosted Payment Page -> Configuration -> Authentication Key.
      - `agreementid` string, required — The ID of the agreement to be managed.
      - `action` 'freeze', required — The action to be performed on the agreement.
      - `startdate` string, date, required — The start date from when the agreement will be frozen. Format should be YYYY-MM-DD.
      - `enddate` string, date, required — The end date for the freeze period. Format should be YYYY-MM-DD.
  - UnfreezeAgreement — When the `action` is `unfreeze`, the `enddate` is optional. If provided, it will be the date when the agreement is unfreezed. If not provided, the agreement will unfreeze instantly. The `NextScheduledDate` and `NextPaymentDate` will be set to the day after the `enddate`, or the day after the current date if `enddate` is not provided.
    - `ManageAgreement` object
      - `storeid` string, required — Your store ID.
      - `authkey` string, required — Your authentication key to access the API. You can find the authentication key by navigating to: Merchant Admin -> Integrations -> Hosted Payment Page -> Configuration -> Authentication Key.
      - `agreementid` string, required — The ID of the agreement to be managed.
      - `action` 'unfreeze', required — The action to be performed on the agreement.
      - `enddate` string, date — The end date for the action. If provided, it will be the date when the agreement is unfreezed. If not provided, the agreement will unfreeze instantly. Format should be YYYY-MM-DD.

## Response `200`

Successful response or error information.

- union
  - object — Response returned when an agreement is successfully frozen. Includes details about the freeze period and the next scheduled payment dates.
    - `ManageAgreementResponse` object
      - `Code` integer — The response code.
      - `Status` string — The status of the response.
      - `data` object[]
        - `AgreementID` integer — The ID of the agreement.
        - `FreezeStartDate` string, date — The start date of the freeze period.
        - `FreezeEndDate` string, date — The end date of the freeze period.
        - `NextScheduledDate` string, date — The next scheduled date is set to the day after the `FreezeEndDate`.
        - `NextPaymentDate` string, date — The next payment date is set to the day after the `FreezeEndDate`.
  - object — Response returned when an agreement is successfully unfrozen. Includes details about the end of the freeze period and the next scheduled payment dates.
    - `ManageAgreementResponse` object
      - `Code` integer — The response code.
      - `Status` string — The status of the response.
      - `data` object[]
        - `AgreementID` integer — The ID of the agreement.
        - `FreezeEndDate` string, date — The end date of the freeze period (if provided).
        - `NextScheduledDate` string, date — The next scheduled date is set to the day after the `FreezeEndDate` or the day after the current date if `enddate` is not provided.
        - `NextPaymentDate` string, date — The next payment date is set to the day after the `FreezeEndDate` or the day after the current date if `enddate` is not provided.
  - object
    - `code` integer — Error code
    - `status` string — Request status
    - `reason` string — Error reason
    - `errors` string[]

---

[API](https://skmtc.net/telr/apis/remote-json-api-1-0.md) · [All operations](https://skmtc.net/telr/apis/remote-json-api-1-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/telr/remote-json-api-1-0/versions/7a1969c709ba/schema)