The fixed charge object

{
  "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "lago_add_on_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "invoice_display_name": "Setup fee",
  "add_on_code": "setup_fee",
  "created_at": "2023-06-27T19:43:42Z",
  "code": "setup_fee",
  "charge_model": "standard",
  "pay_in_advance": false,
  "prorated": false,
  "properties": {
    "amount": "30",
    "graduated_ranges": [
      {
        "from_value": 0,
        "to_value": 10,
        "flat_amount": "10",
        "per_unit_amount": "0.5"
      }
    ],
    "volume_ranges": [
      {
        "from_value": 0,
        "to_value": 10,
        "flat_amount": "10",
        "per_unit_amount": "0.5"
      }
    ]
  },
  "units": 1,
  "lago_parent_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "taxes": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "name": "TVA",
      "code": "french_standard_vat",
      "rate": 20,
      "applied_to_organization": true,
      "created_at": "2023-07-06T14:35:58Z",
      "description": "French standard VAT"
    }
  ]
}

lago_id

string<uuid>

required

Unique identifier of the fixed charge, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

lago_add_on_id

string<uuid>

required

Unique identifier of the add-on associated with this fixed charge.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

invoice_display_name

string

required

Specifies the name that will be displayed on an invoice. If no value is set for this field, the name of the actual charge will be used as the default display name.

Example:

"Setup fee"

add_on_code

string

required

Unique code used to identify the add-on.

Example:

"setup_fee"

created_at

string<date-time>

required

The date and time when the fixed charge was created. It is expressed in UTC format according to the ISO 8601 datetime standard.

Example:

"2023-06-27T19:43:42Z"

code

string

required

Unique code for the fixed charge.

Example:

"setup_fee"

charge_model

enum<string>

required

The charge model for the fixed charge. Only standard, graduated, and volume models are supported for fixed charges.

Available options:

standard,

graduated,

volume

Example:

"standard"

pay_in_advance

boolean

required

This field determines the billing timing for this fixed charge. When set to true, the charge is due and invoiced immediately. Conversely, when set to false, the charge is due and invoiced at the end of each billing period.

Example:

false

prorated

boolean

required

Specifies whether a fixed charge is prorated based on the remaining number of days in the billing period or billed fully.

If set to true, the charge is prorated based on the remaining days in the current billing period.
If set to false, the charge is billed in full.
If not defined in the request, default value is false.

Example:

false

properties

object

required

List of all thresholds utilized for calculating the fixed charge.

Show child attributes

units

number

required

The number of units for the fixed charge.

Example:

1

lago_parent_id

string<uuid> | null

Unique identifier of the parent fixed charge (for plan versions).

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

taxes

object[]

List of taxes applied to the fixed charge.

Show child attributes

List all charge filters Create a fixed charge

⌘I

API Reference