API Reference
- Getting started
- Add-ons
- Analytics
- Billable metrics
- Coupons
- Credit notes
- Customer usage
- Customers
- Events
- Fees
- Invoices
- Organizations
- Payment requests
- Plans
- Resources
- Subscriptions
- Taxes
- Wallets
- Webhook endpoints
- Webhooks
Create a customer
This endpoint creates a new customer.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The customer external unique identifier (provided by your own application)
The first line of the billing address
The second line of the billing address
The city of the customer's billing address
Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)
Currency of the customer. Format must be ISO 4217
The email of the customer
The legal company name of the customer
The legal company number of the customer
The logo URL of the customer
The full name of the customer
First name of the customer
Last name of the customer
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.
The phone number of the customer
The state of the customer's billing address
List of unique code used to identify the taxes.
The tax identification number of the customer
The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone
The custom website URL of the customer
The zipcode of the customer's billing address
The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized.
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.
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.
The grace period, expressed in days, for the invoice. This period refers to the additional time granted to the customer beyond the invoice due date to adjust usage and line items
The payment provider utilized to initiate payments for invoices issued by Lago.
Accepted values: stripe, adyen, gocardless or null. This field is required if you intend to assign a provider_customer_id.
Unique code used to identify a payment provider connection.
The customer ID within the payment provider's system. If this field is not provided, Lago has the option to create a new customer record within the payment provider's system on behalf of the customer
Set this field to true if you want to create the customer in the payment provider synchronously with the customer creation process in Lago. This option is applicable only when the provider_customer_id is null and the customer is automatically created in the payment provider through Lago. By default, the value is set to false
Set this field to true if you want to create a customer record in the payment provider's system. This option is applicable only when the provider_customer_id is null and the sync_with_provider field is set to true. By default, the value is set to false
The document locale, specified in the ISO 639-1 format. This field represents the language or locale used for the documents issued by Lago
Specifies the available payment methods that can be used for this customer when payment_provider is set to stripe. The provider_payment_methods field is an array that allows multiple payment options to be defined. If this field is not explicitly set, the payment methods will be set to card. For now, possible values are card, sepa_debit, us_bank_account, bacs_debit and link. Note that when link is selected, card should also be provided in the array.
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.
The first line of the billing address
The second line of the billing address
The city of the customer's billing address
Country code of the customer's billing address. Format must be ISO 3166 (alpha-2)
The state of the customer's billing address
The zipcode of the customer's billing address
Set of key-value pairs that you can attach to a customer. This can be useful for storing additional information about the customer in a structured format
This endpoint performs an upsert operation.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Response
Was this page helpful?