cURL
curl --request GET \
--url https://us.api.flexprice.io/v1/events/lookup \
--header 'x-api-key: <api-key>'from flexprice import Flexprice
with Flexprice(
api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:
res = f_client.events.get_event(id="<id>", external_customer_id="<id>")
# Handle response
print(res)import { Flexprice } from "@flexprice/sdk";
const flexprice = new Flexprice({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await flexprice.events.getEvent("<id>", "<id>");
console.log(result);
}
run();package main
import(
"context"
flexprice "github.com/flexprice/go-sdk/v2"
"log"
)
func main() {
ctx := context.Background()
s := flexprice.New(
flexprice.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Events.GetEvent(ctx, "<id>", "<id>", nil, nil)
if err != nil {
log.Fatal(err)
}
if res.GetEventByIDResponse != nil {
// handle response
}
}{
"debug_tracker": {
"attributed_to_customer": {
"error": {
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
},
"meter_usage": {
"external_customer_id": "<string>",
"meter_id": "<string>",
"qty_total": "<string>"
},
"status": "unprocessed"
},
"customer_lookup": {
"customer": {
"address_city": "<string>",
"address_country": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"address_postal_code": "<string>",
"address_state": "<string>",
"billing_currency": "<string>",
"contact": "<string>",
"contact_persons": [
{
"first_name": "<string>",
"department": "<string>",
"designation": "<string>",
"email": "<string>",
"id": "<string>",
"is_primary": true,
"last_name": "<string>",
"mobile": "<string>",
"salutation": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"email": "<string>",
"environment_id": "<string>",
"external_id": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"status": "published",
"tax_treatment": "taxable",
"tenant_id": "<string>",
"timezone": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"error": {
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
},
"status": "unprocessed"
},
"failure_point": {
"error": {
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
},
"failure_point_type": "customer_lookup"
},
"meter_matching": {
"error": {
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
},
"matched_meters": [
{
"event_name": "<string>",
"meter": {
"aggregation": {
"bucket_size": "MINUTE",
"expression": "<string>",
"field": "<string>",
"group_by": "<string>",
"multiplier": "<string>",
"type": "COUNT"
},
"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>",
"reset_usage": "BILLING_PERIOD",
"status": "published",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"meter_id": "<string>"
}
],
"status": "unprocessed"
},
"price_lookup": {
"error": {
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
},
"matched_prices": [
{
"meter_id": "<string>",
"price": {
"amount": "<string>",
"billing_cadence": "RECURRING",
"billing_model": "FLAT_FEE",
"billing_period": "MONTHLY",
"billing_period_count": 123,
"bucket_size": "MINUTE",
"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>",
"entity_type": "PLAN",
"environment_id": "<string>",
"group_id": "<string>",
"id": "<string>",
"invoice_cadence": "ARREAR",
"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
}
],
"price_unit_type": "FIAT",
"sequence": 123,
"start_date": "2023-11-07T05:31:56Z",
"status": "published",
"tenant_id": "<string>",
"tier_mode": "VOLUME",
"tiers": [
{
"flat_amount": "<string>",
"unit_amount": "<string>",
"up_to": 123
}
],
"transform_quantity": {
"divide_by": 123,
"round": "up"
},
"trial_period_days": 123,
"type": "USAGE",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"price_id": "<string>",
"status": "<string>"
}
],
"status": "unprocessed"
},
"subscription_line_item_lookup": {
"error": {
"code": "http_client_error",
"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": "MONTHLY",
"billing_period_count": 123,
"commitment_amount": "<string>",
"commitment_duration": "MONTHLY",
"commitment_overage_factor": "<string>",
"commitment_quantity": "<string>",
"commitment_time_buckets": [
{
"commitment_type": "amount",
"commitment_value": "<string>",
"end": {
"hour": 12,
"minute": 29
},
"id": "<string>",
"overage_factor": 123,
"price_id": "<string>",
"start": {
"hour": 12,
"minute": 29
},
"true_up_enabled": true
}
],
"commitment_true_up_enabled": true,
"commitment_type": "amount",
"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>",
"entity_type": "plan",
"environment_id": "<string>",
"id": "<string>",
"invoice_cadence": "ARREAR",
"metadata": {},
"meter": {
"aggregation": {
"bucket_size": "MINUTE",
"expression": "<string>",
"field": "<string>",
"group_by": "<string>",
"multiplier": "<string>",
"type": "COUNT"
},
"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>",
"reset_usage": "BILLING_PERIOD",
"status": "published",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"meter_display_name": "<string>",
"meter_id": "<string>",
"plan_display_name": "<string>",
"price": {
"amount": "<string>",
"billing_cadence": "RECURRING",
"billing_model": "FLAT_FEE",
"billing_period": "MONTHLY",
"billing_period_count": 123,
"bucket_size": "MINUTE",
"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>",
"entity_type": "PLAN",
"environment_id": "<string>",
"group_id": "<string>",
"id": "<string>",
"invoice_cadence": "ARREAR",
"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
}
],
"price_unit_type": "FIAT",
"sequence": 123,
"start_date": "2023-11-07T05:31:56Z",
"status": "published",
"tenant_id": "<string>",
"tier_mode": "VOLUME",
"tiers": [
{
"flat_amount": "<string>",
"unit_amount": "<string>",
"up_to": 123
}
],
"transform_quantity": {
"divide_by": 123,
"round": "up"
},
"trial_period_days": 123,
"type": "USAGE",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"price_id": "<string>",
"price_type": "USAGE",
"price_unit": "<string>",
"price_unit_id": "<string>",
"quantity": "<string>",
"start_date": "2023-11-07T05:31:56Z",
"status": "published",
"subscription_id": "<string>",
"subscription_phase_id": "<string>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"timestamp_within_range": true
}
],
"status": "unprocessed"
}
},
"event": {
"customer_id": "<string>",
"environment_id": "<string>",
"event_name": "<string>",
"external_customer_id": "<string>",
"id": "<string>",
"ingested_at": "2023-11-07T05:31:56Z",
"properties": {},
"source": "<string>",
"timestamp": "<string>"
},
"events": [
{
"customer_id": "<string>",
"environment_id": "<string>",
"event_name": "<string>",
"external_customer_id": "<string>",
"id": "<string>",
"ingested_at": "2023-11-07T05:31:56Z",
"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>"
}
],
"status": "processed"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}Events
Get event
Use when debugging a specific event (e.g. why it failed or how it was aggregated). Reads the meter-usage pipeline; includes processing status and step-by-step debug tracker when unprocessed. Uses ?id= query param because event IDs can contain ”/”.
GET
/
events
/
lookup
cURL
curl --request GET \
--url https://us.api.flexprice.io/v1/events/lookup \
--header 'x-api-key: <api-key>'from flexprice import Flexprice
with Flexprice(
api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:
res = f_client.events.get_event(id="<id>", external_customer_id="<id>")
# Handle response
print(res)import { Flexprice } from "@flexprice/sdk";
const flexprice = new Flexprice({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await flexprice.events.getEvent("<id>", "<id>");
console.log(result);
}
run();package main
import(
"context"
flexprice "github.com/flexprice/go-sdk/v2"
"log"
)
func main() {
ctx := context.Background()
s := flexprice.New(
flexprice.WithSecurity("<YOUR_API_KEY_HERE>"),
)
res, err := s.Events.GetEvent(ctx, "<id>", "<id>", nil, nil)
if err != nil {
log.Fatal(err)
}
if res.GetEventByIDResponse != nil {
// handle response
}
}{
"debug_tracker": {
"attributed_to_customer": {
"error": {
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
},
"meter_usage": {
"external_customer_id": "<string>",
"meter_id": "<string>",
"qty_total": "<string>"
},
"status": "unprocessed"
},
"customer_lookup": {
"customer": {
"address_city": "<string>",
"address_country": "<string>",
"address_line1": "<string>",
"address_line2": "<string>",
"address_postal_code": "<string>",
"address_state": "<string>",
"billing_currency": "<string>",
"contact": "<string>",
"contact_persons": [
{
"first_name": "<string>",
"department": "<string>",
"designation": "<string>",
"email": "<string>",
"id": "<string>",
"is_primary": true,
"last_name": "<string>",
"mobile": "<string>",
"salutation": "<string>"
}
],
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"email": "<string>",
"environment_id": "<string>",
"external_id": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"status": "published",
"tax_treatment": "taxable",
"tenant_id": "<string>",
"timezone": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"error": {
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
},
"status": "unprocessed"
},
"failure_point": {
"error": {
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
},
"failure_point_type": "customer_lookup"
},
"meter_matching": {
"error": {
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
},
"matched_meters": [
{
"event_name": "<string>",
"meter": {
"aggregation": {
"bucket_size": "MINUTE",
"expression": "<string>",
"field": "<string>",
"group_by": "<string>",
"multiplier": "<string>",
"type": "COUNT"
},
"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>",
"reset_usage": "BILLING_PERIOD",
"status": "published",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"meter_id": "<string>"
}
],
"status": "unprocessed"
},
"price_lookup": {
"error": {
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
},
"matched_prices": [
{
"meter_id": "<string>",
"price": {
"amount": "<string>",
"billing_cadence": "RECURRING",
"billing_model": "FLAT_FEE",
"billing_period": "MONTHLY",
"billing_period_count": 123,
"bucket_size": "MINUTE",
"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>",
"entity_type": "PLAN",
"environment_id": "<string>",
"group_id": "<string>",
"id": "<string>",
"invoice_cadence": "ARREAR",
"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
}
],
"price_unit_type": "FIAT",
"sequence": 123,
"start_date": "2023-11-07T05:31:56Z",
"status": "published",
"tenant_id": "<string>",
"tier_mode": "VOLUME",
"tiers": [
{
"flat_amount": "<string>",
"unit_amount": "<string>",
"up_to": 123
}
],
"transform_quantity": {
"divide_by": 123,
"round": "up"
},
"trial_period_days": 123,
"type": "USAGE",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"price_id": "<string>",
"status": "<string>"
}
],
"status": "unprocessed"
},
"subscription_line_item_lookup": {
"error": {
"code": "http_client_error",
"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": "MONTHLY",
"billing_period_count": 123,
"commitment_amount": "<string>",
"commitment_duration": "MONTHLY",
"commitment_overage_factor": "<string>",
"commitment_quantity": "<string>",
"commitment_time_buckets": [
{
"commitment_type": "amount",
"commitment_value": "<string>",
"end": {
"hour": 12,
"minute": 29
},
"id": "<string>",
"overage_factor": 123,
"price_id": "<string>",
"start": {
"hour": 12,
"minute": 29
},
"true_up_enabled": true
}
],
"commitment_true_up_enabled": true,
"commitment_type": "amount",
"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>",
"entity_type": "plan",
"environment_id": "<string>",
"id": "<string>",
"invoice_cadence": "ARREAR",
"metadata": {},
"meter": {
"aggregation": {
"bucket_size": "MINUTE",
"expression": "<string>",
"field": "<string>",
"group_by": "<string>",
"multiplier": "<string>",
"type": "COUNT"
},
"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>",
"reset_usage": "BILLING_PERIOD",
"status": "published",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"meter_display_name": "<string>",
"meter_id": "<string>",
"plan_display_name": "<string>",
"price": {
"amount": "<string>",
"billing_cadence": "RECURRING",
"billing_model": "FLAT_FEE",
"billing_period": "MONTHLY",
"billing_period_count": 123,
"bucket_size": "MINUTE",
"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>",
"entity_type": "PLAN",
"environment_id": "<string>",
"group_id": "<string>",
"id": "<string>",
"invoice_cadence": "ARREAR",
"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
}
],
"price_unit_type": "FIAT",
"sequence": 123,
"start_date": "2023-11-07T05:31:56Z",
"status": "published",
"tenant_id": "<string>",
"tier_mode": "VOLUME",
"tiers": [
{
"flat_amount": "<string>",
"unit_amount": "<string>",
"up_to": 123
}
],
"transform_quantity": {
"divide_by": 123,
"round": "up"
},
"trial_period_days": 123,
"type": "USAGE",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"price_id": "<string>",
"price_type": "USAGE",
"price_unit": "<string>",
"price_unit_id": "<string>",
"quantity": "<string>",
"start_date": "2023-11-07T05:31:56Z",
"status": "published",
"subscription_id": "<string>",
"subscription_phase_id": "<string>",
"tenant_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "<string>"
},
"timestamp_within_range": true
}
],
"status": "unprocessed"
}
},
"event": {
"customer_id": "<string>",
"environment_id": "<string>",
"event_name": "<string>",
"external_customer_id": "<string>",
"id": "<string>",
"ingested_at": "2023-11-07T05:31:56Z",
"properties": {},
"source": "<string>",
"timestamp": "<string>"
},
"events": [
{
"customer_id": "<string>",
"environment_id": "<string>",
"event_name": "<string>",
"external_customer_id": "<string>",
"id": "<string>",
"ingested_at": "2023-11-07T05:31:56Z",
"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>"
}
],
"status": "processed"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}{
"code": "http_client_error",
"http_status_code": 123,
"message": "<string>"
}Authorizations
Enter your API key in the format x-api-key <api-key>*
Query Parameters
Event ID
External customer ID the event was ingested with
Start of the event timestamp window (RFC3339); defaults to 14 days before end_time
End of the event timestamp window (RFC3339); defaults to now