Skip to main content

Customer object

This object represents a customer of your business.
It lets you create a customer, but also track usage and create invoices for the same customer.

Schema

{
"customer": {
"lago_id": "99a6094e-199b-4101-896a-54e927ce7bd7",
"sequential_id": "001",
"slug": "LAG-1234-001",
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"address_line1": "5230 Penfield Ave",
"address_line2": null,
"city": "Woodland Hills",
"country": "US",
"created_at": "2022-04-29T08:59:51Z",
"email": "dinesh@piedpiper.test",
"legal_name": "Coleman-Blair",
"legal_number": "49-008-2965",
"tax_identification_number": "EU123456789",
"logo_url": "http://hooli.com/logo.png",
"name": "Gavin Belson",
"phone": "1-171-883-3711 x245",
"state": "CA",
"url": "http://hooli.com",
"zipcode": "91364",
"currency": "EUR",
"timezone": "Europe/Paris",
"applicable_timezone": "Europe/Paris",
"billing_configuration": {
"invoice_grace_period": 3,
"payment_provider": "stripe",
"provider_customer_id": "cus_12345",
"sync_with_provider": true,
"document_locale": "fr",
"vat_rate": 12.5
},
"metadata": [
{
"lago_id": "27f12d13-4ae0-437b-b822-8771bcd62e3a",
"key": "Account manager",
"value": "John Doe",
"display_in_invoice": true,
"created_at": "2022-04-29T08:59:51Z"
}
]
}
}
AttributesDescription
lago_id     String     Not nullableUnique identifer of the customer in Lago application
sequential_id     String     Not nullableSequential id of the customer scoped on the organization
slug     String     Not nullableSlug of the customer based on the Organization name, id and customer sequantial_id
external_id     String     Not nullableUnique identifer of the customer in your application
address_line1     StringFirst line of the billing address
address_line2     StringSecond line of the billing address
address_line2     StringSecond line of the billing address
city     StringCity of the customer's billing address
country     String
ISO 3166 (alpha-2)
Country code of the customer's billing address
currency     String
ISO 4217
Currency of the customer - learn more
email     StringEmail of the customer
legal_name     StringLegal company name of the customer
legal_number     StringLegal company number of the customer
tax_identification_number     StringTax identification number of the customer
logo_url     StringLogo URL of the customer
name     StringFull name of the customer
phone     StringPhone number of the customer
state     StringState of the customer's billing address
timezone     String
TZ database
Timezone of the customer - learn more
applicable_timezone     StringTimezone applicable the customer.
Value is inherited from the organization if timezone attribute is null
url     StringCustom URL of the customer
zipcode     StringZipcode of the customer's billing address

Billing Configuration Object

AttributesDescription
invoice_grace_period     IntegerGrace period in days for the invoice (time between the end of the period and the closing of the invoice).
payment_provider     StringPayment provider used to bill the customer.
Possible values
- stripe: Use Stripe as the payment provider.
- gocardless: Use GoCardless as the payment provider.
- Adyen: Use Adyen as the payment provider.
- null: No payment providers. Payments processed using Lago's webhooks.
provider_customer_id     StringCustomer ID on the payment provider
document_locale     String
ISO 639-1
Language code - learn more
vat_rate     FloatCustom VAT rate applied to the customer
sync_with_provider     BooleanField that determines whether to create customer in payment provider or not

Metadata attributes

AttributesDescription
lago_id     String     Not nullUnique identifier of the customer metadata object in Lago application.
created_at     String     Not null    
ISO 8601 datetime in UTC
Date of metadata object creation.
key     String     Not nullKey part in metadata pair
value     String     Not nullValue part in metadata pair
display_in_invoice     BooleanField that determines if metadata pair will be presented on documents