Get Invoice PDF
/api/invoices/{invoice_id}/pdf_url/
curl --request GET \
--url https://api.uselotus.io/api/invoices/{invoice_id}/pdf_url/ \
--header 'Authorization: <authorization>' \
--header 'X-API-KEY: <x-api-key>'
Retrieves a link to an invoice’s pdf, generated by Lotus.
Authorizations
Token-based authentication with required prefix "Token"
Path Parameters
Either an invoice ID (in the format invoice_<uuid>
) or an invoice number (in the format YYMMDD-000001
)
Response
City, district, suburb, town, or village
Two-letter country code (ISO 3166-1 alpha-2)
AW
- ArubaAF
- AfghanistanAO
- AngolaAI
- AnguillaAX
- Åland IslandsAL
- AlbaniaAD
- AndorraAE
- United Arab EmiratesAR
- ArgentinaAM
- ArmeniaAS
- American SamoaAQ
- AntarcticaTF
- French Southern TerritoriesAG
- Antigua and BarbudaAU
- AustraliaAT
- AustriaAZ
- AzerbaijanBI
- BurundiBE
- BelgiumBJ
- BeninBQ
- Bonaire, Sint Eustatius and SabaBF
- Burkina FasoBD
- BangladeshBG
- BulgariaBH
- BahrainBS
- BahamasBA
- Bosnia and HerzegovinaBL
- Saint BarthélemyBY
- BelarusBZ
- BelizeBM
- BermudaBO
- Bolivia, Plurinational State ofBR
- BrazilBB
- BarbadosBN
- Brunei DarussalamBT
- BhutanBV
- Bouvet IslandBW
- BotswanaCF
- Central African RepublicCA
- CanadaCC
- Cocos (Keeling) IslandsCH
- SwitzerlandCL
- ChileCN
- ChinaCI
- Côte d'IvoireCM
- CameroonCD
- Congo, The Democratic Republic of theCG
- CongoCK
- Cook IslandsCO
- ColombiaKM
- ComorosCV
- Cabo VerdeCR
- Costa RicaCU
- CubaCW
- CuraçaoCX
- Christmas IslandKY
- Cayman IslandsCY
- CyprusCZ
- CzechiaDE
- GermanyDJ
- DjiboutiDM
- DominicaDK
- DenmarkDO
- Dominican RepublicDZ
- AlgeriaEC
- EcuadorEG
- EgyptER
- EritreaEH
- Western SaharaES
- SpainEE
- EstoniaET
- EthiopiaFI
- FinlandFJ
- FijiFK
- Falkland Islands (Malvinas)FR
- FranceFO
- Faroe IslandsFM
- Micronesia, Federated States ofGA
- GabonGB
- United KingdomGE
- GeorgiaGG
- GuernseyGH
- GhanaGI
- GibraltarGN
- GuineaGP
- GuadeloupeGM
- GambiaGW
- Guinea-BissauGQ
- Equatorial GuineaGR
- GreeceGD
- GrenadaGL
- GreenlandGT
- GuatemalaGF
- French GuianaGU
- GuamGY
- GuyanaHK
- Hong KongHM
- Heard Island and McDonald IslandsHN
- HondurasHR
- CroatiaHT
- HaitiHU
- HungaryID
- IndonesiaIM
- Isle of ManIN
- IndiaIO
- British Indian Ocean TerritoryIE
- IrelandIR
- Iran, Islamic Republic ofIQ
- IraqIS
- IcelandIL
- IsraelIT
- ItalyJM
- JamaicaJE
- JerseyJO
- JordanJP
- JapanKZ
- KazakhstanKE
- KenyaKG
- KyrgyzstanKH
- CambodiaKI
- KiribatiKN
- Saint Kitts and NevisKR
- Korea, Republic ofKW
- KuwaitLA
- Lao People's Democratic RepublicLB
- LebanonLR
- LiberiaLY
- LibyaLC
- Saint LuciaLI
- LiechtensteinLK
- Sri LankaLS
- LesothoLT
- LithuaniaLU
- LuxembourgLV
- LatviaMO
- MacaoMF
- Saint Martin (French part)MA
- MoroccoMC
- MonacoMD
- Moldova, Republic ofMG
- MadagascarMV
- MaldivesMX
- MexicoMH
- Marshall IslandsMK
- North MacedoniaML
- MaliMT
- MaltaMM
- MyanmarME
- MontenegroMN
- MongoliaMP
- Northern Mariana IslandsMZ
- MozambiqueMR
- MauritaniaMS
- MontserratMQ
- MartiniqueMU
- MauritiusMW
- MalawiMY
- MalaysiaYT
- MayotteNA
- NamibiaNC
- New CaledoniaNE
- NigerNF
- Norfolk IslandNG
- NigeriaNI
- NicaraguaNU
- NiueNL
- NetherlandsNO
- NorwayNP
- NepalNR
- NauruNZ
- New ZealandOM
- OmanPK
- PakistanPA
- PanamaPN
- PitcairnPE
- PeruPH
- PhilippinesPW
- PalauPG
- Papua New GuineaPL
- PolandPR
- Puerto RicoKP
- Korea, Democratic People's Republic ofPT
- PortugalPY
- ParaguayPS
- Palestine, State ofPF
- French PolynesiaQA
- QatarRE
- RéunionRO
- RomaniaRU
- Russian FederationRW
- RwandaSA
- Saudi ArabiaSD
- SudanSN
- SenegalSG
- SingaporeGS
- South Georgia and the South Sandwich IslandsSH
- Saint Helena, Ascension and Tristan da CunhaSJ
- Svalbard and Jan MayenSB
- Solomon IslandsSL
- Sierra LeoneSV
- El SalvadorSM
- San MarinoSO
- SomaliaPM
- Saint Pierre and MiquelonRS
- SerbiaSS
- South SudanST
- Sao Tome and PrincipeSR
- SurinameSK
- SlovakiaSI
- SloveniaSE
- SwedenSZ
- EswatiniSX
- Sint Maarten (Dutch part)SC
- SeychellesSY
- Syrian Arab RepublicTC
- Turks and Caicos IslandsTD
- ChadTG
- TogoTH
- ThailandTJ
- TajikistanTK
- TokelauTM
- TurkmenistanTL
- Timor-LesteTO
- TongaTT
- Trinidad and TobagoTN
- TunisiaTR
- TurkeyTV
- TuvaluTW
- Taiwan, Province of ChinaTZ
- Tanzania, United Republic ofUG
- UgandaUA
- UkraineUM
- United States Minor Outlying IslandsUY
- UruguayUS
- United StatesUZ
- UzbekistanVA
- Holy See (Vatican City State)VC
- Saint Vincent and the GrenadinesVE
- Venezuela, Bolivarian Republic ofVG
- Virgin Islands, BritishVI
- Virgin Islands, U.S.VN
- Viet NamVU
- VanuatuWF
- Wallis and FutunaWS
- SamoaYE
- YemenZA
- South AfricaZM
- ZambiaZW
- Zimbabwe
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
Address line 1 (e.g., street, PO Box, or company name)
Address line 2 (e.g., apartment, suite, unit, or building)
ZIP or postal code
State, county, province, or region
The id provided when creating the customer, we suggest matching with your internal customer id in your backend
The display name of the customer
The primary email address of the customer, must be the same as the email address used to create the customer in the payment provider
stripe
- Stripebraintree
- Braintree
stripe
, braintree
, null
sales_tax
- sales_taxplan_adjustment
- plan_adjustment
sales_tax
, plan_adjustment
Amount of the line item. This is the price after any adjustments are applied.
Base price of the line item. This is the price before any adjustments are applied.
in_arrears
- In Arrearsintermediate
- Intermediatein_advance
- In Advanceone_time
- One Time
in_arrears
, intermediate
, in_advance
, one_time
, null
The string name of the property to filter on. Example: 'product_id'
draft
- draftvoided
- voidedpaid
- paidunpaid
- unpaid
draft
, voided
, paid
, unpaid
City, district, suburb, town, or village
Two-letter country code (ISO 3166-1 alpha-2)
AW
- ArubaAF
- AfghanistanAO
- AngolaAI
- AnguillaAX
- Åland IslandsAL
- AlbaniaAD
- AndorraAE
- United Arab EmiratesAR
- ArgentinaAM
- ArmeniaAS
- American SamoaAQ
- AntarcticaTF
- French Southern TerritoriesAG
- Antigua and BarbudaAU
- AustraliaAT
- AustriaAZ
- AzerbaijanBI
- BurundiBE
- BelgiumBJ
- BeninBQ
- Bonaire, Sint Eustatius and SabaBF
- Burkina FasoBD
- BangladeshBG
- BulgariaBH
- BahrainBS
- BahamasBA
- Bosnia and HerzegovinaBL
- Saint BarthélemyBY
- BelarusBZ
- BelizeBM
- BermudaBO
- Bolivia, Plurinational State ofBR
- BrazilBB
- BarbadosBN
- Brunei DarussalamBT
- BhutanBV
- Bouvet IslandBW
- BotswanaCF
- Central African RepublicCA
- CanadaCC
- Cocos (Keeling) IslandsCH
- SwitzerlandCL
- ChileCN
- ChinaCI
- Côte d'IvoireCM
- CameroonCD
- Congo, The Democratic Republic of theCG
- CongoCK
- Cook IslandsCO
- ColombiaKM
- ComorosCV
- Cabo VerdeCR
- Costa RicaCU
- CubaCW
- CuraçaoCX
- Christmas IslandKY
- Cayman IslandsCY
- CyprusCZ
- CzechiaDE
- GermanyDJ
- DjiboutiDM
- DominicaDK
- DenmarkDO
- Dominican RepublicDZ
- AlgeriaEC
- EcuadorEG
- EgyptER
- EritreaEH
- Western SaharaES
- SpainEE
- EstoniaET
- EthiopiaFI
- FinlandFJ
- FijiFK
- Falkland Islands (Malvinas)FR
- FranceFO
- Faroe IslandsFM
- Micronesia, Federated States ofGA
- GabonGB
- United KingdomGE
- GeorgiaGG
- GuernseyGH
- GhanaGI
- GibraltarGN
- GuineaGP
- GuadeloupeGM
- GambiaGW
- Guinea-BissauGQ
- Equatorial GuineaGR
- GreeceGD
- GrenadaGL
- GreenlandGT
- GuatemalaGF
- French GuianaGU
- GuamGY
- GuyanaHK
- Hong KongHM
- Heard Island and McDonald IslandsHN
- HondurasHR
- CroatiaHT
- HaitiHU
- HungaryID
- IndonesiaIM
- Isle of ManIN
- IndiaIO
- British Indian Ocean TerritoryIE
- IrelandIR
- Iran, Islamic Republic ofIQ
- IraqIS
- IcelandIL
- IsraelIT
- ItalyJM
- JamaicaJE
- JerseyJO
- JordanJP
- JapanKZ
- KazakhstanKE
- KenyaKG
- KyrgyzstanKH
- CambodiaKI
- KiribatiKN
- Saint Kitts and NevisKR
- Korea, Republic ofKW
- KuwaitLA
- Lao People's Democratic RepublicLB
- LebanonLR
- LiberiaLY
- LibyaLC
- Saint LuciaLI
- LiechtensteinLK
- Sri LankaLS
- LesothoLT
- LithuaniaLU
- LuxembourgLV
- LatviaMO
- MacaoMF
- Saint Martin (French part)MA
- MoroccoMC
- MonacoMD
- Moldova, Republic ofMG
- MadagascarMV
- MaldivesMX
- MexicoMH
- Marshall IslandsMK
- North MacedoniaML
- MaliMT
- MaltaMM
- MyanmarME
- MontenegroMN
- MongoliaMP
- Northern Mariana IslandsMZ
- MozambiqueMR
- MauritaniaMS
- MontserratMQ
- MartiniqueMU
- MauritiusMW
- MalawiMY
- MalaysiaYT
- MayotteNA
- NamibiaNC
- New CaledoniaNE
- NigerNF
- Norfolk IslandNG
- NigeriaNI
- NicaraguaNU
- NiueNL
- NetherlandsNO
- NorwayNP
- NepalNR
- NauruNZ
- New ZealandOM
- OmanPK
- PakistanPA
- PanamaPN
- PitcairnPE
- PeruPH
- PhilippinesPW
- PalauPG
- Papua New GuineaPL
- PolandPR
- Puerto RicoKP
- Korea, Democratic People's Republic ofPT
- PortugalPY
- ParaguayPS
- Palestine, State ofPF
- French PolynesiaQA
- QatarRE
- RéunionRO
- RomaniaRU
- Russian FederationRW
- RwandaSA
- Saudi ArabiaSD
- SudanSN
- SenegalSG
- SingaporeGS
- South Georgia and the South Sandwich IslandsSH
- Saint Helena, Ascension and Tristan da CunhaSJ
- Svalbard and Jan MayenSB
- Solomon IslandsSL
- Sierra LeoneSV
- El SalvadorSM
- San MarinoSO
- SomaliaPM
- Saint Pierre and MiquelonRS
- SerbiaSS
- South SudanST
- Sao Tome and PrincipeSR
- SurinameSK
- SlovakiaSI
- SloveniaSE
- SwedenSZ
- EswatiniSX
- Sint Maarten (Dutch part)SC
- SeychellesSY
- Syrian Arab RepublicTC
- Turks and Caicos IslandsTD
- ChadTG
- TogoTH
- ThailandTJ
- TajikistanTK
- TokelauTM
- TurkmenistanTL
- Timor-LesteTO
- TongaTT
- Trinidad and TobagoTN
- TunisiaTR
- TurkeyTV
- TuvaluTW
- Taiwan, Province of ChinaTZ
- Tanzania, United Republic ofUG
- UgandaUA
- UkraineUM
- United States Minor Outlying IslandsUY
- UruguayUS
- United StatesUZ
- UzbekistanVA
- Holy See (Vatican City State)VC
- Saint Vincent and the GrenadinesVE
- Venezuela, Bolivarian Republic ofVG
- Virgin Islands, BritishVI
- Virgin Islands, U.S.VN
- Viet NamVU
- VanuatuWF
- Wallis and FutunaWS
- SamoaYE
- YemenZA
- South AfricaZM
- ZambiaZW
- Zimbabwe
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
Address line 1 (e.g., street, PO Box, or company name)
Address line 2 (e.g., apartment, suite, unit, or building)
ZIP or postal code
State, county, province, or region
curl --request GET \
--url https://api.uselotus.io/api/invoices/{invoice_id}/pdf_url/ \
--header 'Authorization: <authorization>' \
--header 'X-API-KEY: <x-api-key>'