> ## Documentation Index > Fetch the complete documentation index at: https://docs.getlago.com/llms.txt > Use this file to discover all available pages before exploring further. # List all invoices > This endpoint is used for retrieving all invoices. ```bash cURL theme={"dark"} LAGO_URL="https://api.getlago.com" API_KEY="__YOUR_API_KEY__" curl --location --request GET "$LAGO_URL/api/v1/invoices?page=2&per_page=20&external_customer_id=hooli_1234" \ --header "Authorization: Bearer $API_KEY" ``` ```python Python theme={"dark"} from lago_python_client.client import Client from lago_python_client.exceptions import LagoApiError client = Client(api_key='__YOUR_API_KEY__') try: client.invoices.find_all({'per_page': 2, 'page': 1}) except LagoApiError as e: repair_broken_state(e) # do something on error or raise your own exception ``` ```ruby Ruby theme={"dark"} require 'lago-ruby-client' client = Lago::Api::Client.new(api_key: '__YOUR_API_KEY__') client.invoices.get_all({ per_page: 2, page: 3 }) ``` ```js Javascript theme={"dark"} await client.invoices.findAllInvoices({ per_page: 2, page: 3 }); ``` ```go Go theme={"dark"} import "fmt" import "github.com/getlago/lago-go-client" func main() { lagoClient := lago.New(). SetApiKey("__YOUR_API_KEY__") invoiceListInput := &lago.InvoiceListInput{ PerPage: 1, Page: 1, IssuingDateFrom: "2022-01-01", IssuingDateTo: "2022-01-01", } invoiceResult, err := lagoClient.Invoice().GetList(invoiceListInput) if err != nil { // Error is *lago.Error panic(err) } // invoiceResult is *lago.InvoiceResult fmt.Println(invoiceResult) } ``` ## OpenAPI ````yaml GET /invoices openapi: 3.1.0 info: title: Lago API documentation description: >- Lago API allows your application to push customer information and metrics (events) from your application to the billing application. version: 1.45.2 license: name: AGPLv3 url: https://github.com/getlago/lago-openapi/blob/main/LICENSE contact: email: tech@getlago.com servers: - url: https://api.getlago.com/api/v1 description: US Lago cluster - url: https://api.eu.getlago.com/api/v1 description: EU Lago cluster security: - bearerAuth: [] tags: - name: activity_logs description: Everything about Activity logs externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/audit-logs/activity-logs-object - name: analytics description: Everything about Analytics - name: api_logs description: Everything about API logs externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/audit-logs/api-logs-object - name: billable_metrics description: Everything about Billable metric collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/billable-metrics/object - name: features description: Everything about Feature collection externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/entitlements/features/feature-object - name: entitlements description: Everything about Entitlement collection externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/entitlements/plan-entitlements/plan-entitlement-object - name: billing_entities description: Everything about Billing Entities externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/billing-entities/object - name: customers description: Everything about Customer collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/customers/object - name: plans description: Everything about Plan collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/plans/object - name: subscriptions description: Everything about Subscription collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/subscriptions/subscription-object - name: events description: Everything about Event collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/events/event-object - name: organizations description: Everything about Organization collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/organizations/organization-object - name: taxes description: Everything about Tax collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/taxes/tax-object - name: coupons description: Everything about Coupon collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/coupons/coupon-object - name: add_ons description: Everything about Add-on collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/add-ons/add-on-object - name: fees description: Everything about Fees externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/invoices/invoice-object#fee-object - name: invoices description: Everything about Invoice collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/invoices/invoice-object - name: wallets description: Everything about Wallet collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/wallets/wallet-object - name: credit_notes description: Everything about Credit notes collection externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/credit-notes/credit-note-object - name: webhooks description: Everything about Webhooks externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/webhooks/format---signature#1-retrieve-the-public-key - name: webhook_endpoints description: Everything about Webhook Endpoints externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/webhook-endpoints/webhook-endpoint-object - name: payment_receipts description: Everything about Payment receipts externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/payment-receipts/payment-receipt-object - name: payment_requests description: Everything about PaymentRequests externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/payment-requests/payment-request-object - name: payments description: Everything about Payments externalDocs: description: Find out more url: https://getlago.com/docs/api-reference/payments/payment-object - name: payment_methods description: Everything about Payment Methods externalDocs: description: Find out more url: >- https://getlago.com/docs/api-reference/payment-methods/payment-method-object externalDocs: description: Lago Github url: https://github.com/getlago paths: /invoices: get: tags: - invoices summary: List all invoices description: This endpoint is used for retrieving all invoices. operationId: findAllInvoices parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per_page' - $ref: '#/components/parameters/external_customer_id' - name: amount_from in: query description: >- Filter invoices of at least a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types. required: false explode: true schema: type: integer example: 9000 - name: amount_to in: query description: >- Filter invoices up to a specific amount. This parameter must be defined in cents to ensure consistent handling for all currency types. required: false explode: true schema: type: integer example: 100000 - name: issuing_date_from in: query description: Filter invoices starting from a specific date. required: false explode: true schema: type: string format: date example: '2022-07-08' - name: issuing_date_to in: query description: Filter invoices up to a specific date. required: false explode: true schema: type: string format: date example: '2022-08-09' - name: statuses[] in: query description: >- Filter invoices by statuses. Possible values are `draft`, `failed`, `finalized`, `pending` and `voided`. required: false explode: true schema: type: array items: type: string enum: - draft - finalized - failed - pending - voided - name: payment_statuses[] in: query description: >- Filter invoices by payment statuses. Possible values are `pending`, `failed` or `succeeded`. required: false explode: true schema: type: array items: type: string enum: - pending - failed - succeeded - name: payment_overdue in: query description: >- Filter invoices by payment_overdue. Possible values are `true` or `false`. required: false explode: true schema: type: boolean example: true - name: search_term in: query description: >- Search invoices by id, number, customer name, customer external_id or customer email. required: false explode: true schema: type: string example: Jane - name: currency in: query description: >- Filter invoices by currency. Possible values ISO 4217 currency codes. required: false explode: true schema: type: string example: EUR - name: payment_dispute_lost in: query description: >- Filter invoices with a payment dispute lost. Possible values are `true` or `false`. required: false explode: true schema: type: boolean example: true - name: invoice_type in: query description: >- Filter invoices by invoice type. Possible values are `subscription`, `add_on`, `credit`, `one_off`, `advance_charges` or `progressive_billing`. required: false explode: true schema: type: string enum: - subscription - add_on - credit - one_off - advance_charges - progressive_billing - name: self_billed in: query description: >- Filter invoices by self billed. Possible values are `true` or `false`. required: false explode: true schema: type: boolean example: true - name: billing_entity_codes[] in: query description: >- Filter invoices by billing entity codes. Possible values are the billing entity codes you have created. required: false explode: true schema: type: array items: type: string example: - acme_corp - foo_bar - name: metadata[key] in: query description: >- Filter invoices by metadata. Replace `key` with the actual metadata key you want to match, and provide the corresponding value. Providing empty value will search for invoice without given metadata key. For example, `metadata[color]=blue`. required: false explode: true schema: type: string example: someValue responses: '200': description: Invoices content: application/json: schema: $ref: '#/components/schemas/InvoicesPaginated' '401': $ref: '#/components/responses/Unauthorized' components: parameters: page: name: page in: query description: Page number. required: false explode: true schema: type: integer example: 1 per_page: name: per_page in: query description: Number of records per page. required: false explode: true schema: type: integer example: 20 external_customer_id: name: external_customer_id in: query description: Unique identifier assigned to the customer in your application. required: false explode: true schema: type: string example: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba schemas: InvoicesPaginated: type: object required: - invoices - meta properties: invoices: type: array items: $ref: '#/components/schemas/InvoiceObject' meta: $ref: '#/components/schemas/PaginationMeta' InvoiceObject: allOf: - $ref: '#/components/schemas/InvoiceBaseObject' - type: object properties: customer: $ref: '#/components/schemas/CustomerObject' description: >- The customer on which the invoice applies. It refers to the customer account or entity associated with the invoice. billing_periods: type: array items: $ref: '#/components/schemas/BillingPeriodObject' metadata: type: array items: $ref: '#/components/schemas/InvoiceMetadataObject' applied_taxes: type: array items: $ref: '#/components/schemas/InvoiceAppliedTaxObject' applied_invoice_custom_sections: description: >- The invoice custom sections applied to this invoice for PDF generation. type: array items: $ref: '#/components/schemas/InvoiceAppliedInvoiceCustomSectionObject' applied_usage_thresholds: type: array items: $ref: '#/components/schemas/AppliedUsageThresholdObject' PaginationMeta: type: object required: - current_page - total_pages - total_count properties: current_page: type: integer description: Current page. example: 2 next_page: type: - integer - 'null' description: Next page. example: 3 prev_page: type: - integer - 'null' description: Previous page. example: 1 total_pages: type: integer description: Total number of pages. example: 4 total_count: type: integer description: Total number of records. example: 70 ApiErrorUnauthorized: type: object required: - status - error properties: status: type: integer format: int32 example: 401 error: type: string example: Unauthorized InvoiceBaseObject: type: object required: - lago_id - billing_entity_code - number - issuing_date - invoice_type - status - payment_status - currency - fees_amount_cents - coupons_amount_cents - credit_notes_amount_cents - sub_total_excluding_taxes_amount_cents - taxes_amount_cents - sub_total_including_taxes_amount_cents - prepaid_credit_amount_cents - progressive_billing_credit_amount_cents - total_amount_cents - version_number - created_at - updated_at properties: lago_id: type: string format: uuid description: >- Unique identifier assigned to the fee within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the fee's record within the Lago system. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 billing_entity_code: type: - string - 'null' example: acme_corp description: The unique code of the billing entity associated with the invoice sequential_id: type: integer description: >- This ID helps in uniquely identifying and organizing the invoices associated with a specific customer. It provides a sequential numbering system specific to the customer, allowing for easy tracking and management of invoices within the customer's context. example: 2 number: type: string description: >- The unique number assigned to the invoice. This number serves as a distinct identifier for the invoice and helps in differentiating it from other invoices in the system. example: LAG-1234-001-002 issuing_date: type: string format: date description: >- The date when the invoice was issued. It is provided in the ISO 8601 date format. example: '2022-04-30' payment_dispute_lost_at: type: string format: date-time description: >- The date when the payment dispute was lost. It is expressed in Coordinated Universal Time (UTC). example: '2022-09-14T16:35:31Z' payment_due_date: type: string format: date description: >- The payment due date for the invoice, specified in the ISO 8601 date format. example: '2022-04-30' payment_overdue: type: boolean description: Specifies if the payment is considered as overdue. example: true net_payment_term: type: integer example: 30 description: >- The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized. invoice_type: type: string enum: - subscription - add_on - credit - one_off - progressive_billing description: >- The type of invoice issued. Possible values are `subscription`, `one-off`, `credit` or `progressive_billing`. example: subscription status: type: string enum: - draft - finalized - voided - failed - pending description: >- The status of the invoice. It indicates the current state of the invoice and can have following values: - `draft`: the invoice is in the draft state, waiting for the end of the grace period to be finalized. During this period, events can still be ingested and added to the invoice. - `finalized`: the invoice has been issued and finalized. In this state, events cannot be ingested or added to the invoice anymore. - `voided`: the invoice has been issued and subsequently voided. In this state, events cannot be ingested or added to the invoice anymore. - `pending`: the invoice remains pending until the taxes are fetched from the external provider. - `failed`: during an attempt of finalization of the invoice, an error happened. This invoice will have an array of error_details, explaining, in which part of the system an error happened and how it's possible to fix it. This invoice can't be edited or updated, only retried. This action will discard current error_details and will create new ones if the finalization failed again. example: finalized payment_status: type: string enum: - pending - succeeded - failed description: >- The status of the payment associated with the invoice. It can have one of the following values: - `pending`: the payment is pending, waiting for payment processing in Stripe or when the invoice is emitted but users have not updated the payment status through the endpoint. - `succeeded`: the payment of the invoice has been successfully processed. - `failed`: the payment of the invoice has failed or encountered an error during processing. example: succeeded currency: $ref: '#/components/schemas/Currency' description: The currency of the invoice issued. example: EUR fees_amount_cents: type: integer description: >- The total sum of fees amount in cents. It calculates the cumulative amount of all the fees associated with the invoice, providing a consolidated value. example: 100 coupons_amount_cents: type: integer description: >- The total sum of all coupons discounted on the invoice. It calculates the cumulative discount amount applied by coupons, expressed in cents. example: 10 credit_notes_amount_cents: type: integer description: >- The total sum of all credit notes discounted on the invoice. It calculates the cumulative discount amount applied by credit notes, expressed in cents. example: 10 sub_total_excluding_taxes_amount_cents: type: integer description: >- Subtotal amount, excluding taxes, expressed in cents. This field depends on the version number. Here are the definitions based on the version: - Version 1: is equal to the sum of `fees_amount_cents`, minus `coupons_amount_cents`, and minus `prepaid_credit_amount_cents`. - Version 2: is equal to the `fees_amount_cents`. - Version 3 & 4: is equal to the `fees_amount_cents`, minus `coupons_amount_cents` example: 100 taxes_amount_cents: type: integer description: >- The sum of tax amount associated with the invoice, expressed in cents. example: 20 sub_total_including_taxes_amount_cents: type: integer description: >- Subtotal amount, including taxes, expressed in cents. This field depends on the version number. Here are the definitions based on the version: - Version 1: is equal to the `total_amount_cents`. - Version 2: is equal to the sum of `fees_amount_cents` and `taxes_amount_cents`. - Version 3 & 4: is equal to the sum `sub_total_excluding_taxes_amount_cents` and `taxes_amount_cents` example: 120 prepaid_credit_amount_cents: type: integer description: >- The total sum of all prepaid credits discounted on the invoice. It calculates the cumulative discount amount applied by prepaid credits, expressed in cents. example: 0 prepaid_granted_credit_amount_cents: type: - integer - 'null' description: >- The portion of prepaid credits discounted on the invoice that originated from granted (free) credits, expressed in cents. Only populated for invoices associated with traceable wallets. example: 0 prepaid_purchased_credit_amount_cents: type: - integer - 'null' description: >- The portion of prepaid credits discounted on the invoice that originated from purchased (paid) credits, expressed in cents. Only populated for invoices associated with traceable wallets. example: 0 progressive_billing_credit_amount_cents: type: integer description: >- The usage already billed in previous invoices. Only apply to `progressive_billing` and `subscription` invoices. example: 0 total_amount_cents: type: integer description: >- The sum of the amount and taxes amount on the invoice, expressed in cents. It calculates the total financial value of the invoice, including both the original amount and any applicable taxes. example: 100 version_number: type: integer example: 3 self_billed: type: boolean example: false description: >- Indicates if the invoice is self-billed. Self-billing is a process where an organization creates the invoice on behalf of the partner. This field specifies whether the invoice is self-billed or not. file_url: type: string format: uri description: >- Contains the URL that provides direct access to the invoice PDF file. You can use this URL to download or view the PDF document of the invoice example: https://getlago.com/invoice/file created_at: type: string format: date-time example: '2022-04-29T08:59:51Z' description: >- The date of the invoice 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 invoice object was created updated_at: type: string format: date-time example: '2022-04-29T08:59:51Z' description: >- The date of the invoice update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the invoice object was updated CustomerObject: allOf: - $ref: '#/components/schemas/CustomerBaseObject' - type: object properties: integration_customers: type: array items: $ref: '#/components/schemas/IntegrationCustomer' BillingPeriodObject: type: object required: - lago_subscription_id - external_subscription_id - lago_plan_id - subscription_from_datetime - subscription_to_datetime - charges_from_datetime - charges_to_datetime - invoicing_reason properties: lago_subscription_id: type: string format: uuid description: Unique identifier assigned to the subscription, created by Lago. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 external_subscription_id: type: string description: Unique identifier assigned to the subscription in your application. example: external_id lago_plan_id: type: string format: uuid description: Unique identifier assigned to the plan, created by Lago. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 subscription_from_datetime: type: string format: date-time description: >- The beginning date of the subscription billing period. This field indicates the start date of the billing period associated with the subscription fee. example: '2022-04-29T08:59:51Z' subscription_to_datetime: type: string format: date-time description: >- The ending date of the subscription billing period. This field indicates the end date of the billing period associated with the subscription fee. example: '2022-05-29T08:59:51Z' charges_from_datetime: type: string format: date-time description: >- The beginning date of the period that covers the charge fees. It is applicable only to the `charge` fees attached to the subscription. This field indicates the start date of the billing period or subscription period associated with the fees. example: '2022-04-29T08:59:51Z' charges_to_datetime: type: string format: date-time description: >- The ending date of the period that covers the charge fees. It is applicable only to the `charge` fees attached to the subscription. This field indicates the end date of the billing period or subscription period associated with the fees. example: '2022-05-29T08:59:51Z' invoicing_reason: type: string enum: - subscription_starting - subscription_periodic - subscription_terminating - in_advance_charge - in_advance_charge_periodic - progressive_billing description: The reason explaining why this subscription appears on the invoice. example: subscription_starting InvoiceMetadataObject: type: object properties: lago_id: type: string format: uuid description: >- Unique identifier assigned to the invoice metadata within the Lago application. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 key: type: string description: Represents the key of the metadata's key-value pair. example: digital_ref_id value: type: string description: Represents the value of the metadata's key-value pair. example: INV-0123456-98765 created_at: type: string format: date-time description: >- The date and time when the metadata object was created. It follows the ISO 8601 datetime format and is expressed in Coordinated Universal Time (UTC). example: '2022-04-29T08:59:51Z' InvoiceAppliedTaxObject: allOf: - $ref: '#/components/schemas/BaseAppliedTax' type: object properties: lago_invoice_id: type: string format: uuid description: Unique identifier of the invoice, created by Lago. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 fees_amount_cents: type: integer description: Fees total amount on which the tax is applied example: 20000 InvoiceAppliedInvoiceCustomSectionObject: type: object required: - lago_id - lago_invoice_id - code - details - display_name - created_at properties: lago_id: type: string format: uuid description: >- Unique identifier of the applied invoice custom section in the Lago application. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 lago_invoice_id: type: string format: uuid description: Unique identifier of the invoice this custom section is applied to. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 code: type: string description: Unique code identifying the invoice custom section. example: eu_bank_details details: type: string description: The value shown on the invoice PDF. example: 'Bank Name: Lago Bank, IBAN: FR7630004000031234567890143' display_name: type: string description: The name of the invoice custom section displayed on the invoice. example: 'Bank Details:' created_at: type: string format: date-time description: >- The date of the applied invoice custom section creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). example: '2023-07-06T14:35:58Z' AppliedUsageThresholdObject: type: object required: - lifetime_usage_amount_cents - created_at - usage_threshold properties: lifetime_usage_amount_cents: type: integer description: >- The amount of usage in cents that has been accumulated over the lifetime of the subscription. example: 2000 created_at: type: string format: date-time description: >- The date and time when the lifetime usage was computed. It is expressed in UTC format according to the ISO 8601 datetime standard. example: '2025-03-31T12:31:44Z' usage_threshold: $ref: '#/components/schemas/UsageThresholdObject' Currency: type: string example: USD enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BIF - BMD - BND - BOB - BRL - BSD - BWP - BYN - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - ISK - JMD - JPY - KES - KGS - KHR - KMF - KRW - KYD - KZT - LAK - LBP - LKR - LRD - LSL - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLL - SOS - SRD - STD - SZL - THB - TJS - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW CustomerBaseObject: type: object required: - lago_id - sequential_id - slug - external_id - applicable_timezone - created_at properties: lago_id: type: string format: uuid example: 1a901a90-1a90-1a90-1a90-1a901a901a90 description: >- 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: type: integer example: 1 description: >- 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: type: string example: LAG-1234-001 description: >- A concise and unique identifier for the customer, formed by combining the Organization's `name`, `id`, and customer's `sequential_id` external_id: type: string description: >- The customer external unique identifier (provided by your own application) example: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba billing_entity_code: type: string example: acme_corp description: The unique code of the billing entity associated with the customer. address_line1: type: - string - 'null' example: 5230 Penfield Ave description: The first line of the billing address address_line2: type: - string - 'null' example: null description: The second line of the billing address applicable_timezone: $ref: '#/components/schemas/Timezone' description: >- The customer's applicable timezone, used for billing purposes in their local time. city: type: - string - 'null' example: Woodland Hills description: The city of the customer's billing address country: $ref: '#/components/schemas/CountryOrNull' description: >- Country code of the customer's billing address. Format must be ISO 3166 (alpha-2) example: US currency: $ref: '#/components/schemas/CurrencyOrNull' example: USD description: Currency of the customer. Format must be ISO 4217 email: type: - string - 'null' format: email example: dinesh@piedpiper.test description: The email of the customer legal_name: type: - string - 'null' example: Coleman-Blair description: The legal company name of the customer legal_number: type: - string - 'null' example: 49-008-2965 description: The legal company number of the customer logo_url: type: - string - 'null' example: http://hooli.com/logo.png description: The logo URL of the customer name: type: - string - 'null' example: Gavin Belson description: The full name of the customer firstname: type: - string - 'null' example: Gavin description: First name of the customer lastname: type: - string - 'null' example: Belson description: Last name of the customer account_type: type: string enum: - customer - partner example: customer description: |- The type of the account. It can have one of the following values: - `customer`: the account is a customer. - `partner`: the account is a partner. customer_type: type: - string - 'null' enum: - company - individual - null description: |- 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. phone: type: - string - 'null' example: 1-171-883-3711 x245 description: The phone number of the customer state: type: - string - 'null' example: CA description: The state of the customer's billing address tax_identification_number: type: - string - 'null' example: EU123456789 description: The tax identification number of the customer timezone: $ref: '#/components/schemas/TimezoneOrNull' description: >- The customer's timezone, used for billing purposes in their local time. Overrides the organization's timezone url: type: - string - 'null' example: http://hooli.com description: The custom website URL of the customer zipcode: type: - string - 'null' example: '91364' description: The zipcode of the customer's billing address net_payment_term: type: - integer - 'null' example: 30 description: >- The net payment term, expressed in days, specifies the duration within which a customer is expected to remit payment after the invoice is finalized. created_at: type: string format: date-time example: '2022-04-29T08:59:51Z' description: >- 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 updated_at: type: string format: date-time example: '2022-04-29T08:59:51Z' description: >- The date of the customer update, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). The update_date provides a standardized and internationally recognized timestamp for when the customer object was updated finalize_zero_amount_invoice: type: string enum: - inherit - skip - finalize example: inherit description: >- 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. skip_invoice_custom_sections: type: boolean example: false description: >- Set to true to exclude all invoice custom sections from PDF generation for this customer only. billing_configuration: $ref: '#/components/schemas/CustomerBillingConfiguration' shipping_address: $ref: '#/components/schemas/Address' metadata: type: array items: $ref: '#/components/schemas/CustomerMetadata' IntegrationCustomer: type: object required: - lago_id - type - external_customer_id - integration_code description: >- Configuration specific to the accounting and tax integrations. This object contains settings and parameters necessary for syncing documents and payments. properties: lago_id: type: string format: uuid example: 1a901a90-1a90-1a90-1a90-1a901a901a90 description: >- A unique identifier for the integration customer object in the Lago application. type: type: string example: netsuite description: |- The integration type used for accounting and tax syncs. Accepted values: `netsuite, anrok`. enum: - netsuite - anrok - xero - hubspot - salesforce integration_code: type: string example: netsuite-eu-1 description: Unique code used to identify an integration connection. external_customer_id: type: string example: cus_12345 description: >- The customer ID within the integration's system. If this field is not provided, Lago has the option to create a new customer record within the integration's system on behalf of the customer. sync_with_provider: type: - boolean - 'null' example: true description: >- Set this field to `true` if you want to create a customer record in the integration's system. This option is applicable only when the `external_customer_id` is null and the `sync_with_provider` field is set to `true`. By default, the value is set to `false` subsidiary_id: type: string example: '2' description: >- This optional field is needed only when working with `netsuite` connection. targeted_object: type: - string - 'null' example: contacts description: >- This optional field is present only when working with `hubspot` connection. email: type: - string - 'null' example: dinesh@piedpiper.test description: >- This optional field is present only when working with `hubspot` connection. BaseAppliedTax: type: object required: - lago_id - lago_tax_id - tax_name - tax_code - tax_rate - tax_description - amount_cents - amount_currency - created_at properties: lago_id: type: string format: uuid description: Unique identifier of the applied tax, created by Lago. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 lago_tax_id: type: - string - 'null' format: uuid description: Unique identifier of the tax, created by Lago. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 tax_name: type: string description: Name of the tax. example: TVA tax_code: type: string description: >- Unique code used to identify the tax associated with the API request. example: french_standard_vat tax_rate: type: number description: The percentage rate of the tax example: 20 tax_description: type: - string - 'null' description: Internal description of the tax example: French standard VAT amount_cents: type: integer description: Amount of the tax example: 2000 amount_currency: $ref: '#/components/schemas/Currency' description: Currency of the tax example: USD created_at: type: string format: date-time description: >- The date and time when the applied tax was created. It is expressed in UTC format according to the ISO 8601 datetime standard. This field provides the timestamp for the exact moment when the applied tax was initially created. example: '2022-09-14T16:35:31Z' UsageThresholdObject: type: object required: - lago_id - threshold_display_name - amount_cents - recurring - created_at - updated_at properties: lago_id: type: string format: uuid description: Unique identifier of the usage threshold created by Lago. example: 1a901a90-1a90-1a90-1a90-1a901a901a90 threshold_display_name: type: - string - 'null' description: The display name of the usage threshold. example: Threshold 1 amount_cents: type: integer description: The amount to reach to trigger a `progressive_billing` invoice. example: 10000 recurring: type: boolean description: >- This field when set to `true` indicates that a `progressive_billing` invoice will be created every time the lifetime usage increases by the specified amount. example: true created_at: type: string format: date-time description: >- The date and time when the usage threshold was created. It is expressed in UTC format according to the ISO 8601 datetime standard. example: '2023-06-27T19:43:42Z' updated_at: type: string format: date-time description: >- The date and time when the usage threshold was last updated. It is expressed in UTC format according to the ISO 8601 datetime standard. example: '2023-06-27T19:43:42Z' Timezone: type: string example: America/Los_Angeles enum: - UTC - Africa/Algiers - Africa/Cairo - Africa/Casablanca - Africa/Harare - Africa/Johannesburg - Africa/Monrovia - Africa/Nairobi - America/Argentina/Buenos_Aires - America/Bogota - America/Caracas - America/Chicago - America/Chihuahua - America/Denver - America/Guatemala - America/Guyana - America/Halifax - America/Indiana/Indianapolis - America/Juneau - America/La_Paz - America/Lima - America/Los_Angeles - America/Mazatlan - America/Mexico_City - America/Monterrey - America/Montevideo - America/New_York - America/Nuuk - America/Phoenix - America/Puerto_Rico - America/Regina - America/Santiago - America/Sao_Paulo - America/St_Johns - America/Tijuana - Asia/Almaty - Asia/Baghdad - Asia/Baku - Asia/Bangkok - Asia/Chongqing - Asia/Colombo - Asia/Dhaka - Asia/Hong_Kong - Asia/Irkutsk - Asia/Jakarta - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuwait - Asia/Magadan - Asia/Muscat - Asia/Novosibirsk - Asia/Riyadh - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tokyo - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Cape_Verde - Atlantic/South_Georgia - Australia/Adelaide - Australia/Brisbane - Australia/Darwin - Australia/Hobart - Australia/Melbourne - Australia/Perth - Australia/Sydney - Europe/Amsterdam - Europe/Athens - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Copenhagen - Europe/Dublin - Europe/Helsinki - Europe/Istanbul - Europe/Kaliningrad - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Madrid - Europe/Minsk - Europe/Moscow - Europe/Paris - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/Sarajevo - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zurich - GMT+12 - Pacific/Apia - Pacific/Auckland - Pacific/Chatham - Pacific/Fakaofo - Pacific/Fiji - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Majuro - Pacific/Midway - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Port_Moresby - Pacific/Tongatapu CountryOrNull: type: - string - 'null' example: US enum: - null - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW CurrencyOrNull: type: - string - 'null' example: USD enum: - null - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BIF - BMD - BND - BOB - BRL - BSD - BWP - BYN - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ETB - EUR - FJD - FKP - GBP - GEL - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - ISK - JMD - JPY - KES - KGS - KHR - KMF - KRW - KYD - KZT - LAK - LBP - LKR - LRD - LSL - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRO - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SEK - SGD - SHP - SLL - SOS - SRD - STD - SZL - THB - TJS - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW TimezoneOrNull: type: - string - 'null' example: America/Los_Angeles enum: - null - UTC - Africa/Algiers - Africa/Cairo - Africa/Casablanca - Africa/Harare - Africa/Johannesburg - Africa/Monrovia - Africa/Nairobi - America/Argentina/Buenos_Aires - America/Bogota - America/Caracas - America/Chicago - America/Chihuahua - America/Denver - America/Godthab - America/Guatemala - America/Guyana - America/Halifax - America/Indiana/Indianapolis - America/Juneau - America/La_Paz - America/Lima - America/Los_Angeles - America/Mazatlan - America/Mexico_City - America/Monterrey - America/Montevideo - America/New_York - America/Phoenix - America/Puerto_Rico - America/Regina - America/Santiago - America/Sao_Paulo - America/St_Johns - America/Tijuana - Asia/Almaty - Asia/Baghdad - Asia/Baku - Asia/Bangkok - Asia/Chongqing - Asia/Colombo - Asia/Dhaka - Asia/Hong_Kong - Asia/Irkutsk - Asia/Jakarta - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuwait - Asia/Magadan - Asia/Muscat - Asia/Novosibirsk - Asia/Rangoon - Asia/Riyadh - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Tokyo - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Vladivostok - Asia/Yakutsk - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Cape_Verde - Atlantic/South_Georgia - Australia/Adelaide - Australia/Brisbane - Australia/Darwin - Australia/Hobart - Australia/Melbourne - Australia/Perth - Australia/Sydney - Europe/Amsterdam - Europe/Athens - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Copenhagen - Europe/Dublin - Europe/Helsinki - Europe/Istanbul - Europe/Kaliningrad - Europe/Kiev - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Madrid - Europe/Minsk - Europe/Moscow - Europe/Paris - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/Sarajevo - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zurich - GMT+12 - Pacific/Apia - Pacific/Auckland - Pacific/Chatham - Pacific/Fakaofo - Pacific/Fiji - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Majuro - Pacific/Midway - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Port_Moresby - Pacific/Tongatapu CustomerBillingConfiguration: type: object description: >- 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. properties: invoice_grace_period: type: integer example: 3 description: >- 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 subscription_invoice_issuing_date_anchor: type: - string - 'null' example: next_period_start description: >- Defines whether the issuing date follows the current billing period's end date or the next period starting date. enum: - current_period_end - next_period_start - null default: null subscription_invoice_issuing_date_adjustment: type: - string - 'null' example: keep_anchor description: >- The logic applied on top of the subscription_invoice_issuing_date_anchor rule. You can opt to use the invoice finalization date, that includes any configured grace period. enum: - align_with_finalization_date - keep_anchor - null default: null payment_provider: type: string example: stripe description: >- 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`. enum: - stripe - adyen - gocardless payment_provider_code: type: string example: stripe-eu-1 description: Unique code used to identify a payment provider connection. provider_customer_id: type: string example: cus_12345 description: >- 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 sync: type: boolean example: true description: >- 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` sync_with_provider: type: boolean example: true description: >- 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` document_locale: type: string example: fr description: >- The document locale, specified in the ISO 639-1 format. This field represents the language or locale used for the documents issued by Lago provider_payment_methods: type: - array - 'null' items: type: string description: >- 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`, `boleto`, `link`, `crypto` and `customer_balance`. Note that when `link` is selected, `card` should also be provided in the array. When `customer_balance` is selected, no other payment can be selected. example: - card - sepa_debit - us_bank_account - bacs_debit - link - boleto - crypto - customer_balance Address: type: object description: >- 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. properties: address_line1: type: - string - 'null' example: 5230 Penfield Ave description: The first line of the billing address address_line2: type: - string - 'null' example: null description: The second line of the billing address city: type: - string - 'null' example: Woodland Hills description: The city of the customer's billing address country: $ref: '#/components/schemas/CountryOrNull' description: >- Country code of the customer's billing address. Format must be ISO 3166 (alpha-2) example: US state: type: - string - 'null' example: CA description: The state of the customer's billing address zipcode: type: - string - 'null' example: '91364' description: The zipcode of the customer's billing address CustomerMetadata: type: object description: >- 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 required: - lago_id - key - value - display_in_invoice - created_at properties: lago_id: type: string format: uuid example: 1a901a90-1a90-1a90-1a90-1a901a901a90 description: >- A unique identifier for the customer metadata object in the Lago application. Can be used to update a key-value pair key: type: string example: Purchase Order description: The metadata object key value: type: string example: '123456789' description: The metadata object value display_in_invoice: type: boolean example: true description: >- Determines whether the item or information should be displayed in the invoice. If set to true, the item or information will be included and visible in the generated invoice. If set to false, the item or information will be excluded and not displayed in the invoice. created_at: type: string format: date-time example: '2022-04-29T08:59:51Z' description: >- The date of the metadata object 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 metadata object was created responses: Unauthorized: description: Unauthorized error content: application/json: schema: $ref: '#/components/schemas/ApiErrorUnauthorized' securitySchemes: bearerAuth: type: http scheme: bearer ````