The charge filter object

{
  "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"
    ]
  }
}

Values used to apply differentiated pricing based on additional event properties.

invoice_display_name

string | null

required

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

Example:

"AWS"

properties

object

required

List of all thresholds utilized for calculating the charge.

Show child attributes

values

object

required

List of possible filter values. The key and values must match one of the billable metric filters.

Show child attributes

Example:

{ "region": ["us-east-1"] }

List all charges Create a charge filter

⌘I

API Reference