Invoices
List invoices
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
headerrequiredToken-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
requiredcost_due
number
requiredcurrency
object
requiredcustomer
object
requireddue_date
string | null
requiredend_date
string
requiredexternal_payment_obj_id
string | null
requiredexternal_payment_obj_status
string | null
external_payment_obj_type
enum<string> | null
requiredstripe
- Stripebraintree
- Braintree
Available options:
stripe
, braintree
,
invoice_id
string
requiredinvoice_number
string
requiredinvoice_pdf
string | null
requiredissue_date
string
requiredline_items
object[]
requiredpayment_status
enum<string>
requireddraft
- draftvoided
- voidedpaid
- paidunpaid
- unpaid
Available options:
draft
, voided
, paid
, unpaid
seller
object
requiredstart_date
string
requiredcurl --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"
}
]