Customers
Create a customer
This endpoint creates a new customer.
POST
/api/v1/customers
Bearer*
{
"customer": {
"address_line1": "5230 Penfield Ave",
"address_line2": "null",
"applicable_timezone": "America/Los_Angeles",
"billing_configuration": {
"document_locale": "fr",
"invoice_grace_period": "3",
"payment_provider": "stripe",
"provider_customer_id": "cus_12345",
"provider_payment_methods": [
"card",
"sepa_debit"
],
"sync": true,
"sync_with_provider": true
},
"city": "Woodland Hills",
"country": "US",
"created_at": "2022-04-29T08:59:51Z",
"currency": "USD",
"email": "dinesh@piedpiper.test",
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"legal_name": "Coleman-Blair",
"legal_number": "49-008-2965",
"logo_url": "http://hooli.com/logo.png",
"metadata": [
{
"created_at": "2022-04-29T08:59:51Z",
"display_in_invoice": true,
"key": "Purchase Order",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"value": "123456789"
}
],
"name": "Gavin Belson",
"net_payment_term": "30",
"phone": "1-171-883-3711 x245",
"sequential_id": "1",
"slug": "LAG-1234-001",
"state": "CA",
"tax_identification_number": "EU123456789",
"timezone": "America/Los_Angeles",
"updated_at": "2022-04-29T08:59:51Z",
"url": "http://hooli.com",
"zipcode": "91364",
"taxes": [
{
"add_ons_count": "integer",
"applied_to_organization": true,
"charges_count": "integer",
"code": "french_standard_vat",
"created_at": "2023-07-06T14:35:58Z",
"customers_count": "integer",
"description": "French standard VAT",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"name": "TVA",
"plans_count": "integer",
"rate": "20"
}
]
}
}
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
curl --location --request POST "$LAGO_URL/api/v1/customers" \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"customer": {
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"address_line1": "5230 Penfield Ave",
"address_line2": "",
"city": "Woodland Hills",
"country": "US",
"currency": "USD",
"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",
"timezone": "Europe/Paris",
"url": "http://hooli.com",
"zipcode": "91364",
"billing_configuration": {
"invoice_grace_period": 3,
"payment_provider": "stripe",
"provider_customer_id": "cus_12345",
"sync": true,
"sync_with_provider": true,
"document_locale": "fr",
"vat_rate": 12.5,
"provider_payment_methods": ["card","sepa_debit"]
},
"metadata": [
{
"key": "Purchase Order",
"value": "123456789",
"display_in_invoice": true
}
]
}
}'
Authorizations
Authorizationheaderrequired
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
customerrequired
object
Response
200 - application/json
customerrequired
object
LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"
curl --location --request POST "$LAGO_URL/api/v1/customers" \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"customer": {
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"address_line1": "5230 Penfield Ave",
"address_line2": "",
"city": "Woodland Hills",
"country": "US",
"currency": "USD",
"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",
"timezone": "Europe/Paris",
"url": "http://hooli.com",
"zipcode": "91364",
"billing_configuration": {
"invoice_grace_period": 3,
"payment_provider": "stripe",
"provider_customer_id": "cus_12345",
"sync": true,
"sync_with_provider": true,
"document_locale": "fr",
"vat_rate": 12.5,
"provider_payment_methods": ["card","sepa_debit"]
},
"metadata": [
{
"key": "Purchase Order",
"value": "123456789",
"display_in_invoice": true
}
]
}
}'
{
"customer": {
"address_line1": "5230 Penfield Ave",
"address_line2": "null",
"applicable_timezone": "America/Los_Angeles",
"billing_configuration": {
"document_locale": "fr",
"invoice_grace_period": "3",
"payment_provider": "stripe",
"provider_customer_id": "cus_12345",
"provider_payment_methods": [
"card",
"sepa_debit"
],
"sync": true,
"sync_with_provider": true
},
"city": "Woodland Hills",
"country": "US",
"created_at": "2022-04-29T08:59:51Z",
"currency": "USD",
"email": "dinesh@piedpiper.test",
"external_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"legal_name": "Coleman-Blair",
"legal_number": "49-008-2965",
"logo_url": "http://hooli.com/logo.png",
"metadata": [
{
"created_at": "2022-04-29T08:59:51Z",
"display_in_invoice": true,
"key": "Purchase Order",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"value": "123456789"
}
],
"name": "Gavin Belson",
"net_payment_term": "30",
"phone": "1-171-883-3711 x245",
"sequential_id": "1",
"slug": "LAG-1234-001",
"state": "CA",
"tax_identification_number": "EU123456789",
"timezone": "America/Los_Angeles",
"updated_at": "2022-04-29T08:59:51Z",
"url": "http://hooli.com",
"zipcode": "91364",
"taxes": [
{
"add_ons_count": "integer",
"applied_to_organization": true,
"charges_count": "integer",
"code": "french_standard_vat",
"created_at": "2023-07-06T14:35:58Z",
"customers_count": "integer",
"description": "French standard VAT",
"lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
"name": "TVA",
"plans_count": "integer",
"rate": "20"
}
]
}
}