---
title: "Retrieve Cancelled Agreements"
method: POST
path: "/gateway/cancelledAgreement.json"
tags: ["Telr Agreement APIs"]
---

# Retrieve Cancelled Agreements

`POST /gateway/cancelledAgreement.json`

Retrieves agreements cancelled within the given date range, including agreements where cancellation takes effect at end of the current billing period. Maximum date range: 2 months.

## Request body

- object
  - `CancelledAgreement` object, required
    - `storeid` string, required — Your Store ID.
    - `authkey` string, required — Authentication key. Found in Merchant Admin → Integrations → Hosted Payment Page → Configuration → Authentication Key.
    - `Fromdate` string, date, required — Start date for filtering. Format: YYYY-MM-DD.
    - `Todate` string, date, required — End date for filtering. Format: YYYY-MM-DD. Range cannot exceed 2 months.

## Response `200`

Successful response with cancelled agreements data or error information.

- union
  - object
    - `CancelledAgreementResponse` object
      - `Code` integer
      - `Status` string
      - `data` CancelledAgreementItem[]
        - `AgreementID` integer — Unique identifier for the agreement.
        - `AgreementStatus` string — Agreement status at time of query: Running, Overdue, Pending, Failed, Completed, or Cancelled.
        - `CancelDate` string — Date the cancellation was recorded. Raw SQL Server datetime string (e.g. Jun 5 2026 12:00:00:000AM).
        - `Description` string — Agreement cart description.
        - `CustomerEmail` string, email — Customer email address from the agreement.
        - `CancelledBy` string, email — Email address of the operator who performed the cancellation.
        - `Reason` string — Cancellation reason text. Returns NA when no reason is recorded.
        - `Document` string — Cancellation document reference. Omitted entirely when no document is linked to the cancellation reason.
        - `LastPaidDate` string — Date of the last successful payment. Raw SQL Server datetime string.
        - `AuthCount` string — Number of successful authorisations on this agreement (returned as string).
        - `NextDueAmount` string — Regular payment amount in major currency units (minor units ÷ 100).
        - `MembershipDropOutDate` string — Date membership access expires (cancel_date + 31 days). Raw SQL Server datetime string.
  - ErrorResponse
    - `code` integer — Error code
    - `status` string — Request status
    - `reason` string — Error reason
    - `errors` string[]

---

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