Get event

Use when debugging a specific event (e.g. why it failed or how it was aggregated). Includes processing status and debug info.

GET /events/{id}

Get event

cURL

curl --request GET \
  --url https://us.api.flexprice.io/v1/events/{id} \
  --header 'x-api-key: <api-key>'

200

{
  "debug_tracker": {
    "customer_lookup": {
      "customer": {
        "address_city": "<string>",
        "address_country": "<string>",
        "address_line1": "<string>",
        "address_line2": "<string>",
        "address_postal_code": "<string>",
        "address_state": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "email": "<string>",
        "environment_id": "<string>",
        "external_id": "<string>",
        "id": "<string>",
        "metadata": {},
        "name": "<string>",
        "tenant_id": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>"
      },
      "error": {
        "details": {},
        "http_status_code": 123,
        "message": "<string>"
      }
    },
    "failure_point": {
      "error": {
        "details": {},
        "http_status_code": 123,
        "message": "<string>"
      }
    },
    "meter_matching": {
      "error": {
        "details": {},
        "http_status_code": 123,
        "message": "<string>"
      },
      "matched_meters": [
        {
          "event_name": "<string>",
          "meter": {
            "aggregation": {
              "expression": "<string>",
              "field": "<string>",
              "group_by": "<string>",
              "multiplier": "<string>"
            },
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "environment_id": "<string>",
            "event_name": "<string>",
            "filters": [
              {
                "key": "<string>",
                "values": [
                  "<string>"
                ]
              }
            ],
            "id": "<string>",
            "name": "<string>",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "meter_id": "<string>"
        }
      ]
    },
    "price_lookup": {
      "error": {
        "details": {},
        "http_status_code": 123,
        "message": "<string>"
      },
      "matched_prices": [
        {
          "meter_id": "<string>",
          "price": {
            "amount": "<string>",
            "billing_period_count": 123,
            "conversion_rate": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "currency": "<string>",
            "description": "<string>",
            "display_amount": "<string>",
            "display_name": "<string>",
            "display_price_unit_amount": "<string>",
            "end_date": "2023-11-07T05:31:56Z",
            "entity_id": "<string>",
            "environment_id": "<string>",
            "group_id": "<string>",
            "id": "<string>",
            "lookup_key": "<string>",
            "metadata": {},
            "meter_id": "<string>",
            "min_quantity": "<string>",
            "parent_price_id": "<string>",
            "price_unit": "<string>",
            "price_unit_amount": "<string>",
            "price_unit_id": "<string>",
            "price_unit_tiers": [
              {
                "flat_amount": "<string>",
                "unit_amount": "<string>",
                "up_to": 123
              }
            ],
            "start_date": "2023-11-07T05:31:56Z",
            "tenant_id": "<string>",
            "tiers": [
              {
                "flat_amount": "<string>",
                "unit_amount": "<string>",
                "up_to": 123
              }
            ],
            "transform_quantity": {
              "divide_by": 123
            },
            "trial_period_days": 123,
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "price_id": "<string>",
          "status": "<string>"
        }
      ]
    },
    "subscription_line_item_lookup": {
      "error": {
        "details": {},
        "http_status_code": 123,
        "message": "<string>"
      },
      "matched_line_items": [
        {
          "end_date": "2023-11-07T05:31:56Z",
          "is_active_for_event": true,
          "price_id": "<string>",
          "start_date": "2023-11-07T05:31:56Z",
          "sub_line_item_id": "<string>",
          "subscription_id": "<string>",
          "subscription_line_item": {
            "addon_association_id": "<string>",
            "billing_period_count": 123,
            "commitment_amount": "<string>",
            "commitment_overage_factor": "<string>",
            "commitment_quantity": "<string>",
            "commitment_true_up_enabled": true,
            "commitment_windowed": true,
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "currency": "<string>",
            "customer_id": "<string>",
            "display_name": "<string>",
            "end_date": "2023-11-07T05:31:56Z",
            "entity_id": "<string>",
            "environment_id": "<string>",
            "id": "<string>",
            "metadata": {},
            "meter_display_name": "<string>",
            "meter_id": "<string>",
            "plan_display_name": "<string>",
            "price": {
              "amount": "<string>",
              "billing_period_count": 123,
              "conversion_rate": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "created_by": "<string>",
              "currency": "<string>",
              "description": "<string>",
              "display_amount": "<string>",
              "display_name": "<string>",
              "display_price_unit_amount": "<string>",
              "end_date": "2023-11-07T05:31:56Z",
              "entity_id": "<string>",
              "environment_id": "<string>",
              "group_id": "<string>",
              "id": "<string>",
              "lookup_key": "<string>",
              "metadata": {},
              "meter_id": "<string>",
              "min_quantity": "<string>",
              "parent_price_id": "<string>",
              "price_unit": "<string>",
              "price_unit_amount": "<string>",
              "price_unit_id": "<string>",
              "price_unit_tiers": [
                {
                  "flat_amount": "<string>",
                  "unit_amount": "<string>",
                  "up_to": 123
                }
              ],
              "start_date": "2023-11-07T05:31:56Z",
              "tenant_id": "<string>",
              "tiers": [
                {
                  "flat_amount": "<string>",
                  "unit_amount": "<string>",
                  "up_to": 123
                }
              ],
              "transform_quantity": {
                "divide_by": 123
              },
              "trial_period_days": 123,
              "updated_at": "2023-11-07T05:31:56Z",
              "updated_by": "<string>"
            },
            "price_id": "<string>",
            "price_unit": "<string>",
            "price_unit_id": "<string>",
            "quantity": "<string>",
            "start_date": "2023-11-07T05:31:56Z",
            "subscription_id": "<string>",
            "subscription_phase_id": "<string>",
            "tenant_id": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>"
          },
          "timestamp_within_range": true
        }
      ]
    }
  },
  "event": {
    "customer_id": "<string>",
    "environment_id": "<string>",
    "event_name": "<string>",
    "external_customer_id": "<string>",
    "id": "<string>",
    "properties": {},
    "source": "<string>",
    "timestamp": "<string>"
  },
  "processed_events": [
    {
      "customer_id": "<string>",
      "feature_id": "<string>",
      "meter_id": "<string>",
      "price_id": "<string>",
      "processed_at": "2023-11-07T05:31:56Z",
      "qty_total": "<string>",
      "sub_line_item_id": "<string>",
      "subscription_id": "<string>"
    }
  ]
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id · string · required

Event ID

Response

200

application/json

OK

debug_tracker · object

Show child attributes

event · object

Show child attributes

processed_events · object[]

Show child attributes

status · enum<string>

Available options: processed, processing, failed