List all invoices

GET

https://{region}.getlago.com/api/v1

invoices

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

Page number.

per_page

integer

Number of records per page.

external_customer_id

string

Unique identifier assigned to the customer in your application.

issuing_date_from

string

Filter invoices starting from a specific date.

issuing_date_to

string

Filter invoices up to a specific date.

status

enum<string>

Filter invoices by status. Possible values are draft or finalized.

Available options:

draft,

finalized

payment_status

enum<string>

Filter invoices by payment status. Possible values are pending, failed or succeeded.

Available options:

pending,

failed,

succeeded

payment_overdue

boolean

Filter invoices by payment_overdue. Possible values are true or false.

search_term

string

Search invoices by id, number, customer name, customer external_id or customer email.

currency

string

Filter invoices by currency in. Possible values ISO 4217 currency codes.

payment_dispute_lost

boolean

Filter invoices with a payment dispute lost. Possible values are true or false.

invoice_type

enum<string>

Filter invoices by invoice type. Possible values are subscription, add_on, credit, one_off or advance_charges

Available options:

subscription,

add_on,

credit,

one_off,

advance_charges

Response

200 - application/json

invoices

object[]

required

invoices.lago_id

string

required

Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system.

invoices.sequential_id

integer

This ID helps in uniquely identifying and organizing the invoices associated with a specific customer. It provides a sequential numbering system specific to the customer, allowing for easy tracking and management of invoices within the customer's context.

invoices.number

string

required

The unique number assigned to the invoice. This number serves as a distinct identifier for the invoice and helps in differentiating it from other invoices in the system.

invoices.issuing_date

string

required

The date when the invoice was issued. It is provided in the ISO 8601 date format.

invoices.payment_dispute_lost_at

string

The date when the payment dispute was lost. It is expressed in Coordinated Universal Time (UTC).

invoices.payment_due_date

string

The payment due date for the invoice, specified in the ISO 8601 date format.

invoices.payment_overdue

boolean

Specifies if the payment is considered as overdue.

invoices.net_payment_term

integer

The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.

invoices.invoice_type

enum<string>

required

The type of invoice issued. Possible values are subscription, one-off or credit.

Available options:

subscription,

add_on,

credit,

one_off

invoices.status

enum<string>

required

The status of the invoice. It indicates the current state of the invoice and can have two possible values:

draft: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice.
finalized: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore.
voided: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore.

Available options:

draft,

finalized,

voided

invoices.payment_status

enum<string>

required

The status of the payment associated with the invoice. It can have one of the following values:

pending: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint.
succeeded: the payment of the invoice has been successfully processed.
failed: the payment of the invoice has failed or encountered an error during processing.

Available options:

pending,

succeeded,

failed

invoices.currency

enum<string>

required

The currency of the invoice issued.

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STD,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

invoices.fees_amount_cents

integer

required

The total sum of fees amount in cents. It calculates the cumulative amount of all the fees associated with the invoice, providing a consolidated value.

invoices.coupons_amount_cents

integer

required

The total sum of all coupons discounted on the invoice. It calculates the cumulative discount amount applied by coupons, expressed in cents.

invoices.credit_notes_amount_cents

integer

required

The total sum of all credit notes discounted on the invoice. It calculates the cumulative discount amount applied by credit notes, expressed in cents.

invoices.sub_total_excluding_taxes_amount_cents

integer

required

Subtotal amount, excluding taxes, expressed in cents. This field depends on the version number. Here are the definitions based on the version:

Version 1: is equal to the sum of fees_amount_cents, minus coupons_amount_cents, and minus prepaid_credit_amount_cents.
Version 2: is equal to the fees_amount_cents.
Version 3: is equal to the fees_amount_cents, minus coupons_amount_cents

invoices.taxes_amount_cents

integer

required

The sum of tax amount associated with the invoice, expressed in cents.

invoices.sub_total_including_taxes_amount_cents

integer

required

Subtotal amount, including taxes, expressed in cents. This field depends on the version number. Here are the definitions based on the version:

Version 1: is equal to the total_amount_cents.
Version 2: is equal to the sum of fees_amount_cents and taxes_amount_cents.
Version 3: is equal to the sum sub_total_excluding_taxes_amount_cents and taxes_amount_cents

invoices.prepaid_credit_amount_cents

integer

required

The total sum of all prepaid credits discounted on the invoice. It calculates the cumulative discount amount applied by prepaid credits, expressed in cents.

invoices.total_amount_cents

integer

required

The sum of the amount and taxes amount on the invoice, expressed in cents. It calculates the total financial value of the invoice, including both the original amount and any applicable taxes.

invoices.version_number

integer

required

invoices.file_url

string

Contains the URL that provides direct access to the invoice PDF file. You can use this URL to download or view the PDF document of the invoice

invoices.customer

object

The customer on which the invoice applies. It refers to the customer account or entity associated with the invoice.

invoices.customer.lago_id

string

required

Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system

invoices.customer.sequential_id

integer

required

The unique identifier assigned to the customer within the organization's scope. This identifier is used to track and reference the customer's order of creation within the organization's system. It ensures that each customer has a distinct `sequential_id`` associated with them, allowing for easy identification and sorting based on the order of creation

invoices.customer.slug

string

required

A concise and unique identifier for the customer, formed by combining the Organization's name, id, and customer's sequential_id

invoices.customer.external_id

string

required

The customer external unique identifier (provided by your own application)

invoices.customer.address_line1

string | null

The first line of the billing address

invoices.customer.address_line2

string | null

The second line of the billing address

invoices.customer.applicable_timezone

enum<string>

required

The customer's applicable timezone, used for billing purposes in their local time.

Available options:

UTC,

Africa/Algiers,

Africa/Cairo,

Africa/Casablanca,

Africa/Harare,

Africa/Johannesburg,

Africa/Monrovia,

Africa/Nairobi,

America/Argentina/Buenos_Aires,

America/Bogota,

America/Caracas,

America/Chicago,

America/Chihuahua,

America/Denver,

America/Godthab,

America/Guatemala,

America/Guyana,

America/Halifax,

America/Indiana/Indianapolis,

America/Juneau,

America/La_Paz,

America/Lima,

America/Los_Angeles,

America/Mazatlan,

America/Mexico_City,

America/Monterrey,

America/Montevideo,

America/New_York,

America/Phoenix,

America/Puerto_Rico,

America/Regina,

America/Santiago,

America/Sao_Paulo,

America/St_Johns,

America/Tijuana,

Asia/Almaty,

Asia/Baghdad,

Asia/Baku,

Asia/Bangkok,

Asia/Chongqing,

Asia/Colombo,

Asia/Dhaka,

Asia/Hong_Kong,

Asia/Irkutsk,

Asia/Jakarta,

Asia/Jerusalem,

Asia/Kabul,

Asia/Kamchatka,

Asia/Karachi,

Asia/Kathmandu,

Asia/Kolkata,

Asia/Krasnoyarsk,

Asia/Kuala_Lumpur,

Asia/Kuwait,

Asia/Magadan,

Asia/Muscat,

Asia/Novosibirsk,

Asia/Rangoon,

Asia/Riyadh,

Asia/Seoul,

Asia/Shanghai,

Asia/Singapore,

Asia/Srednekolymsk,

Asia/Taipei,

Asia/Tashkent,

Asia/Tbilisi,

Asia/Tehran,

Asia/Tokyo,

Asia/Ulaanbaatar,

Asia/Urumqi,

Asia/Vladivostok,

Asia/Yakutsk,

Asia/Yekaterinburg,

Asia/Yerevan,

Atlantic/Azores,

Atlantic/Cape_Verde,

Atlantic/South_Georgia,

Australia/Adelaide,

Australia/Brisbane,

Australia/Darwin,

Australia/Hobart,

Australia/Melbourne,

Australia/Perth,

Australia/Sydney,

Europe/Amsterdam,

Europe/Athens,

Europe/Belgrade,

Europe/Berlin,

Europe/Bratislava,

Europe/Brussels,

Europe/Bucharest,

Europe/Budapest,

Europe/Copenhagen,

Europe/Dublin,

Europe/Helsinki,

Europe/Istanbul,

Europe/Kaliningrad,

Europe/Kiev,

Europe/Lisbon,

Europe/Ljubljana,

Europe/London,

Europe/Madrid,

Europe/Minsk,

Europe/Moscow,

Europe/Paris,

Europe/Prague,

Europe/Riga,

Europe/Rome,

Europe/Samara,

Europe/Sarajevo,

Europe/Skopje,

Europe/Sofia,

Europe/Stockholm,

Europe/Tallinn,

Europe/Vienna,

Europe/Vilnius,

Europe/Volgograd,

Europe/Warsaw,

Europe/Zagreb,

Europe/Zurich,

GMT+12,

Pacific/Apia,

Pacific/Auckland,

Pacific/Chatham,

Pacific/Fakaofo,

Pacific/Fiji,

Pacific/Guadalcanal,

Pacific/Guam,

Pacific/Honolulu,

Pacific/Majuro,

Pacific/Midway,

Pacific/Noumea,

Pacific/Pago_Pago,

Pacific/Port_Moresby,

Pacific/Tongatapu

invoices.customer.city

string | null

The city of the customer's billing address

invoices.customer.country

enum<string>

Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

YE,

YT,

ZA,

ZM,

ZW

invoices.customer.currency

enum<string>

Currency of the customer. Format must be ISO 4217

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

ISK,

JMD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLL,

SOS,

SRD,

STD,

SZL,

THB,

TJS,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

invoices.customer.email

string | null

The email of the customer

invoices.customer.legal_name

string | null

The legal company name of the customer

invoices.customer.legal_number

string | null

The legal company number of the customer

invoices.customer.logo_url

string | null

The logo URL of the customer

invoices.customer.name

string | null

The full name of the customer

invoices.customer.phone

string | null

The phone number of the customer

invoices.customer.state

string | null

The state of the customer's billing address

invoices.customer.tax_identification_number

string | null

The tax identification number of the customer

invoices.customer.timezone

enum<string>

The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone

Available options:

UTC,

Africa/Algiers,

Africa/Cairo,

Africa/Casablanca,

Africa/Harare,

Africa/Johannesburg,

Africa/Monrovia,

Africa/Nairobi,

America/Argentina/Buenos_Aires,

America/Bogota,

America/Caracas,

America/Chicago,

America/Chihuahua,

America/Denver,

America/Godthab,

America/Guatemala,

America/Guyana,

America/Halifax,

America/Indiana/Indianapolis,

America/Juneau,

America/La_Paz,

America/Lima,

America/Los_Angeles,

America/Mazatlan,

America/Mexico_City,

America/Monterrey,

America/Montevideo,

America/New_York,

America/Phoenix,

America/Puerto_Rico,

America/Regina,

America/Santiago,

America/Sao_Paulo,

America/St_Johns,

America/Tijuana,

Asia/Almaty,

Asia/Baghdad,

Asia/Baku,

Asia/Bangkok,

Asia/Chongqing,

Asia/Colombo,

Asia/Dhaka,

Asia/Hong_Kong,

Asia/Irkutsk,

Asia/Jakarta,

Asia/Jerusalem,

Asia/Kabul,

Asia/Kamchatka,

Asia/Karachi,

Asia/Kathmandu,

Asia/Kolkata,

Asia/Krasnoyarsk,

Asia/Kuala_Lumpur,

Asia/Kuwait,

Asia/Magadan,

Asia/Muscat,

Asia/Novosibirsk,

Asia/Rangoon,

Asia/Riyadh,

Asia/Seoul,

Asia/Shanghai,

Asia/Singapore,

Asia/Srednekolymsk,

Asia/Taipei,

Asia/Tashkent,

Asia/Tbilisi,

Asia/Tehran,

Asia/Tokyo,

Asia/Ulaanbaatar,

Asia/Urumqi,

Asia/Vladivostok,

Asia/Yakutsk,

Asia/Yekaterinburg,

Asia/Yerevan,

Atlantic/Azores,

Atlantic/Cape_Verde,

Atlantic/South_Georgia,

Australia/Adelaide,

Australia/Brisbane,

Australia/Darwin,

Australia/Hobart,

Australia/Melbourne,

Australia/Perth,

Australia/Sydney,

Europe/Amsterdam,

Europe/Athens,

Europe/Belgrade,

Europe/Berlin,

Europe/Bratislava,

Europe/Brussels,

Europe/Bucharest,

Europe/Budapest,

Europe/Copenhagen,

Europe/Dublin,

Europe/Helsinki,

Europe/Istanbul,

Europe/Kaliningrad,

Europe/Kiev,

Europe/Lisbon,

Europe/Ljubljana,

Europe/London,

Europe/Madrid,

Europe/Minsk,

Europe/Moscow,

Europe/Paris,

Europe/Prague,

Europe/Riga,

Europe/Rome,

Europe/Samara,

Europe/Sarajevo,

Europe/Skopje,

Europe/Sofia,

Europe/Stockholm,

Europe/Tallinn,

Europe/Vienna,

Europe/Vilnius,

Europe/Volgograd,

Europe/Warsaw,

Europe/Zagreb,

Europe/Zurich,

GMT+12,

Pacific/Apia,

Pacific/Auckland,

Pacific/Chatham,

Pacific/Fakaofo,

Pacific/Fiji,

Pacific/Guadalcanal,

Pacific/Guam,

Pacific/Honolulu,

Pacific/Majuro,

Pacific/Midway,

Pacific/Noumea,

Pacific/Pago_Pago,

Pacific/Port_Moresby,

Pacific/Tongatapu

invoices.customer.url

string | null

The custom website URL of the customer

invoices.customer.zipcode

string | null

The zipcode of the customer's billing address

invoices.customer.net_payment_term

integer | null

The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.

invoices.customer.created_at

string

required

The date of the customer creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The creation_date provides a standardized and internationally recognized timestamp for when the customer object was created

invoices.customer.updated_at

string

The date of the customer update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the customer object was updated

invoices.customer.billing_configuration

object

Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer.

invoices.customer.billing_configuration.invoice_grace_period

integer

The grace period, expressed in days, for the invoice. This period refers to the additional time granted to the customer beyond the invoice due date to adjust usage and line items

invoices.customer.billing_configuration.payment_provider

enum<string>

The payment provider utilized to initiate payments for invoices issued by Lago. Accepted values: stripe, adyen, gocardless or null. This field is required if you intend to assign a provider_customer_id.

Available options:

stripe,

adyen,

gocardless

invoices.customer.billing_configuration.payment_provider_code

string

Unique code used to identify a payment provider connection.

invoices.customer.billing_configuration.provider_customer_id

string

The customer ID within the payment provider's system. If this field is not provided, Lago has the option to create a new customer record within the payment provider's system on behalf of the customer

invoices.customer.billing_configuration.sync

boolean

Set this field to true if you want to create the customer in the payment provider synchronously with the customer creation process in Lago. This option is applicable only when the provider_customer_id is null and the customer is automatically created in the payment provider through Lago. By default, the value is set to false

invoices.customer.billing_configuration.sync_with_provider

boolean

Set this field to true if you want to create a customer record in the payment provider's system. This option is applicable only when the provider_customer_id is null and the sync_with_provider field is set to true. By default, the value is set to false

invoices.customer.billing_configuration.document_locale

string

The document locale, specified in the ISO 639-1 format. This field represents the language or locale used for the documents issued by Lago

invoices.customer.billing_configuration.provider_payment_methods

string[] | null

Specifies the available payment methods that can be used for this customer when payment_provider is set to stripe. The provider_payment_methods field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to [card]. For now, possible values are card, sepa_debit, us_bank_account, bacs_debit and link. Note that when link is selected, card should also be provided in the array.

invoices.customer.shipping_address

object

Configuration specific to the payment provider, utilized for billing the customer. This object contains settings and parameters necessary for processing payments and invoicing the customer.

invoices.customer.integration_customers

object[]

invoices.customer.metadata

object[]

invoices.metadata

object[]

invoices.applied_taxes

object[]

API Reference

Authorizations

Query Parameters

Response