> ## 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. # Upcoming Deliveries > Every subscription delivery scheduled in a date range, earliest first, with customer, shipping address, items and estimated amount. Use it to plan picking, packing and dispatch ahead of the charge. ## Basic Usage ```bash theme={null} curl "https://api.flowiq.live/v1/subscriptions/upcoming?from=2026-11-02&to=2026-11-08" \ -H "Authorization: Bearer fiq_YOUR_API_KEY" ``` *** ## Query Parameters | Parameter | Type | Required | Description | | - | - | - | - | | `from` | string | No | First day, `YYYY-MM-DD` (South African date). Default today | | `to` | string | No | Last day, inclusive. Default 14 days after `from`. At most 62 days per request | | `include` | string | No | `scheduled` (default): deliveries that will be charged. `all`: also paused and skipped ones | | `page` | integer | No | Page number, default `1` | | `limit` | integer | No | Per page, default `100`, max `500` | *** ## Response ### Success (200) Each item is a [delivery object](https://docs.flowapt.com/flowiq-api-reference/subscriptions.md#the-delivery-object) plus the subscription's `customer`, `rhythm` and `subscription_status`. ```json theme={null} { "organization_id": "a4234f32-…", "from": "2026-11-02", "to": "2026-11-08", "data": [ { "subscription_id": "3f2c6a1e-8b0d-4c55-9f7e-1d2a3b4c5d6e", "delivery_number": 4, "date": "2026-11-03", "scheduled_for": "2026-11-03T08:00:02+00:00", "status": "scheduled", "customer": { "name": "Jane Doe", "email": "jane@example.com", "phone": "27820000000", "shopify_customer_id": "7712345678901", "contact_id": "9b8a7c6d-…" }, "shipping_address": { "first_name": "Jane", "last_name": "Doe", "address1": "1 Main Road", "city": "Gqeberha", "province": "Eastern Cape", "zip": "6001", "country": "South Africa", "phone": "+27820000000" }, "items": [{ "variant_id": "44112233445566", "sku": "LL-MWL-15", "title": "Men's Weight Loss 15 pack", "quantity": 1, "unit_price": "1650.00" }], "rhythm": { "label": "every 6 weeks", "interval_value": 6, "interval_unit": "weeks" }, "subscription_status": "active", "estimate": { "goods": "1402.50", "discount_percent": 15, "discount": "247.50", "delivery_fee": "299.00", "total": "1701.50" }, "shopify_order_id": null, "charged_amount": null } ], "pagination": { "page": 1, "limit": 100, "total": 1, "has_more": false } } ``` > [!NOTE] > > A delivery is charged and its Shopify order created on its date. Until then the items, address and date can still change (the customer can skip, pause or edit), so read this list close to when you plan, and take the Shopify order as final. *** ## Integration Example ```javascript theme={null} async function deliveriesNextWeek(apiKey) { const day = (d) => d.toISOString().slice(0, 10); const from = new Date(); const to = new Date(Date.now() + 7 * 86400000); const url = new URL("https://api.flowiq.live/v1/subscriptions/upcoming"); url.searchParams.set("from", day(from)); url.searchParams.set("to", day(to)); url.searchParams.set("limit", "500"); const res = await fetch(url, { headers: { Authorization: `Bearer ${apiKey}` } }); const body = await res.json(); if (!res.ok) throw new Error(body.message); return body.data; } ``` ## OpenAPI ````yaml flowiq-api-reference/openapi-subscriptions.json GET /v1/subscriptions/upcoming 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/upcoming: get: tags: - Subscriptions summary: Upcoming Deliveries description: >- Every subscription delivery scheduled in a date range, earliest first, with customer, shipping address, items and estimated amount. operationId: listUpcomingDeliveries parameters: - name: from in: query required: false description: First day, YYYY-MM-DD (South African date). Default today schema: type: string format: date example: '2026-11-02' - name: to in: query required: false description: >- Last day, inclusive. Default 14 days after from; at most 62 days per request schema: type: string format: date example: '2026-11-08' - name: include in: query required: false description: >- scheduled (default) = deliveries that will be charged; all = also paused and skipped schema: type: string enum: - scheduled - all default: scheduled - 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 500) schema: type: integer default: 100 minimum: 1 maximum: 500 responses: '200': description: Upcoming deliveries content: application/json: schema: type: object properties: organization_id: type: string format: uuid example: a4234f32-19d5-4f09-92fe-55f00f94bea8 from: type: string format: date example: '2026-11-02' to: type: string format: date example: '2026-11-08' data: type: array items: type: object properties: test: type: boolean example: false description: >- true for a test subscription (never charged, no Shopify orders) subscription_id: type: string format: uuid example: 3f2c6a1e-8b0d-4c55-9f7e-1d2a3b4c5d6e delivery_number: type: integer nullable: true example: 2 description: 1 = the first delivery date: type: string format: date nullable: true example: '2026-12-07' description: South African date scheduled_for: type: string format: date-time nullable: true example: '2026-12-07T08:00:02+00:00' status: type: string enum: - scheduled - paused - skipped - pending - processing - completed - failed - cancelled example: scheduled 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' 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' shopify_order_id: type: string nullable: true example: null shopify_order_name: type: string nullable: true example: null charged_amount: type: string nullable: true description: Rand amount as a decimal string example: null estimate: type: object nullable: true description: >- For deliveries still to come: what it would cost if charged today properties: goods: type: string nullable: true description: Rand amount as a decimal string example: '1485.00' discount_percent: type: number nullable: true example: 10 discount: type: string nullable: true description: Rand amount as a decimal string example: '165.00' delivery_fee: type: string nullable: true description: Rand amount as a decimal string example: '299.00' total: type: string nullable: true description: Rand amount as a decimal string example: '1784.00' failure_reason: type: string nullable: true example: null 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 subscription_status: type: string enum: - active - paused - cancelled example: active 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: Range too long content: application/json: schema: type: object properties: error: type: string example: Range too long message: type: string example: At most 62 days per request; page through longer periods '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.