{
  "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": "USD",
    "timezone": "Europe/Paris",
    "applicable_timezone": "Europe/Paris",
    "billing_configuration": {
      "invoice_grace_period": 3,
      "payment_provider": "stripe",
      "payment_provider_code": "stripe_eu",
      "provider_customer_id": "cus_12345",
      "sync_with_provider": true,
      "document_locale": "fr",
      "provider_payment_methods": ["card","sepa_debit", "us_bank_account", "bacs_debit"]
    },
    "metadata": [
      {
        "lago_id": "27f12d13-4ae0-437b-b822-8771bcd62e3a",
        "key": "Purchase Order",
        "value": "123456789",
        "display_in_invoice": true,
        "created_at": "2022-04-29T08:59:51Z"
      }
    ],
    "taxes": [
      {
        "lago_id": "173c9da8-effc-4db6-a341-1a2d2aa500e6",
        "name": "VAT",
        "code": "vat_fr",
        "rate": 20.0,
        "description": null,
        "applied_to_organization": false,
        "add_ons_count": 0,
        "customers_count": 1,
        "plans_count": 0,
        "charges_count": 1,
        "created_at": "2022-06-29T12:04:36Z"
      }
    ]
  }
}

​
Attributes

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

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

address_line1
string

The first line of the billing address.

address_line2
string

The second line of the billing address.

applicable_timezone
string
required

The customer’s applicable timezone, used for billing purposes in their local time.

city
string

The city of the customer’s billing address.

country
string

Country code of the customer’s billing address. Format must be ISO 3166 (alpha-2).

currency
string

Currency of the customer. Format must be ISO 4217.

email
string

The email of the customer.

legal_name
string

The legal company name of the customer.

legal_number
string

The legal company number of the customer.

logo_url
string

The logo URL of the customer.

name
string

The full name of the customer.

state
string

The state of the customer’s billing address.

tax_identification_number
string

The tax identification number of the customer.

timezone
string

The customer’s timezone, used for billing purposes in their local time. Overrides the organization’s timezone.

url
string

The custom website URL of the customer.

zipcode
string

The zipcode of the customer’s billing address.

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.

billing_configuration
object
metadata
array
taxes
array

Was this page helpful?

Retrieve past usageCreate a customer