Skip to main content

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 API

​
List Subscriptions

GET /api/subscriptions?page=1&status=ACTIVE&search=consulting

​
Get Subscription

GET /api/subscriptions/:id

​
Detect Subscriptions

POST /api/subscriptions/detect

{
  "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

POST /api/subscriptions/:id/dismiss
Removes a detected subscription (sets status to DISMISSED). Transactions remain linked.