GET

/api/customers/

X-API-KEY*
curl --request GET \
  --url https://api.uselotus.io/api/customers/ \
  --header 'Authorization: <authorization>' \
  --header 'X-API-KEY: <x-api-key>'
[
  {
    "address": {
      "city": "string",
      "country": "AW",
      "line1": "string",
      "line2": "string",
      "postal_code": "string",
      "state": "string"
    },
    "billing_address": {
      "city": "string",
      "country": "AW",
      "line1": "string",
      "line2": "string",
      "postal_code": "string",
      "state": "string"
    },
    "customer_id": "string",
    "customer_name": "string",
    "default_currency": {
      "code": "string",
      "name": "string",
      "symbol": "string"
    },
    "email": "string",
    "has_payment_method": "boolean",
    "integrations": {
      "braintree": {
        "braintree_id": "string",
        "has_payment_method": "boolean"
      },
      "stripe": {
        "has_payment_method": "boolean",
        "stripe_id": "string"
      }
    },
    "invoices": [
      {
        "amount": "number",
        "cost_due": "number",
        "currency": {
          "code": "string",
          "name": "string",
          "symbol": "string"
        },
        "due_date": "string",
        "end_date": "string",
        "external_payment_obj_id": "string",
        "external_payment_obj_status": "string",
        "external_payment_obj_type": "stripe",
        "invoice_id": "string",
        "invoice_number": "string",
        "invoice_pdf": "string",
        "issue_date": "string",
        "payment_status": "draft",
        "seller": {
          "address": {
            "city": "string",
            "country": "AW",
            "line1": "string",
            "line2": "string",
            "postal_code": "string",
            "state": "string"
          },
          "email": "string",
          "name": "string",
          "phone": "string"
        },
        "start_date": "string"
      }
    ],
    "payment_provider": "stripe",
    "payment_provider_id": "string",
    "shipping_address": {
      "city": "string",
      "country": "AW",
      "line1": "string",
      "line2": "string",
      "postal_code": "string",
      "state": "string"
    },
    "subscriptions": [
      {
        "addons": [
          {
            "addon": {
              "addon_id": "string",
              "addon_name": "string",
              "addon_type": "flat",
              "billing_frequency": "one_time"
            },
            "addon_subscription_id": "string",
            "end_date": "string",
            "fully_billed": "boolean",
            "start_date": "string"
          }
        ],
        "auto_renew": "boolean",
        "billing_plan": {
          "plan_id": "string",
          "plan_name": "string",
          "version_id": "string"
        },
        "customer": {
          "customer_id": "string",
          "customer_name": "string",
          "email": "string"
        },
        "end_date": "string",
        "fully_billed": "boolean",
        "is_new": "boolean",
        "metadata": "object",
        "start_date": "string",
        "subscription_filters": [
          {
            "property_name": "string",
            "value": "string"
          }
        ],
        "subscription_id": "string"
      }
    ],
    "tax_providers": [
      "taxjar"
    ],
    "tax_rate": "number",
    "timezone": "Africa/Abidjan",
    "total_amount_due": "number"
  }
]

Retrieves an array of customer objects.

lotus.list_customers()

Authorizations

Authorizationheaderrequired
string

Token-based authentication with required prefix "Token"

Response

array