> ## Documentation Index
> Fetch the complete documentation index at: https://test-docs.upayments.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Subscriptions

> Query and manage subscriptions

# Subscriptions API

## List Subscriptions

```bash theme={null}
GET /api/subscriptions?page=1&status=ACTIVE&search=consulting
```

## Get Subscription

```bash theme={null}
GET /api/subscriptions/:id
```

## Detect Subscriptions

```bash theme={null}
POST /api/subscriptions/detect
```

```json theme={null}
{
  "merchantIds": ["clx..."],
  "minTransactions": 2,
  "matchDescription": true,
  "includeTerms": ["Consulting Services", "Monthly Retainer"],
  "excludeTerms": ["setup fee", "one-time"],
  "removeExisting": false
}
```

Triggers subscription detection from transaction patterns. Returns count of detected subscriptions.

## Remove Detected Subscription

```bash theme={null}
POST /api/subscriptions/:id/dismiss
```

Removes a detected subscription (sets status to DISMISSED). Transactions remain linked.