Skip to main content
GET
/
plans
/
{code}
/
charges
/
{charge_code}
/
filters
List all filters for a charge
curl --request GET \
  --url https://api.getlago.com/api/v1/plans/{code}/charges/{charge_code}/filters \
  --header 'Authorization: Bearer <token>'
{
  "filters": [
    {
      "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "charge_code": "api_requests_charge",
      "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"
        ]
      }
    }
  ],
  "meta": {
    "current_page": 2,
    "total_pages": 4,
    "total_count": 70,
    "next_page": 3,
    "prev_page": 1
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

code
string
required

Code of the existing plan.

Example:

"startup"

charge_code
string
required

Code of the existing charge.

Example:

"api_requests_charge"

Query Parameters

page
integer

Page number.

Example:

1

per_page
integer

Number of records per page.

Example:

20

Response

List of charge filters

filters
object[]
required
meta
object
required