API Reference
- Getting started
- Add-ons
- Analytics
- Billable metrics
- Coupons
- Credit notes
- Customer usage
- Customers
- Events
- Fees
- Invoices
- Organizations
- Payment requests
- Plans
- Resources
- Subscriptions
- Taxes
- Wallets
- Webhook endpoints
- Webhooks
Update your organization
This endpoint is used to update your own organization’s settings.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The first line of your organization's billing address.
The second line of your organization's billing address.
The custom billing settings for your organization.
The locale of the billing documents, expressed in the ISO 639-1 format. This field indicates the language or regional variant used for the documents content issued or the embeddable customer portal.
The customer invoice message that appears at the bottom of each billing documents.
The grace period, expressed in days, for finalizing the invoice. This period refers to the additional time granted to your customers beyond the invoice due date to adjust usage and line items. Can be overwritten by the customer's grace period.
The city of your organization's billing address.
The country of your organization.
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
The default currency of an organization.
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
Sets the prefix for invoices and credit notes. Default is the first three letters of your organization name plus the last four digits of your organization ID. Customizable within 1-10 characters, and automatically capitalized by Lago.
This parameter configures the method of incrementing invoice numbers for your customers.
per_customer
: Invoice numbers are incremented individually for each customer. This means every customer will have their own unique sequence of invoice numbers, separate from other customers. It ensures that each customer's invoice numbers follow a distinct and isolated numbering pattern.per_organization
: Invoice number incrementation is made across your entire organization. Rather than individual sequences for each customer, all invoices within the organization follow a single, unified numbering system. This creates a continuous and organization-wide sequence for all invoice numbers. Invoices are incremented per month (dynamic value used is YYYYMM), and invoice numbers are reset at the end of each month.
The default value for document_numbering
is set to per_customer
, meaning that, unless changed, invoice numbers will increment uniquely for each customer.
per_customer
, per_organization
The email address of your organization used to bill your customers.
Represents the email settings of the organization. It allows you to define which documents are sent by email. The field value determines the types of documents that trigger email notifications. Possible values for are invoice.finalized
and credit_note.created
. By configuring this field, you can specify whether invoices, credit notes, or both should be sent to recipients via email.
invoice.finalized
, credit_note.created
Determines whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.
The legal name of your organization.
The legal number of your organization.
The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
The state of your organization's billing address.
The tax identification number of your organization.
Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone.
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
The URL of your newest updated webhook endpoint. This URL allows your organization to receive important messages, notifications, or data from the Lago system. By configuring your webhook endpoint to this URL, you can ensure that your organization stays informed and receives relevant information in a timely manner.
The zipcode of your organization's billing address.
Response
The custom billing settings for your organization.
The locale of the billing documents, expressed in the ISO 639-1 format. This field indicates the language or regional variant used for the documents content issued or the embeddable customer portal.
The customer invoice message that appears at the bottom of each billing documents.
The grace period, expressed in days, for finalizing the invoice. This period refers to the additional time granted to your customers beyond the invoice due date to adjust usage and line items. Can be overwritten by the customer's grace period.
The date of creation of your organization, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
Sets the prefix for invoices and credit notes. Default is the first three letters of your organization name plus the last four digits of your organization ID. Customizable within 1-10 characters, and automatically capitalized by Lago.
This parameter configures the method of incrementing invoice numbers for your customers.
per_customer
: Invoice numbers are incremented individually for each customer. This means every customer will have their own unique sequence of invoice numbers, separate from other customers. It ensures that each customer's invoice numbers follow a distinct and isolated numbering pattern.per_organization
: Invoice number incrementation is made across your entire organization. Rather than individual sequences for each customer, all invoices within the organization follow a single, unified numbering system. This creates a continuous and organization-wide sequence for all invoice numbers. Invoices are incremented per month (dynamic value used is YYYYMM), and invoice numbers are reset at the end of each month.
The default value for document_numbering
is set to per_customer
, meaning that, unless changed, invoice numbers will increment uniquely for each customer.
per_customer
, per_organization
Unique identifier assigned to the organization within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the organization's record within the Lago system
The name of your organization.
The first line of your organization's billing address.
The second line of your organization's billing address.
The city of your organization's billing address.
The country of your organization.
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
The default currency of an organization.
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
The email address of your organization used to bill your customers.
Indicates whether invoices with a zero total amount should be finalized. If set to true, zero amount invoices will be finalized. If set to false, zero amount invoices will not be finalized.
The legal name of your organization.
The legal number of your organization.
The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
The state of your organization's billing address.
The tax identification number of your organization.
List of default organization taxes
Set to true
if the tax is used as one of the organization's default
Unique code used to identify the tax associated with the API request.
Creation date of the tax.
Unique identifier of the tax, created by Lago.
Name of the tax.
The percentage rate of the tax
Internal description of the taxe
Your organization's timezone, used for billing purposes in your own local time. Can be overwritten by the customer's timezone.
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
The URL of your newest updated webhook endpoint. This URL allows your organization to receive important messages, notifications, or data from the Lago system. By configuring your webhook endpoint to this URL, you can ensure that your organization stays informed and receives relevant information in a timely manner.
The array containing your webhooks URLs.
The zipcode of your organization's billing address.
Was this page helpful?