---
title: "GET /api/customers/"
method: GET
path: "/api/customers/"
tags: ["api"]
---

# GET /api/customers/

`GET /api/customers/`

## Response `200`

- Customer[]
  - `customer_id` string, required
  - `email` string, email, required
  - `customer_name` string, required
  - `invoices` LightweightInvoice[], required
    - `external_payment_obj_type` 'stripe' | 'null', nullable, required
    - `invoice_pdf` string, uri, nullable, required
    - `payment_status` 'draft' | 'voided' | 'paid' | 'unpaid', required
    - `end_date` string, date, required
    - `cost_due` number, double, required
    - `issue_date` string, date-time, required
    - `invoice_id` string, required
    - `external_payment_obj_id` string, nullable, required
    - `invoice_number` string, required
    - `currency` PricingUnit, required
      - `code` string, required
      - `name` string, required
      - `symbol` string, required
    - `start_date` string, date, required
    - `due_date` string, date-time, nullable, required
    - `seller` Seller, required
      - `name` string, required
      - `address` Address
        - `city` string, required — City, district, suburb, town, or village
        - `country` string, required — ISO 3166-1 alpha-2 country code
        - `line1` string, required — Address line 1 (e.g., street, PO Box, or company name)
        - `line2` string, nullable — Address line 2 (e.g., apartment, suite, unit, or building)
        - `postal_code` string, required — ZIP or postal code
        - `state` string, required — State, county, province, or region
      - `phone` string, nullable
      - `email` string, email, nullable
  - `total_amount_due` number, double, required
  - `subscriptions` SubscriptionRecord[], required
    - `start_date` string, date-time, required — The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.
    - `end_date` string, date-time, required — The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.
    - `auto_renew` boolean, required — Whether the subscription automatically renews. Defaults to true.
    - `is_new` boolean, required — Whether this subscription came from a renewal or from a first-time. Defaults to true on creation.
    - `subscription_filters` SubscriptionCategoricalFilter[], required
      - `value` string, required
      - `property_name` string, required — The string name of the property to filter on. Example: 'product_id'
    - `customer` LightweightCustomer, required
      - `customer_name` string, nullable, required — The display name of the customer
      - `email` string, email, nullable, required — The primary email address of the customer, must be the same as the email address used to create the customer in the payment provider
      - `customer_id` string, required — The id provided when creating the customer, we suggest matching with your internal customer id in your backend
    - `billing_plan` LightweightPlanVersion, required
      - `plan_name` string, required
      - `plan_id` string, required
      - `version` integer, required
      - `version_id` string, required
    - `fully_billed` boolean, required — Whether the subscription has been fully billed and finalized.
    - `addons` LightweightAddonSubscriptionRecord[], required
      - `start_date` string, date-time, required — The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.
      - `end_date` string, date-time, required — The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.
      - `addon` LightweightAddon, required
        - `addon_name` string, required — The name of the add-on plan.
        - `addon_id` string, required — The ID of the add-on plan.
        - `addon_type` 'flat' | 'usage_based', required
        - `billing_frequency` 'one_time' | 'recurring', required
      - `fully_billed` boolean, required — Whether the subscription has been fully billed and finalized.
  - `integrations` CustomerIntegrations, required
    - `stripe` CustomerStripeIntegration
      - `stripe_id` string, required
      - `has_payment_method` boolean, required
  - `default_currency` PricingUnit, required
    - `code` string, required
    - `name` string, required
    - `symbol` string, required
  - `payment_provider` 'stripe' | 'null', nullable, required
  - `has_payment_method` boolean, required
  - `address` Address
    - `city` string, required — City, district, suburb, town, or village
    - `country` string, required — ISO 3166-1 alpha-2 country code
    - `line1` string, required — Address line 1 (e.g., street, PO Box, or company name)
    - `line2` string, nullable — Address line 2 (e.g., apartment, suite, unit, or building)
    - `postal_code` string, required — ZIP or postal code
    - `state` string, required — State, county, province, or region
  - `tax_rate` number, double, nullable, required — Tax rate as percentage. For example, 10.5 for 10.5%

## Changes

- **2023-02-03** `fe43d7855824` — 2 breaking, 2 warning
  - the `items/invoices/items/payment_status` response's property type changed from `string` to no type for status `200`
  - the `items/subscriptions/items/addons/items/addon/billing_frequency` response's property type changed from `string` to no type for status `200`
  - added the new `draft` enum value to the `items/invoices/items/payment_status` response property for the response status `200`
  - added the new `voided` enum value to the `items/invoices/items/payment_status` response property for the response status `200`
- **2023-01-25** `77053ad08590` — 1 info
  - added the required property `items/subscriptions/items/addons` to the response with the `200` status
- **2023-01-23** `718df5d01ac4` — 1 info
  - added the required property `items/invoices/items/invoice_pdf` to the response with the `200` status
- **2023-01-22** `4c3ade147167` — 1 info
  - added the required property `items/subscriptions/items/billing_plan/version_id` to the response with the `200` status
- …earlier changes not shown

[Full history](https://skmtc.dev/uselotus/apis/lotus-api/changes/api/customers/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/fe43d7855824/schema)