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

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

slug
string
required

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

external_id
string
required

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

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

address_line1
string | null

The first line of the billing address

address_line2
string | null

The second line of the billing address

city
string | null

The city of the customer's billing address

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
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
email
string | null

The email of the customer

legal_name
string | null

The legal company name of the customer

legal_number
string | null

The legal company number of the customer

logo_url
string | null

The logo URL of the customer

name
string | null

The full name of the customer

firstname
string | null

First name of the customer

lastname
string | null

Last name of the 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
phone
string | null

The phone number of the customer

state
string | null

The state of the customer's billing address

tax_identification_number
string | null

The tax identification number of the 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
url
string | null

The custom website URL of the customer

zipcode
string | null

The zipcode of the customer's billing address

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.

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

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

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.

metadata
object[]
integration_customers
object[]
taxes
object[]

List of customer taxes

Was this page helpful?

Retrieve past usageCreate a customer