GEgetlago
organizations

Update your organization

Changed on

This endpoint is used to update your own organization's settings. The same payload is also applied to the default billing entity of your organization.

put/organizations

Request

Request body

Example request

{
  "organization": {
    "webhook_url": "https://webhook.brex.com",
    "country": "US",
    "default_currency": "USD",
    "address_line1": "100 Brex Street",
    "state": "NYC",
    "zipcode": "10000",
    "email": "brex@brex.com",
    "city": "New York",
    "document_numbering": "per_customer",
    "document_number_prefix": "ORG-1234",
    "net_payment_term": 30,
    "tax_identification_number": "US123456789",
    "timezone": "America/Los_Angeles",
    "email_settings": [
      "invoice.finalized",
      "credit_note.created"
    ],
    "billing_configuration": {
      "invoice_footer": "This is my customer footer",
      "invoice_grace_period": 3,
      "document_locale": "en"
    },
    "slug": "name1"
  }
}

Response

Successful response

Example response

{
  "organization": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "name": "Name1",
    "slug": "name1",
    "created_at": "2022-05-02T13:04:09Z",
    "webhook_url": "https://webhook.brex.com",
    "webhook_urls": [
      "https://webhook.brex.com",
      "https://webhook2.brex.com"
    ],
    "country": "US",
    "default_currency": "USD",
    "address_line1": "100 Brex Street",
    "state": "NYC",
    "zipcode": "10000",
    "email": "brex@brex.com",
    "city": "New York",
    "document_numbering": "per_customer",
    "document_number_prefix": "ORG-1234",
    "net_payment_term": 30,
    "tax_identification_number": "US123456789",
    "timezone": "America/Los_Angeles",
    "email_settings": [
      "invoice.finalized",
      "credit_note.created"
    ],
    "billing_configuration": {
      "invoice_footer": "This is my customer footer",
      "invoice_grace_period": 3,
      "document_locale": "en"
    },
    "taxes": [
      {
        "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
        "name": "TVA",
        "code": "french_standard_vat",
        "description": "French standard VAT",
        "rate": 20,
        "applied_to_organization": true,
        "applied_to_billing_entities_codes": [
          "acme_corp",
          "foo_bar"
        ],
        "created_at": "2023-07-06T14:35:58Z"
      }
    ],
    "events_store": "clickhouse"
  }
}

Changes

  • 5d26657495a3Revision changes
    • breaking

      the request property / became not nullable

    • warning

      added the new SYP enum value to the / response property for the response status

    • warning

      added the new TND enum value to the / response property for the response status

    • 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 optional property /// to the response with the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status