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",
    "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,
      "vat_rate": 12.5
    }
  }
}

Attributes	Description
lago_id     String     Not nullable	Unique identifer of the customer in Lago application
sequential_id     String     Not nullable	Sequential id of the customer scoped on the organization
slug     String     Not nullable	Slug of the customer based on the Organization name, id and customer sequantial_id
external_id     String     Not nullable	Unique identifer of the customer in your application
address_line1     String	First line of the billing address
address_line2     String	Second line of the billing address
address_line2     String	Second line of the billing address
city     String	City 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     String	Email of the customer
legal_name     String	Legal company name of the customer
legal_number     String	Legal company number of the customer
logo_url     String	Logo URL of the customer
name     String	Full name of the customer
phone     String	Phone number of the customer
state     String	State of the customer's billing address
timezone     String TZ database	Timezone of the customer - learn more
applicable_timezone     String	Timezone applicable the customer. Value is inherited from the organization if timezone attribute is null
url     String	Custom URL of the customer
zipcode     String	Zipcode of the customer's billing address

Billing Configuration Object

Attributes	Description
invoice_grace_period     Integer	Grace period in days for the invoice (time between the end of the period and the closing of the invoice).
payment_provider     String	Payment provider used to bill the customer. Possible values - stripe: Use stripe as a payment provider. - null: No payment providers. Only webhooks will be send to process customer billing.
provider_customer_id     String	Customer ID on the payment provider.
vat_rate     Float	Custom VAT rate applied to the customer.
sync_with_provider     Boolean	Field that determines whether to create customer in payment provider or not.