v1

latestOpenAPI 3.1.0AGPLv32026-07-26168262527.5 KB

billing_entities

Create a billing entity

This endpoint is used to create a new billing entity

post/billing_entities

Request body

Example request

{
  "billing_entity": {
    "code": "acme_corp",
    "name": "Acme Corp",
    "default_currency": "USD",
    "document_number_prefix": "ABC-123",
    "finalize_zero_amount_invoice": true,
    "billing_configuration": {
      "invoice_footer": "Thank you for your business",
      "document_locale": "en"
    },
    "address_line1": "5230 Penfield Ave",
    "address_line2": "Suite 100",
    "city": "Woodland Hills",
    "state": "CA",
    "country": "US",
    "zipcode": "91364",
    "email": "billing@acme.com",
    "legal_name": "Acme Corporation",
    "legal_number": "US123456789",
    "tax_identification_number": "EU123456789",
    "timezone": "America/Los_Angeles",
    "logo": "data:image/png;base64,..."
  }
}

Response

Billing entity created

lago_idstring uuid required

A unique identifier for the billing entity in the Lago application

codestring required

The unique code of the billing entity

namestring required

The name of the billing entity

default_currency'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' required

document_localestring required

The language of the documents generated for this billing entity

document_numbering'per_customer' | 'per_billing_entity' required

The type of document numbering for this billing entity:

per_customer: document numbers are unique per customer
per_billing_entity: document numbers are unique per billing entity

document_number_prefixstring nullable

The prefix used in document numbers for this billing entity

finalize_zero_amount_invoiceboolean required

Whether to finalize invoices with zero amount for this billing entity

invoice_footerstring nullable

The footer text to be displayed on invoices for this billing entity

invoice_grace_periodinteger required

The grace period (in days) for invoice finalization

subscription_invoice_issuing_date_anchor'current_period_end' | 'next_period_start'

Defines whether the issuing date follows the current billing period's end date or the next period starting date.

subscription_invoice_issuing_date_adjustment'align_with_finalization_date' | 'keep_anchor'

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.

is_defaultboolean

Whether this billing entity is the default billing entity for the organization. Default billing entity will be used as fallback in services if no billing entity is specified when billing_entity is not provided. Default billing entity is the billing entity that will be used to generate invoices if no billing entity is specified when invoice is created. is the oldest active billing entity and this flag cannot be changed

net_payment_terminteger required

The net payment term (in days) for this billing entity

address_line1string nullable

The first line of the billing address

address_line2string nullable

The second line of the billing address

citystring nullable

The city of the billing address

statestring nullable

The state of the billing address

country'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'

zipcodestring nullable

The zipcode of the billing address

emailstring email nullable

The email address of the billing entity

legal_namestring nullable

The legal name of the billing entity

legal_numberstring nullable

The legal registration number of the billing entity

tax_identification_numberstring nullable

The tax identification number of the billing entity

email_settingsstring[]

The email notification settings for this billing entity

eu_tax_managementboolean

Whether EU tax management is enabled for this billing entity

logo_urlstring uri nullable

The URL of the billing entity's logo

created_atstring date-time required

The date and time when the billing entity was created

updated_atstring date-time required

The date and time when the billing entity was last updated

Example response

{
  "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "code": "acme_corp",
  "name": "Acme Corp",
  "default_currency": "USD",
  "document_locale": "en",
  "document_numbering": "per_customer",
  "document_number_prefix": "ABC-123",
  "finalize_zero_amount_invoice": true,
  "invoice_footer": "Thank you for your business",
  "address_line1": "5230 Penfield Ave",
  "address_line2": "Suite 100",
  "city": "Woodland Hills",
  "state": "CA",
  "country": "US",
  "zipcode": "91364",
  "email": "billing@acme.com",
  "legal_name": "Acme Corporation",
  "legal_number": "US123456789",
  "tax_identification_number": "EU123456789",
  "timezone": "America/Los_Angeles",
  "logo_url": "https://getlago.com/logo.png",
  "created_at": "2022-04-29T08:59:51Z",
  "updated_at": "2022-04-29T08:59:51Z"
}