> ## Documentation Index > Fetch the complete documentation index at: https://docs.flowapt.com/llms.txt > Use this file to discover all available pages before exploring further. # List Subscriptions > Every subscription in your store, newest first. Each item is a [subscription object](https://docs.flowapt.com/flowiq-api-reference/subscriptions.md#the-subscription-object). ## Basic Usage ```bash theme={null} curl "https://api.flowiq.live/v1/subscriptions?status=active&limit=50" \ -H "Authorization: Bearer fiq_YOUR_API_KEY" ``` *** ## Query Parameters | Parameter | Type | Required | Description | | - | - | - | - | | `status` | string | No | `active`, `paused` or `cancelled`. Leave out for all | | `test` | string | No | `include` (default), `exclude` (real subscriptions only) or `only` (test subscriptions only) | | `updated_since` | string | No | ISO date or timestamp; only subscriptions whose record changed since then (use it to sync incrementally) | | `email` | string | No | The customer's email address | | `shopify_customer_id` | string | No | The customer's Shopify customer id | | `contact_id` | string | No | The customer's FlowIQ contact id | | `page` | integer | No | Page number, default `1` | | `limit` | integer | No | Per page, default `50`, max `100` | *** ## Response ### Success (200) ```json theme={null} { "organization_id": "a4234f32-…", "data": [ { "id": "3f2c6a1e-8b0d-4c55-9f7e-1d2a3b4c5d6e", "status": "active", "customer": { "name": "Jane Doe", "email": "jane@example.com", "phone": "27820000000", "shopify_customer_id": "7712345678901", "contact_id": "9b8a7c6d-…" }, "rhythm": { "label": "every 6 weeks", "interval_value": 6, "interval_unit": "weeks" }, "items": [{ "variant_id": "44112233445566", "sku": "LL-MWL-15", "title": "Men's Weight Loss 15 pack", "quantity": 1, "unit_price": "1650.00" }], "next_delivery": { "delivery_number": 2, "date": "2026-12-07", "scheduled_for": "2026-12-07T08:00:02+00:00", "estimated_total": "1784.00" } } ], "pagination": { "page": 1, "limit": 50, "total": 1, "has_more": false } } ``` The example shows a few fields; every item carries the full [subscription object](https://docs.flowapt.com/flowiq-api-reference/subscriptions.md#the-subscription-object). *** ## Integration Example ```javascript theme={null} async function allActiveSubscriptions(apiKey) { const out = []; for (let page = 1; ; page++) { const url = new URL("https://api.flowiq.live/v1/subscriptions"); url.searchParams.set("status", "active"); url.searchParams.set("limit", "100"); url.searchParams.set("page", String(page)); const res = await fetch(url, { headers: { Authorization: `Bearer ${apiKey}` } }); const body = await res.json(); if (!res.ok) throw new Error(body.message); out.push(...body.data); if (!body.pagination.has_more) return out; } } ``` ## OpenAPI ````yaml flowiq-api-reference/openapi-subscriptions.json GET /v1/subscriptions openapi: 3.1.0 info: title: FlowIQ Subscriptions API version: 1.0.0 description: >- Read-only access to a store's FlowIQ subscriptions, their delivery schedule and upcoming deliveries. servers: - url: https://api.flowiq.live description: FlowIQ Production API security: - BearerAuth: [] tags: - name: Subscriptions paths: /v1/subscriptions: get: tags: - Subscriptions summary: List Subscriptions description: Every subscription in your store, newest first. operationId: listSubscriptions parameters: - name: status in: query required: false description: active, paused or cancelled. Leave out for all schema: type: string enum: - active - paused - cancelled example: active - name: test in: query required: false description: >- include (default), exclude (real subscriptions only) or only (test subscriptions only) schema: type: string enum: - include - exclude - only default: include - name: updated_since in: query required: false description: >- Only subscriptions whose record changed since this ISO date or timestamp schema: type: string - name: email in: query required: false description: The customer's email address schema: type: string - name: shopify_customer_id in: query required: false description: The customer's Shopify customer id schema: type: string - name: contact_id in: query required: false description: The customer's FlowIQ contact id schema: type: string format: uuid - name: page in: query required: false description: Page number schema: type: integer default: 1 minimum: 1 - name: limit in: query required: false description: Per page (max 100) schema: type: integer default: 50 minimum: 1 maximum: 100 responses: '200': description: Subscriptions content: application/json: schema: type: object properties: organization_id: type: string format: uuid example: a4234f32-19d5-4f09-92fe-55f00f94bea8 data: type: array items: type: object properties: test: type: boolean example: false description: >- true for a test subscription (never charged, no Shopify orders) id: type: string format: uuid example: 3f2c6a1e-8b0d-4c55-9f7e-1d2a3b4c5d6e status: type: string enum: - active - paused - cancelled example: active created_at: type: string format: date-time nullable: true example: '2026-10-26T08:00:01+00:00' updated_at: type: string format: date-time nullable: true example: '2026-10-26T08:00:05+00:00' customer: type: object properties: contact_id: type: string format: uuid nullable: true example: 9b8a7c6d-1e2f-4a3b-8c9d-0e1f2a3b4c5d name: type: string nullable: true example: Jane Doe email: type: string nullable: true example: jane@example.com phone: type: string nullable: true example: '27820000000' shopify_customer_id: type: string nullable: true example: '7712345678901' rhythm: type: object properties: label: type: string nullable: true example: every 6 weeks interval_value: type: integer example: 6 interval_unit: type: string enum: - days - weeks - months example: weeks items: type: array items: type: object properties: variant_id: type: string example: '44112233445566' sku: type: string nullable: true example: LL-MWL-15 title: type: string nullable: true example: Men's Weight Loss 15 pack quantity: type: integer example: 1 unit_price: type: string nullable: true description: Rand amount as a decimal string example: '1650.00' recurring_amount: type: string nullable: true description: Rand amount as a decimal string example: '1650.00' currency: type: string example: ZAR discount_ladder: type: object nullable: true properties: steps: type: array items: type: object properties: from_delivery: type: integer example: 1 percent: type: number example: 7.5 next_delivery_percent: type: number nullable: true example: 10 delivery_fee: type: object nullable: true properties: amount: type: string nullable: true description: Rand amount as a decimal string example: '299.00' free_over: type: string nullable: true description: Rand amount as a decimal string example: null shipping_address: type: object nullable: true description: Shopify address object example: first_name: Jane last_name: Doe address1: 1 Main Road city: Gqeberha province: Eastern Cape zip: '6001' country: South Africa phone: '+27820000000' next_delivery: type: object nullable: true properties: delivery_number: type: integer example: 2 date: type: string format: date example: '2026-12-07' scheduled_for: type: string format: date-time example: '2026-12-07T08:00:02+00:00' estimated_total: type: string nullable: true description: Rand amount as a decimal string example: '1784.00' deliveries: type: object properties: completed: type: integer example: 1 scheduled: type: integer example: 11 skipped: type: integer example: 0 paused: type: integer example: 0 failed: type: integer example: 0 paused_at: type: string nullable: true example: null resume_at: type: string nullable: true example: null cancelled_at: type: string nullable: true example: null cancel_reason: type: string nullable: true example: null card_on_file: type: string nullable: true example: CONSENTED pagination: type: object properties: page: type: integer example: 1 limit: type: integer example: 50 total: type: integer example: 1 has_more: type: boolean example: false '400': description: Invalid status content: application/json: schema: type: object properties: error: type: string example: Invalid status message: type: string example: status must be active, paused or cancelled '401': description: Unauthorized content: application/json: schema: type: object properties: error: type: string example: Unauthorized message: type: string example: Invalid API key '403': description: Forbidden content: application/json: schema: type: object properties: error: type: string example: Forbidden message: type: string example: This connection does not have "read" permission '429': description: Rate limited content: application/json: schema: type: object properties: error: type: string example: Rate limited message: type: string example: 240 requests per minute per key. components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: fiq_ API key description: >- Your FlowIQ organisation API key (Settings → API Keys), sent as a bearer token. Format: `Bearer fiq_YOUR_API_KEY` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.