---
title: "List cancellation flows"
method: GET
path: "/vendor/cancellation-flows"
tags: ["Cancellation Flows"]
---

# List cancellation flows

`GET /vendor/cancellation-flows`

## Request

- Base URL: `https://smartrr-dev.local.com`
- URL: `https://smartrr-dev.local.com/vendor/cancellation-flows`
- Auth: API key in header `x-smartrr-access-token`

Requires SUBSCRIPTION read and write access.

## Response `200`

The organization's cancellation flows.

- CancellationFlowCollection
  - `flows` CancellationFlow[], required
    - `uuid` string, uuid, required
    - `label` string, required
    - `order` integer, required
    - `state` 'active' | 'inactive', required
    - `condition` union, required
      - CancellationFlowConditionGroup
        - `type` 'and' | 'or', required
        - `conditions` CancellationFlowCondition[], required
      - CancellationFlowNumericCondition
        - `type` 'orderCount' | 'subscriptionValue' | 'subscriptionTotalQuantity' | 'lifetimeValue' | 'creditBalance' | 'loyaltyTier' | 'distanceToNextLoyaltyTier', required
        - `operator` 'gt' | 'gte' | 'lt' | 'lte' | 'eq', required
        - `value` number, required
      - CancellationFlowProductCondition
        - `type` 'product', required
        - `operator` 'is' | 'not', required
        - `value` string, uuid, required
      - CancellationFlowShippingIntervalCondition
        - `type` 'shippingInterval', required
        - `operator` 'is' | 'not', required
        - `value` CancellationFlowInterval, required
          - `years` integer
          - `months` integer
          - `weeks` integer
          - `days` integer
          - `hours` integer
          - `minutes` integer
          - `seconds` integer
      - CancellationFlowCreationDateCondition
        - `type` 'subscriptionCreationDate', required
        - `operator` 'gt' | 'lt' | 'eq', required
        - `value` string, date-time, required
      - union
        - object
          - `type` 'subscriptionNextBillingDate', required
          - `operator` 'gt' | 'lt' | 'eq', required
          - `value` string, date-time, required
        - object
          - `type` 'subscriptionNextBillingDate', required
          - `operator` 'within', required
          - `interval` CancellationFlowInterval, required
            - `years` integer
            - `months` integer
            - `weeks` integer
            - `days` integer
            - `hours` integer
            - `minutes` integer
            - `seconds` integer
      - CancellationFlowSubscriptionStateCondition
        - `type` 'subscriptionState', required
        - `value` 'active' | 'paused', required
      - CancellationFlowBooleanCondition
        - `type` 'prepaid' | 'prepaidRenewing', required
        - `operator` 'is' | 'not', required
    - `reasons` CancellationFlowReason[], required
      - `uuid` string, uuid, required
      - `label` string, required

## Other responses

- `400`: The request is invalid or the access token is missing or invalid.
- `401`: The access token does not grant the required scope.

## Changes

- **2026-10-23** `e0f19b14bb6d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/smartrr/apis/smartrr-api/changes/vendor/cancellation-flows/get.md)

---

[API](https://skmtc.dev/smartrr/apis/smartrr-api.md) - [All operations](https://skmtc.dev/smartrr/apis/smartrr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/smartrr/apis/smartrr-api/revisions/1039006caa74?raw)