{"openapi":"3.1.0","info":{"title":"GET /api/v1/subscriptions/","version":"1.0.0","description":"List detected recurring transactions"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/subscriptions/":{"get":{"tags":["subscriptions"],"summary":"List detected recurring transactions","description":"Detect recurring transactions from transaction history using counterparty and frequency analysis.","operationId":"list_subscriptions","parameters":[{"name":"lookback_days","in":"query","required":false,"schema":{"type":"integer","maximum":730,"minimum":30,"description":"Days to look back","default":180,"title":"Lookback Days"},"description":"Days to look back"},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","description":"Sort: cost_desc, cost_asc, frequency, confidence_desc, recent, occurrences_desc","default":"cost_desc","title":"Sort By"},"description":"Sort: cost_desc, cost_asc, frequency, confidence_desc, recent, occurrences_desc"},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ListSubscriptionsResponse_"}}}},"401":{"description":"Unauthorized - Missing/invalid token or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"list_subscriptions_api_v1_subscriptions__get"}}},"components":{"schemas":{"DetectedSubscriptionResponse":{"properties":{"counterparty_key":{"type":"string","title":"Counterparty Key"},"counterparty_display":{"type":"string","title":"Counterparty Display"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"registry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Id"},"avg_amount_cents":{"type":"integer","title":"Avg Amount Cents","description":"Average charge in cents (negative = expense)"},"last_amount_cents":{"type":"integer","title":"Last Amount Cents"},"estimated_monthly_cents":{"type":"integer","title":"Estimated Monthly Cents","description":"Estimated monthly cost in cents"},"period_total_cents":{"type":"integer","title":"Period Total Cents","description":"Total spent during the lookback period in cents","default":0},"frequency":{"type":"string","title":"Frequency","description":"weekly | biweekly | monthly | quarterly | semi-annual | annual"},"occurrence_count":{"type":"integer","title":"Occurrence Count"},"last_date":{"type":"string","title":"Last Date"},"next_expected_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Expected Date"},"confidence":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Confidence"},"custom_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Name"},"custom_amount_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Custom Amount Cents"},"custom_frequency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Frequency"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"has_overrides":{"type":"boolean","title":"Has Overrides","default":false}},"type":"object","required":["counterparty_key","counterparty_display","avg_amount_cents","last_amount_cents","estimated_monthly_cents","frequency","occurrence_count","last_date","confidence"],"title":"DetectedSubscriptionResponse"},"ListSubscriptionsResponse":{"properties":{"subscriptions":{"items":{"$ref":"#/components/schemas/DetectedSubscriptionResponse"},"type":"array","title":"Subscriptions"},"total_monthly_cents":{"type":"integer","title":"Total Monthly Cents"},"period_total_cents":{"type":"integer","title":"Period Total Cents","description":"Sum of all detected recurring spend over the lookback period","default":0},"monthly_limit_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Monthly Limit Cents"},"over_limit":{"type":"boolean","title":"Over Limit","default":false},"subscription_count":{"type":"integer","title":"Subscription Count"},"lookback_days":{"type":"integer","title":"Lookback Days","default":180}},"additionalProperties":true,"type":"object","required":["subscriptions","total_monthly_cents","subscription_count"],"title":"ListSubscriptionsResponse","description":"List detected recurring transactions."},"SuccessEnvelope_ListSubscriptionsResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/ListSubscriptionsResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ListSubscriptionsResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}