---
title: "Preview a subscription cancellation"
method: GET
path: "/api/v1/subscriptions/{subscriptionId}/cancel/preview"
tags: ["Subscriptions"]
---

# Preview a subscription cancellation

`GET /api/v1/subscriptions/{subscriptionId}/cancel/preview`

Returns the end date and any refund or final purchase that would be applied if the subscription was cancelled now with the given option. Read-only — no state changes. Required scope: `subscriptions:read`

## Path parameters

- `subscriptionId` integer, required

## Query parameters

- `cancellationOption` 'cancel-immediately' | 'cancel-at-end-of-billing-period'

## Response `200`

Preview of the cancellation outcome

- SubscriptionCancellationPreview — Preview of what would happen if the subscription was cancelled, without performing the cancellation.
  - `endAt` string, date-time, required — The date the subscription would end if cancelled with the requested option.
  - `reconciliation` SubscriptionReconciliation — Refund or final purchase preview attached to a cancellation.
    - `type` 'refund' | 'purchase', required — Reconciliation type — `refund` returns money to the customer, `purchase` charges a final prorated amount.
    - `currentBillingPeriod` SubscriptionBillingPeriod, required — A billing period with start, end, and the amount in the subscription's currency.
      - `start` string, date-time, required — Start of the period (inclusive).
      - `end` string, date-time, required — End of the period (inclusive).
      - `amount` number, required — Amount for the period in the subscription's currency.
      - `currency` string, required — ISO 4217 currency code.
    - `reconciliationPeriod` SubscriptionBillingPeriod, required — A billing period with start, end, and the amount in the subscription's currency.
      - `start` string, date-time, required — Start of the period (inclusive).
      - `end` string, date-time, required — End of the period (inclusive).
      - `amount` number, required — Amount for the period in the subscription's currency.
      - `currency` string, required — ISO 4217 currency code.

## Other responses

- `400` — The request is invalid
- `401` — Consumer with provided credentials was not found
- `403` — Operator doesn't have access to resource
- `404` — Entity with the provided id was not found

---

[API](https://skmtc.net/monta/apis/monta-partner-api.md) · [All operations](https://skmtc.net/monta/apis/monta-partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/monta/monta-partner-api/versions/517e18f11015/schema)