The add-on object

This object represents an add-on, a one-time fee that can be applied on one-off invoices.

The add-on object

{
  "add_on": {
    "lago_id": "b7ab2926-1de8-4428-9bcd-779314ac129b",
    "name": "Setup Fee",
    "code": "setup_fee",
    "amount_cents": 50000,
    "amount_currency": "USD",
    "description": "Implementation fee for new customers.",
    "created_at": "2022-04-29T08:59:51Z"
    "taxes": [
      {
        "lago_id": "31eedf19-b176-4666-a920-3c08d1204838",
        "name": "french_vat",
        "code": "french_vat",
        "rate": 20.0,
        "description": "",
        "applied_to_organization": false,
        "add_ons_count": 1,
        "customers_count": 0,
        "plans_count": 0,
        "charges_count": 0,
        "created_at": "2022-04-29T08:59:51Z"
      }
    ]
  }
}

Attributes

add-on · object

Hide object

lago_id · string · required

Unique identifier of the add-on, created by Lago.

name · string · required

The name of the add-on.

code · string · required

Unique code used to identify the add-on.

amount_cents · integer · required

The cost of the add-on in cents, excluding any applicable taxes, that is billed to a customer. By creating a one-off invoice, you will be able to override this value.

amount_currency · string · required

The currency of the add-on.

description · string

The description of the add-on.

created_at · string · required

The date and time when the add-on 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 add-on was initially created.

tax_codes · string[]

List of unique code used to identify the taxes.