GET
/
api
/
invoices
/
Authorization
Query
curl --request GET \
  --url https://api.uselotus.io/api/invoices/ \
  --header 'Authorization: <authorization>'
[
  {
    "amount": 123,
    "cost_due": 123,
    "currency": {
      "code": "<string>",
      "name": "<string>",
      "symbol": "<string>"
    },
    "customer": {
      "address": {
        "city": "<string>",
        "country": "AW",
        "line1": "<string>",
        "postal_code": "<string>"
      },
      "customer_id": "<string>",
      "customer_name": "<string>",
      "email": "jsmith@example.com"
    },
    "due_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-12-25",
    "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": "2023-11-07T05:31:56Z",
    "line_items": [
      {
        "adjustments": [],
        "amount": 123,
        "base": 123,
        "billing_type": "in_arrears",
        "end_date": "2023-11-07T05:31:56Z",
        "metadata": {},
        "name": "<string>",
        "plan": {
          "plan_id": "<string>",
          "plan_name": "<string>",
          "version": 123,
          "version_id": "<string>"
        },
        "quantity": 123,
        "start_date": "2023-11-07T05:31:56Z",
        "subscription_filters": [],
        "subtotal": 123
      }
    ],
    "payment_status": "draft",
    "seller": {
      "address": {
        "city": "<string>",
        "country": "AW",
        "line1": "<string>",
        "postal_code": "<string>"
      },
      "email": "jsmith@example.com",
      "name": "<string>",
      "phone": "<string>"
    },
    "start_date": "2023-12-25"
  }
]

Retrieves an array of invoice objects.

lotus.list_invoices(
    customer_id="cus_1234567890",
)

lotus.list_invoices(
    status=["unpaid"],
)

Authorizations

Authorization
string
headerrequired

Token-based authentication with required prefix "Token"

Query Parameters

customer_id
string | null

A filter for invoices for a specific customer

payment_status
enum<string>[]

A filter for invoices with a specific payment status

Available options:
unpaid,
paid

Response

200 - application/json
amount
number
required
cost_due
number
required
currency
object
required
customer
object
required
due_date
string | null
required
end_date
string
required
external_payment_obj_id
string | null
required
external_payment_obj_status
string | null
external_payment_obj_type
enum<string> | null
required
  • stripe - Stripe
  • braintree - Braintree
Available options:
stripe,
braintree,
invoice_id
string
required
invoice_number
string
required
invoice_pdf
string | null
required
issue_date
string
required
line_items
object[]
required
payment_status
enum<string>
required
  • draft - draft
  • voided - voided
  • paid - paid
  • unpaid - unpaid
Available options:
draft,
voided,
paid,
unpaid
seller
object
required
start_date
string
required
Get PlanGet invoice