Skip to main content
List recurring series (subscriptions)
curl --request GET \
  --url https://breadbox.example.com/api/v1/series \
  --header 'X-API-Key: <api-key>'
{
  "series": [
    {
      "id": "<string>",
      "short_id": "<string>",
      "name": "<string>",
      "merchant_key": "<string>",
      "cadence": "<string>",
      "expected_amount": 123,
      "iso_currency_code": "<string>",
      "status": "<string>",
      "confidence": "<string>",
      "detection_source": "<string>",
      "last_amount": 123,
      "last_seen_date": "2023-12-25",
      "next_expected_date": "2023-12-25",
      "occurrence_count": 123,
      "detection_signals": {},
      "tags": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Breadbox API key with format bb_<base62>. Carries either read_only or full_access scope. Write endpoints (and a handful of sensitive reads — /api-keys, /users/{user_id}/login) require full_access; endpoints that require it are flagged in their description.

Query Parameters

​
status
enum<string>
Available options:
active,
candidate,
paused,
cancelled

Response

200 - application/json

Recurring series.

​
series
object[]
Last modified on May 30, 2026