---
title: "GET /app/draft_invoice/"
method: GET
path: "/app/draft_invoice/"
tags: ["app"]
---

# GET /app/draft_invoice/

`GET /app/draft_invoice/`

Pagination-enabled endpoint for retrieving an organization's event stream.

## Query parameters

- `customer_id` string, required
- `include_next_period` boolean

## Response `200`

- DraftInvoiceResponse
  - `invoice` DraftInvoice[]
    - `end_date` string, date, required
    - `issue_date` string, date-time, required
    - `start_date` string, date, required
    - `cost_due` number, double, required
    - `line_items` GroupedLineItem[], required
      - `plan_name` string, required
      - `subscription_filters` SubscriptionCategoricalFilter[], required
        - `value` string, required
        - `property_name` string, required — The string name of the property to filter on. Example: 'product_id'
      - `subtotal` number, double, required
      - `start_date` string, date-time, required
      - `end_date` string, date-time, required
      - `sub_items` LightweightInvoiceLineItem[], required
        - `end_date` string, date-time, required
        - `subtotal` number, double, required
        - `subscription_filters` SubscriptionCategoricalFilter[], required
          - `value` string, required
          - `property_name` string, required — The string name of the property to filter on. Example: 'product_id'
        - `start_date` string, date-time, required
        - `billing_type` 'in_arrears' | 'in_advance' | 'null', nullable, required
        - `quantity` number, double, nullable, required
        - `name` string, required
        - `plan` string, required
    - `currency` PricingUnit, required
      - `code` string, required
      - `name` string, required
      - `symbol` string, required
    - `due_date` string, date-time, nullable, required

## Changes

- **2023-01-16** `36b48cae00a3` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/uselotus/apis/lotus-api/changes/app/draft_invoice/get.md)

---

[API](https://skmtc.dev/uselotus/apis/lotus-api.md) · [All operations](https://skmtc.dev/uselotus/apis/lotus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uselotus/lotus-api/revisions/36b48cae00a3/schema)