GEgetlago
billing_entities

Create a billing entity

Changed on

This endpoint is used to create a new billing entity

post/billing_entities

Request

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",
    "phone": "1-171-883-3711 x245",
    "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

Example response

{
  "billing_entity": {
    "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",
    "phone": "1-171-883-3711 x245",
    "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"
  }
}

Changes

  • 5d26657495a3Revision changes
    • breaking

      the request property / became not nullable

    • breaking

      the / request property's minLength was increased from 0 to 1

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      the // request property's maxLength was set to 600

    • warning

      the / request property's maxLength was set to 10

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new SYP enum value to the request property /

    • info

      added the new TND enum value to the request property /

    • info

      added the new payment_receipt.created enum value to the request property //

    • info

      added the new undefined enum value to the request property /

    • info

      added the required property to the response with the status