List all invoices

GET

invoices

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/invoices?page=2&per_page=20&external_customer_id=hooli_1234" \
  --header "Authorization: Bearer $API_KEY"

{
  "invoices": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "billing_entity_code": "acme_corp",
      "sequential_id": 2,
      "number": "LAG-1234-001-002",
      "issuing_date": "2022-04-30",
      "payment_dispute_lost_at": "2022-09-14T16:35:31Z",
      "payment_due_date": "2022-04-30",
      "payment_overdue": true,
      "net_payment_term": 30,
      "invoice_type": "subscription",
      "status": "finalized",
      "payment_status": "succeeded",
      "currency": "EUR",
      "fees_amount_cents": 100,
      "coupons_amount_cents": 10,
      "credit_notes_amount_cents": 10,
      "sub_total_excluding_taxes_amount_cents": 100,
      "taxes_amount_cents": 20,
      "sub_total_including_taxes_amount_cents": 120,
      "prepaid_credit_amount_cents": 0,
      "progressive_billing_credit_amount_cents": 0,
      "total_amount_cents": 100,
      "version_number": 3,
      "self_billed": false,
      "file_url": "https://getlago.com/invoice/file",
      "created_at": "2022-04-29T08:59:51Z",
      "updated_at": "2022-04-29T08:59:51Z",
      "customer": {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "sequential_id": 1,
        "slug": "LAG-1234-001",
        "external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
        "billing_entity_code": "acme_corp",
        "address_line1": "5230 Penfield Ave",
        "address_line2": null,
        "applicable_timezone": "America/Los_Angeles",
        "city": "Woodland Hills",
        "country": "US",
        "currency": "USD",
        "email": "dinesh@piedpiper.test",
        "legal_name": "Coleman-Blair",
        "legal_number": "49-008-2965",
        "logo_url": "http://hooli.com/logo.png",
        "name": "Gavin Belson",
        "firstname": "Gavin",
        "lastname": "Belson",
        "account_type": "customer",
        "customer_type": "company",
        "phone": "1-171-883-3711 x245",
        "state": "CA",
        "tax_identification_number": "EU123456789",
        "timezone": "America/Los_Angeles",
        "url": "http://hooli.com",
        "zipcode": "91364",
        "net_payment_term": 30,
        "created_at": "2022-04-29T08:59:51Z",
        "updated_at": "2022-04-29T08:59:51Z",
        "finalize_zero_amount_invoice": "inherit",
        "skip_invoice_custom_sections": false,
        "billing_configuration": {
          "invoice_grace_period": 3,
          "payment_provider": "stripe",
          "payment_provider_code": "stripe-eu-1",
          "provider_customer_id": "cus_12345",
          "sync": true,
          "sync_with_provider": true,
          "document_locale": "fr",
          "provider_payment_methods": [
            "card",
            "sepa_debit",
            "us_bank_account",
            "bacs_debit",
            "link",
            "boleto",
            "crypto",
            "customer_balance"
          ]
        },
        "shipping_address": {
          "address_line1": "5230 Penfield Ave",
          "address_line2": null,
          "city": "Woodland Hills",
          "country": "US",
          "state": "CA",
          "zipcode": "91364"
        },
        "metadata": [
          {
            "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
            "key": "Purchase Order",
            "value": "123456789",
            "display_in_invoice": true,
            "created_at": "2022-04-29T08:59:51Z"
          }
        ],
        "integration_customers": [
          {
            "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
            "type": "netsuite",
            "integration_code": "netsuite-eu-1",
            "external_customer_id": "cus_12345",
            "sync_with_provider": true,
            "subsidiary_id": "2"
          }
        ]
      },
      "billing_period": [
        {
          "lago_subscription_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "external_subscription_id": "external_id",
          "lago_plan_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "subscription_from_datetime": "2022-04-29T08:59:51Z",
          "subscription_to_datetime": "2022-05-29T08:59:51Z",
          "charges_from_datetime": "2022-04-29T08:59:51Z",
          "charges_to_datetime": "2022-05-29T08:59:51Z",
          "invoicing_reason": "subscription_starting"
        }
      ],
      "metadata": [
        {
          "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "key": "digital_ref_id",
          "value": "INV-0123456-98765",
          "created_at": "2022-04-29T08:59:51Z"
        }
      ],
      "applied_taxes": [
        {
          "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "lago_tax_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "tax_name": "TVA",
          "tax_code": "french_standard_vat",
          "tax_rate": 20,
          "tax_description": "French standard VAT",
          "amount_cents": 2000,
          "amount_currency": "USD",
          "created_at": "2022-09-14T16:35:31Z",
          "lago_invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "fees_amount_cents": 20000
        }
      ],
      "applied_usage_thresholds": [
        {
          "lifetime_usage_amount_cents": 2000,
          "created_at": "2023-11-07T05:31:56Z",
          "usage_threshold": {
            "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
            "threshold_display_name": "Threshold 1",
            "amount_cents": 10000,
            "recurring": true,
            "created_at": "2023-06-27T19:43:42Z",
            "updated_at": "2023-06-27T19:43:42Z"
          }
        }
      ]
    }
  ],
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_pages": 4,
    "total_count": 70
  }
}

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/invoices?page=2&per_page=20&external_customer_id=hooli_1234" \
  --header "Authorization: Bearer $API_KEY"

Authorizations

Authorization

string

header

required

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

Query Parameters

page

integer

Page number.

Example:

1

per_page

integer

Number of records per page.

Example:

20

external_customer_id

string

Unique identifier assigned to the customer in your application.

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

amount_from

integer

Filter invoices of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.

Example:

9000

amount_to

integer

Filter invoices up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types.

Example:

100000

issuing_date_from

string

Filter invoices starting from a specific date.

Example:

"2022-07-08"

issuing_date_to

string

Filter invoices up to a specific date.

Example:

"2022-08-09"

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.

Example:

true

search_term

string

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

Example:

"Jane"

currency

string

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

Example:

"EUR"

payment_dispute_lost

boolean

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

Example:

true

invoice_type

enum<string>

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

Available options:

subscription,

add_on,

credit,

one_off,

advance_charges,

progressive_billing

self_billed

boolean

Filter invoices by self billed. Possible values are true or false.

Example:

true

billing_entity_codes

string[]

Filter invoices by billing entity codes. Possible values are the billing entity codes you have created.

Example:

["acme_corp", "foo_bar"]

metadata[key]

string

Filter invoices by metadata. Replace key with the actual metadata key you want to match, and provide the corresponding value. Providing empty value will search for invoice without given metadata key. For example, metadata[color]=blue.

Example:

"someValue"

Response

200

application/json

Invoices

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.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

invoices.billing_entity_code

string | null

required

The unique code of the billing entity associated with the invoice

Example:

"acme_corp"

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.

Example:

"LAG-1234-001-002"

invoices.issuing_date

string

required

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

Example:

"2022-04-30"

invoices.invoice_type

enum<string>

required

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

Available options:

subscription,

add_on,

credit,

one_off,

progressive_billing

Example:

"subscription"

invoices.status

enum<string>

required

The status of the invoice. It indicates the current state of the invoice and can have following 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.
pending: the invoice remains pending until the taxes are fetched from the external provider.
failed: during an attempt of finalization of the invoice, an error happened. This invoice will have an array of error_details, explaining, in which part of the system an error happened and how it's possible to fix it. This invoice can't be edited or updated, only retried. This action will discard current error_details and will create new ones if the finalization failed again.

Available options:

draft,

finalized,

voided,

failed,

pending

Example:

"finalized"

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

Example:

"succeeded"

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

Example:

"USD"

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.

Example:

100

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.

Example:

10

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.

Example:

10

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 & 4: is equal to the fees_amount_cents, minus coupons_amount_cents

Example:

100

invoices.taxes_amount_cents

integer

required

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

Example:

20

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 & 4: is equal to the sum sub_total_excluding_taxes_amount_cents and taxes_amount_cents

Example:

120

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.

Example:

0

invoices.progressive_billing_credit_amount_cents

integer

required

The usage already billed in previous invoices. Only apply to progressive_billing and subscription invoices.

Example:

0

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.

Example:

100

invoices.version_number

integer

required

Example:

3

invoices.created_at

string

required

The date of the invoice 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 invoice object was created

Example:

"2022-04-29T08:59:51Z"

invoices.updated_at

string

required

The date of the invoice 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 invoice object was updated

Example:

"2022-04-29T08:59:51Z"

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.

Example:

2

invoices.payment_dispute_lost_at

string

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

Example:

"2022-09-14T16:35:31Z"

invoices.payment_due_date

string

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

Example:

"2022-04-30"

invoices.payment_overdue

boolean

Specifies if the payment is considered as overdue.

Example:

true

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.

Example:

30

invoices.self_billed

boolean

Indicates if the invoice is self-billed. Self-billing is a process where an organization creates the invoice on behalf of the partner. This field specifies whether the invoice is self-billed or not.

Example:

false

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

Example:

"https://getlago.com/invoice/file"

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

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

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

Example:

1

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

Example:

"LAG-1234-001"

invoices.customer.external_id

string

required

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

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

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

Example:

"America/Los_Angeles"

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

Example:

"2022-04-29T08:59:51Z"

invoices.customer.billing_entity_code

string

The unique code of the billing entity associated with the customer.

Example:

"acme_corp"

invoices.customer.address_line1

string | null

The first line of the billing address

Example:

"5230 Penfield Ave"

invoices.customer.address_line2

string | null

The second line of the billing address

Example:

null

invoices.customer.city

string | null

The city of the customer's billing address

Example:

"Woodland Hills"

invoices.customer.country

enum<string> | null

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

Example:

"US"

invoices.customer.currency

enum<string> | null

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

Example:

"USD"

invoices.customer.email

string | null

The email of the customer

Example:

"dinesh@piedpiper.test"

invoices.customer.legal_name

string | null

The legal company name of the customer

Example:

"Coleman-Blair"

invoices.customer.legal_number

string | null

The legal company number of the customer

Example:

"49-008-2965"

invoices.customer.logo_url

string | null

The logo URL of the customer

Example:

"http://hooli.com/logo.png"

invoices.customer.name

string | null

The full name of the customer

Example:

"Gavin Belson"

invoices.customer.firstname

string | null

First name of the customer

Example:

"Gavin"

invoices.customer.lastname

string | null

Last name of the customer

Example:

"Belson"

invoices.customer.account_type

enum<string>

The type of the account. It can have one of the following values:

customer: the account is a customer.
partner: the account is a partner.

Available options:

customer,

partner

Example:

"customer"

invoices.customer.customer_type

enum<string> | null

The type of the customer. It can have one of the following values:

company: the customer is a company.
individual: the customer is an individual.

Available options:

company,

individual

invoices.customer.phone

string | null

The phone number of the customer

Example:

"1-171-883-3711 x245"

invoices.customer.state

string | null

The state of the customer's billing address

Example:

"CA"

invoices.customer.tax_identification_number

string | null

The tax identification number of the customer

Example:

"EU123456789"

invoices.customer.timezone

enum<string> | null

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

Example:

"America/Los_Angeles"

invoices.customer.url

string | null

The custom website URL of the customer

Example:

"http://hooli.com"

invoices.customer.zipcode

string | null

The zipcode of the customer's billing address

Example:

"91364"

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.

Example:

30

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

Example:

"2022-04-29T08:59:51Z"

invoices.customer.finalize_zero_amount_invoice

enum<string>

Specifies how invoices with a zero total amount should be handled:

inherit: (Default) Follows the organization-level configuration.
finalize: Invoices are issued and finalized even if the total amount is zero.
skip: Invoices with a total amount of zero are not finalized.

Available options:

inherit,

skip,

finalize

Example:

"inherit"

invoices.customer.skip_invoice_custom_sections

boolean

Set to true to exclude all invoice custom sections from PDF generation for this customer only.

Example:

false

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

Example:

3

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

Example:

"stripe"

invoices.customer.billing_configuration.payment_provider_code

string

Unique code used to identify a payment provider connection.

Example:

"stripe-eu-1"

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

Example:

"cus_12345"

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

Example:

true

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

Example:

true

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

Example:

"fr"

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, boleto, link, crypto and customer_balance. Note that when link is selected, card should also be provided in the array. When customer_balance is selected, no other payment can be selected.

Example:

[
  "card",
  "sepa_debit",
  "us_bank_account",
  "bacs_debit",
  "link",
  "boleto",
  "crypto",
  "customer_balance"
]

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.metadata

object[]

Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format

invoices.customer.integration_customers

object[]

Configuration specific to the accounting and tax integrations. This object contains settings and parameters necessary for syncing documents and payments.

invoices.billing_period

object[]

invoices.metadata

object[]

invoices.applied_taxes

object[]

invoices.applied_taxes.lago_id

string

Unique identifier of the applied tax, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

invoices.applied_taxes.lago_tax_id

string

Unique identifier of the tax, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

invoices.applied_taxes.tax_name

string

Name of the tax.

Example:

"TVA"

invoices.applied_taxes.tax_code

string

Unique code used to identify the tax associated with the API request.

Example:

"french_standard_vat"

invoices.applied_taxes.tax_rate

number

The percentage rate of the tax

Example:

20

invoices.applied_taxes.tax_description

string

Internal description of the taxe

Example:

"French standard VAT"

invoices.applied_taxes.amount_cents

integer

Amount of the tax

Example:

2000

invoices.applied_taxes.amount_currency

enum<string>

Currency of the tax

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

Example:

"USD"

invoices.applied_taxes.created_at

string

The date and time when the applied tax was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the applied tax was initially created.

Example:

"2022-09-14T16:35:31Z"

invoices.applied_taxes.lago_invoice_id

string

Unique identifier of the invoice, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

invoices.applied_taxes.fees_amount_cents

integer

Fees total amount on which the tax is applied

Example:

20000

invoices.applied_usage_thresholds

object[] | null

API Reference

Authorizations

Query Parameters

Response