The charge object

{
  "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "lago_billable_metric_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "billable_metric_code": "requests",
  "created_at": "2022-09-14T16:35:31Z",
  "charge_model": "dynamic",
  "pay_in_advance": true,
  "invoiceable": true,
  "regroup_paid_fees": "invoice",
  "prorated": false,
  "min_amount_cents": 1200,
  "properties": {
    "grouped_by": [
      "agent_name"
    ],
    "pricing_group_keys": [
      "agent_name"
    ],
    "graduated_ranges": [
      {
        "from_value": 0,
        "to_value": 10,
        "flat_amount": "10",
        "per_unit_amount": "0.5"
      }
    ],
    "graduated_percentage_ranges": [
      {
        "from_value": 0,
        "to_value": 10,
        "rate": "1",
        "flat_amount": "10"
      }
    ],
    "amount": "30",
    "free_units": 100,
    "package_size": 1000,
    "rate": "1",
    "fixed_amount": "0.5",
    "free_units_per_events": 5,
    "free_units_per_total_aggregation": "500",
    "per_transaction_max_amount": "3.75",
    "per_transaction_min_amount": "1.75",
    "volume_ranges": [
      {
        "from_value": 0,
        "to_value": 10,
        "flat_amount": "10",
        "per_unit_amount": "0.5"
      }
    ]
  },
  "filters": [
    {
      "invoice_display_name": "AWS",
      "properties": {
        "grouped_by": [
          "agent_name"
        ],
        "pricing_group_keys": [
          "agent_name"
        ],
        "graduated_ranges": [
          {
            "from_value": 0,
            "to_value": 10,
            "flat_amount": "10",
            "per_unit_amount": "0.5"
          }
        ],
        "graduated_percentage_ranges": [
          {
            "from_value": 0,
            "to_value": 10,
            "rate": "1",
            "flat_amount": "10"
          }
        ],
        "amount": "30",
        "free_units": 100,
        "package_size": 1000,
        "rate": "1",
        "fixed_amount": "0.5",
        "free_units_per_events": 5,
        "free_units_per_total_aggregation": "500",
        "per_transaction_max_amount": "3.75",
        "per_transaction_min_amount": "1.75",
        "volume_ranges": [
          {
            "from_value": 0,
            "to_value": 10,
            "flat_amount": "10",
            "per_unit_amount": "0.5"
          }
        ]
      },
      "values": {
        "region": [
          "us-east-1"
        ]
      }
    }
  ],
  "code": "api_requests_charge",
  "invoice_display_name": "Setup",
  "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"
    }
  ],
  "applied_pricing_unit": {
    "code": "unit_code",
    "conversion_rate": "0.5"
  },
  "accepts_target_wallet": false,
  "lago_parent_id": "1a901a90-1a90-1a90-1a90-1a901a901a90"
}

lago_id

string<uuid>

required

Unique identifier of charge, created by Lago.

Example:

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

lago_billable_metric_id

string<uuid>

required

Unique identifier of the billable metric created by Lago.

Example:

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

billable_metric_code

string

required

Unique code identifying a billable metric.

Example:

"requests"

created_at

string<date-time>

required

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

Example:

"2022-09-14T16:35:31Z"

charge_model

enum<string>

required

Specifies the pricing model used for the calculation of the final fee. It can be any of the following values:

Available options:

dynamic,

graduated,

graduated_percentage,

package,

percentage,

standard,

volume

pay_in_advance

boolean

required

This field determines the billing timing for this specific usage-based 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:

true

invoiceable

boolean

required

This field specifies whether the charge should be included in a proper invoice. If set to false, no invoice will be issued for this charge. You can only set it to false when pay_in_advance is true.

Example:

true

regroup_paid_fees

enum<string> | null

required

This setting can only be configured if pay_in_advance is true and invoiceable is false. This field determines whether and when the charge fee should be included in the invoice. If null, no invoice will be issued for this charge fee. If invoice, an invoice will be generated at the end of the period, consolidating all charge fees with a succeeded payment status.

Available options:

null,

invoice

Example:

"invoice"

prorated

boolean

required

Specifies whether a 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

min_amount_cents

integer

required

The minimum spending amount required for the charge, measured in cents and excluding any applicable taxes. It indicates the minimum amount that needs to be charged for each billing period.

Example:

1200

properties

object

required

List of all thresholds utilized for calculating the charge.

Show child attributes

filters

object[]

required

List of filters used to apply differentiated pricing based on additional event properties.

Show child attributes

code

string | null

Unique code identifying the charge within the plan.

Example:

"api_requests_charge"

invoice_display_name

string | null

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"

taxes

object[]

All taxes applied to the charge.

Show child attributes

applied_pricing_unit

object

The pricing unit applied to the charge.

Show child attributes

accepts_target_wallet

boolean | null

Specifies whether the charge accepts a target wallet for prepaid credits deduction.

Example:

false

lago_parent_id

string<uuid> | null

Unique identifier of the parent charge (if this is an override).

Example:

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

List all plans Create a charge

⌘I

API Reference