List invoices

Retrieves an array of invoice objects.

lotus.list_invoices(
    customer_id="cus_1234567890",
)

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

Authorizations

Authorization[header]required

string

Token-based authentication with required prefix "Token"

Query Parameters

customer_id

string

A filter for invoices for a specific customer

payment_statusDefault: ["paid"]

array

A filter for invoices with a specific payment status

Response

array

amountrequired

number

cost_duerequired

number

currencyrequired

object

customerrequired

object

address

object

cityrequired

string

City, district, suburb, town, or village

countryrequired

string

Two-letter country code (ISO 3166-1 alpha-2)

AW - Aruba
AF - Afghanistan
AO - Angola
AI - Anguilla
AX - Åland Islands
AL - Albania
AD - Andorra
AE - United Arab Emirates
AR - Argentina
AM - Armenia
AS - American Samoa
AQ - Antarctica
TF - French Southern Territories
AG - Antigua and Barbuda
AU - Australia
AT - Austria
AZ - Azerbaijan
BI - Burundi
BE - Belgium
BJ - Benin
BQ - Bonaire, Sint Eustatius and Saba
BF - Burkina Faso
BD - Bangladesh
BG - Bulgaria
BH - Bahrain
BS - Bahamas
BA - Bosnia and Herzegovina
BL - Saint Barthélemy
BY - Belarus
BZ - Belize
BM - Bermuda
BO - Bolivia, Plurinational State of
BR - Brazil
BB - Barbados
BN - Brunei Darussalam
BT - Bhutan
BV - Bouvet Island
BW - Botswana
CF - Central African Republic
CA - Canada
CC - Cocos (Keeling) Islands
CH - Switzerland
CL - Chile
CN - China
CI - Côte d'Ivoire
CM - Cameroon
CD - Congo, The Democratic Republic of the
CG - Congo
CK - Cook Islands
CO - Colombia
KM - Comoros
CV - Cabo Verde
CR - Costa Rica
CU - Cuba
CW - Curaçao
CX - Christmas Island
KY - Cayman Islands
CY - Cyprus
CZ - Czechia
DE - Germany
DJ - Djibouti
DM - Dominica
DK - Denmark
DO - Dominican Republic
DZ - Algeria
EC - Ecuador
EG - Egypt
ER - Eritrea
EH - Western Sahara
ES - Spain
EE - Estonia
ET - Ethiopia
FI - Finland
FJ - Fiji
FK - Falkland Islands (Malvinas)
FR - France
FO - Faroe Islands
FM - Micronesia, Federated States of
GA - Gabon
GB - United Kingdom
GE - Georgia
GG - Guernsey
GH - Ghana
GI - Gibraltar
GN - Guinea
GP - Guadeloupe
GM - Gambia
GW - Guinea-Bissau
GQ - Equatorial Guinea
GR - Greece
GD - Grenada
GL - Greenland
GT - Guatemala
GF - French Guiana
GU - Guam
GY - Guyana
HK - Hong Kong
HM - Heard Island and McDonald Islands
HN - Honduras
HR - Croatia
HT - Haiti
HU - Hungary
ID - Indonesia
IM - Isle of Man
IN - India
IO - British Indian Ocean Territory
IE - Ireland
IR - Iran, Islamic Republic of
IQ - Iraq
IS - Iceland
IL - Israel
IT - Italy
JM - Jamaica
JE - Jersey
JO - Jordan
JP - Japan
KZ - Kazakhstan
KE - Kenya
KG - Kyrgyzstan
KH - Cambodia
KI - Kiribati
KN - Saint Kitts and Nevis
KR - Korea, Republic of
KW - Kuwait
LA - Lao People's Democratic Republic
LB - Lebanon
LR - Liberia
LY - Libya
LC - Saint Lucia
LI - Liechtenstein
LK - Sri Lanka
LS - Lesotho
LT - Lithuania
LU - Luxembourg
LV - Latvia
MO - Macao
MF - Saint Martin (French part)
MA - Morocco
MC - Monaco
MD - Moldova, Republic of
MG - Madagascar
MV - Maldives
MX - Mexico
MH - Marshall Islands
MK - North Macedonia
ML - Mali
MT - Malta
MM - Myanmar
ME - Montenegro
MN - Mongolia
MP - Northern Mariana Islands
MZ - Mozambique
MR - Mauritania
MS - Montserrat
MQ - Martinique
MU - Mauritius
MW - Malawi
MY - Malaysia
YT - Mayotte
NA - Namibia
NC - New Caledonia
NE - Niger
NF - Norfolk Island
NG - Nigeria
NI - Nicaragua
NU - Niue
NL - Netherlands
NO - Norway
NP - Nepal
NR - Nauru
NZ - New Zealand
OM - Oman
PK - Pakistan
PA - Panama
PN - Pitcairn
PE - Peru
PH - Philippines
PW - Palau
PG - Papua New Guinea
PL - Poland
PR - Puerto Rico
KP - Korea, Democratic People's Republic of
PT - Portugal
PY - Paraguay
PS - Palestine, State of
PF - French Polynesia
QA - Qatar
RE - Réunion
RO - Romania
RU - Russian Federation
RW - Rwanda
SA - Saudi Arabia
SD - Sudan
SN - Senegal
SG - Singapore
GS - South Georgia and the South Sandwich Islands
SH - Saint Helena, Ascension and Tristan da Cunha
SJ - Svalbard and Jan Mayen
SB - Solomon Islands
SL - Sierra Leone
SV - El Salvador
SM - San Marino
SO - Somalia
PM - Saint Pierre and Miquelon
RS - Serbia
SS - South Sudan
ST - Sao Tome and Principe
SR - Suriname
SK - Slovakia
SI - Slovenia
SE - Sweden
SZ - Eswatini
SX - Sint Maarten (Dutch part)
SC - Seychelles
SY - Syrian Arab Republic
TC - Turks and Caicos Islands
TD - Chad
TG - Togo
TH - Thailand
TJ - Tajikistan
TK - Tokelau
TM - Turkmenistan
TL - Timor-Leste
TO - Tonga
TT - Trinidad and Tobago
TN - Tunisia
TR - Turkey
TV - Tuvalu
TW - Taiwan, Province of China
TZ - Tanzania, United Republic of
UG - Uganda
UA - Ukraine
UM - United States Minor Outlying Islands
UY - Uruguay
US - United States
UZ - Uzbekistan
VA - Holy See (Vatican City State)
VC - Saint Vincent and the Grenadines
VE - Venezuela, Bolivarian Republic of
VG - Virgin Islands, British
VI - Virgin Islands, U.S.
VN - Viet Nam
VU - Vanuatu
WF - Wallis and Futuna
WS - Samoa
YE - Yemen
ZA - South Africa
ZM - Zambia
ZW - Zimbabwe

Available options:

AW,

AF,

AO,

AI,

AX,

AL,

AD,

AE,

AR,

AM,

AS,

AQ,

TF,

AG,

AU,

AT,

AZ,

BI,

BE,

BJ,

BQ,

BF,

BD,

BG,

BH,

BS,

BA,

BL,

BY,

BZ,

BM,

BO,

BR,

BB,

BN,

BT,

BV,

BW,

CF,

CA,

CC,

CH,

CL,

CN,

CI,

CM,

CD,

CG,

CK,

CO,

KM,

CV,

CR,

CU,

CW,

CX,

KY,

CY,

CZ,

DE,

DJ,

DM,

DK,

DO,

DZ,

EC,

EG,

ER,

EH,

ES,

EE,

ET,

FI,

FJ,

FK,

FR,

FO,

FM,

GA,

GB,

GE,

GG,

GH,

GI,

GN,

GP,

GM,

GW,

GQ,

GR,

GD,

GL,

GT,

GF,

GU,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IM,

IN,

IO,

IE,

IR,

IQ,

IS,

IL,

IT,

JM,

JE,

JO,

JP,

KZ,

KE,

KG,

KH,

KI,

KN,

KR,

KW,

LA,

LB,

LR,

LY,

LC,

LI,

LK,

LS,

LT,

LU,

LV,

MO,

MF,

MA,

MC,

MD,

MG,

MV,

MX,

MH,

MK,

ML,

MT,

MM,

ME,

MN,

MP,

MZ,

MR,

MS,

MQ,

MU,

MW,

MY,

YT,

NA,

NC,

NE,

NF,

NG,

NI,

NU,

NL,

NO,

NP,

NR,

NZ,

OM,

PK,

PA,

PN,

PE,

PH,

PW,

PG,

PL,

PR,

KP,

PT,

PY,

PS,

PF,

QA,

RE,

RO,

RU,

RW,

SA,

SD,

SN,

SG,

GS,

SH,

SJ,

SB,

SL,

SV,

SM,

SO,

PM,

RS,

SS,

ST,

SR,

SK,

SI,

SE,

SZ,

SX,

SC,

SY,

TC,

TD,

TG,

TH,

TJ,

TK,

TM,

TL,

TO,

TT,

TN,

TR,

TV,

TW,

TZ,

UG,

UA,

UM,

UY,

US,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

YE,

ZA,

ZM,

ZW

line1required

string

Address line 1 (e.g., street, PO Box, or company name)

line2

string

Address line 2 (e.g., apartment, suite, unit, or building)

postal_coderequired

string

ZIP or postal code

state

string

State, county, province, or region

customer_idrequired

string

The id provided when creating the customer, we suggest matching with your internal customer id in your backend

customer_namerequired

string

The display name of the customer

emailrequired

string

The primary email address of the customer, must be the same as the email address used to create the customer in the payment provider

due_daterequired

string

end_daterequired

string

external_payment_obj_idrequired

string

external_payment_obj_status

string

external_payment_obj_typerequired

string

stripe - Stripe
braintree - Braintree

Available options:

stripe,

braintree,

null

invoice_idrequired

string

invoice_numberrequired

string

invoice_pdfrequired

string

issue_daterequired

string

line_itemsrequired

array

payment_statusrequired

draft - draft
voided - voided
paid - paid
unpaid - unpaid

Available options:

draft,

voided,

paid,

unpaid

sellerrequired

object

address

object

cityrequired

string

City, district, suburb, town, or village

countryrequired

string

Two-letter country code (ISO 3166-1 alpha-2)

AW - Aruba
AF - Afghanistan
AO - Angola
AI - Anguilla
AX - Åland Islands
AL - Albania
AD - Andorra
AE - United Arab Emirates
AR - Argentina
AM - Armenia
AS - American Samoa
AQ - Antarctica
TF - French Southern Territories
AG - Antigua and Barbuda
AU - Australia
AT - Austria
AZ - Azerbaijan
BI - Burundi
BE - Belgium
BJ - Benin
BQ - Bonaire, Sint Eustatius and Saba
BF - Burkina Faso
BD - Bangladesh
BG - Bulgaria
BH - Bahrain
BS - Bahamas
BA - Bosnia and Herzegovina
BL - Saint Barthélemy
BY - Belarus
BZ - Belize
BM - Bermuda
BO - Bolivia, Plurinational State of
BR - Brazil
BB - Barbados
BN - Brunei Darussalam
BT - Bhutan
BV - Bouvet Island
BW - Botswana
CF - Central African Republic
CA - Canada
CC - Cocos (Keeling) Islands
CH - Switzerland
CL - Chile
CN - China
CI - Côte d'Ivoire
CM - Cameroon
CD - Congo, The Democratic Republic of the
CG - Congo
CK - Cook Islands
CO - Colombia
KM - Comoros
CV - Cabo Verde
CR - Costa Rica
CU - Cuba
CW - Curaçao
CX - Christmas Island
KY - Cayman Islands
CY - Cyprus
CZ - Czechia
DE - Germany
DJ - Djibouti
DM - Dominica
DK - Denmark
DO - Dominican Republic
DZ - Algeria
EC - Ecuador
EG - Egypt
ER - Eritrea
EH - Western Sahara
ES - Spain
EE - Estonia
ET - Ethiopia
FI - Finland
FJ - Fiji
FK - Falkland Islands (Malvinas)
FR - France
FO - Faroe Islands
FM - Micronesia, Federated States of
GA - Gabon
GB - United Kingdom
GE - Georgia
GG - Guernsey
GH - Ghana
GI - Gibraltar
GN - Guinea
GP - Guadeloupe
GM - Gambia
GW - Guinea-Bissau
GQ - Equatorial Guinea
GR - Greece
GD - Grenada
GL - Greenland
GT - Guatemala
GF - French Guiana
GU - Guam
GY - Guyana
HK - Hong Kong
HM - Heard Island and McDonald Islands
HN - Honduras
HR - Croatia
HT - Haiti
HU - Hungary
ID - Indonesia
IM - Isle of Man
IN - India
IO - British Indian Ocean Territory
IE - Ireland
IR - Iran, Islamic Republic of
IQ - Iraq
IS - Iceland
IL - Israel
IT - Italy
JM - Jamaica
JE - Jersey
JO - Jordan
JP - Japan
KZ - Kazakhstan
KE - Kenya
KG - Kyrgyzstan
KH - Cambodia
KI - Kiribati
KN - Saint Kitts and Nevis
KR - Korea, Republic of
KW - Kuwait
LA - Lao People's Democratic Republic
LB - Lebanon
LR - Liberia
LY - Libya
LC - Saint Lucia
LI - Liechtenstein
LK - Sri Lanka
LS - Lesotho
LT - Lithuania
LU - Luxembourg
LV - Latvia
MO - Macao
MF - Saint Martin (French part)
MA - Morocco
MC - Monaco
MD - Moldova, Republic of
MG - Madagascar
MV - Maldives
MX - Mexico
MH - Marshall Islands
MK - North Macedonia
ML - Mali
MT - Malta
MM - Myanmar
ME - Montenegro
MN - Mongolia
MP - Northern Mariana Islands
MZ - Mozambique
MR - Mauritania
MS - Montserrat
MQ - Martinique
MU - Mauritius
MW - Malawi
MY - Malaysia
YT - Mayotte
NA - Namibia
NC - New Caledonia
NE - Niger
NF - Norfolk Island
NG - Nigeria
NI - Nicaragua
NU - Niue
NL - Netherlands
NO - Norway
NP - Nepal
NR - Nauru
NZ - New Zealand
OM - Oman
PK - Pakistan
PA - Panama
PN - Pitcairn
PE - Peru
PH - Philippines
PW - Palau
PG - Papua New Guinea
PL - Poland
PR - Puerto Rico
KP - Korea, Democratic People's Republic of
PT - Portugal
PY - Paraguay
PS - Palestine, State of
PF - French Polynesia
QA - Qatar
RE - Réunion
RO - Romania
RU - Russian Federation
RW - Rwanda
SA - Saudi Arabia
SD - Sudan
SN - Senegal
SG - Singapore
GS - South Georgia and the South Sandwich Islands
SH - Saint Helena, Ascension and Tristan da Cunha
SJ - Svalbard and Jan Mayen
SB - Solomon Islands
SL - Sierra Leone
SV - El Salvador
SM - San Marino
SO - Somalia
PM - Saint Pierre and Miquelon
RS - Serbia
SS - South Sudan
ST - Sao Tome and Principe
SR - Suriname
SK - Slovakia
SI - Slovenia
SE - Sweden
SZ - Eswatini
SX - Sint Maarten (Dutch part)
SC - Seychelles
SY - Syrian Arab Republic
TC - Turks and Caicos Islands
TD - Chad
TG - Togo
TH - Thailand
TJ - Tajikistan
TK - Tokelau
TM - Turkmenistan
TL - Timor-Leste
TO - Tonga
TT - Trinidad and Tobago
TN - Tunisia
TR - Turkey
TV - Tuvalu
TW - Taiwan, Province of China
TZ - Tanzania, United Republic of
UG - Uganda
UA - Ukraine
UM - United States Minor Outlying Islands
UY - Uruguay
US - United States
UZ - Uzbekistan
VA - Holy See (Vatican City State)
VC - Saint Vincent and the Grenadines
VE - Venezuela, Bolivarian Republic of
VG - Virgin Islands, British
VI - Virgin Islands, U.S.
VN - Viet Nam
VU - Vanuatu
WF - Wallis and Futuna
WS - Samoa
YE - Yemen
ZA - South Africa
ZM - Zambia
ZW - Zimbabwe

Available options:

AW,

AF,

AO,

AI,

AX,

AL,

AD,

AE,

AR,

AM,

AS,

AQ,

TF,

AG,

AU,

AT,

AZ,

BI,

BE,

BJ,

BQ,

BF,

BD,

BG,

BH,

BS,

BA,

BL,

BY,

BZ,

BM,

BO,

BR,

BB,

BN,

BT,

BV,

BW,

CF,

CA,

CC,

CH,

CL,

CN,

CI,

CM,

CD,

CG,

CK,

CO,

KM,

CV,

CR,

CU,

CW,

CX,

KY,

CY,

CZ,

DE,

DJ,

DM,

DK,

DO,

DZ,

EC,

EG,

ER,

EH,

ES,

EE,

ET,

FI,

FJ,

FK,

FR,

FO,

FM,

GA,

GB,

GE,

GG,

GH,

GI,

GN,

GP,

GM,

GW,

GQ,

GR,

GD,

GL,

GT,

GF,

GU,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IM,

IN,

IO,

IE,

IR,

IQ,

IS,

IL,

IT,

JM,

JE,

JO,

JP,

KZ,

KE,

KG,

KH,

KI,

KN,

KR,

KW,

LA,

LB,

LR,

LY,

LC,

LI,

LK,

LS,

LT,

LU,

LV,

MO,

MF,

MA,

MC,

MD,

MG,

MV,

MX,

MH,

MK,

ML,

MT,

MM,

ME,

MN,

MP,

MZ,

MR,

MS,

MQ,

MU,

MW,

MY,

YT,

NA,

NC,

NE,

NF,

NG,

NI,

NU,

NL,

NO,

NP,

NR,

NZ,

OM,

PK,

PA,

PN,

PE,

PH,

PW,

PG,

PL,

PR,

KP,

PT,

PY,

PS,

PF,

QA,

RE,

RO,

RU,

RW,

SA,

SD,

SN,

SG,

GS,

SH,

SJ,

SB,

SL,

SV,

SM,

SO,

PM,

RS,

SS,

ST,

SR,

SK,

SI,

SE,

SZ,

SX,

SC,

SY,

TC,

TD,

TG,

TH,

TJ,

TK,

TM,

TL,

TO,

TT,

TN,

TR,

TV,

TW,

TZ,

UG,

UA,

UM,

UY,

US,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

YE,

ZA,

ZM,

ZW

line1required

string

Address line 1 (e.g., street, PO Box, or company name)

line2

string

Address line 2 (e.g., apartment, suite, unit, or building)

postal_coderequired

string

ZIP or postal code

state

string

State, county, province, or region

string

namerequired

string

phone

string

start_daterequired

string

API Reference

​Authorizations

​Query Parameters

​Response

Authorizations

Query Parameters

Response