{ "name": "GetBillingMeterEventSummaries", "fully_qualified_name": "StripeApi.GetBillingMeterEventSummaries@0.1.0", "description": "Retrieve billing meter event summaries by meter ID.\n\nCall this tool to get a list of billing meter event summaries for a specific meter ID, providing insights into billing events and activities.", "toolkit": { "name": "ArcadeStripeApi", "description": null, "version": "0.1.0" }, "input": { "parameters": [ { "name": "customer_id", "required": true, "description": "The unique identifier of the customer for which to fetch event summaries.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The customer for which to fetch event summaries." }, "inferrable": true, "http_endpoint_parameter_name": "customer" }, { "name": "stop_aggregating_until", "required": true, "description": "The exclusive timestamp to stop aggregating meter events. Ensure it aligns with minute boundaries.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries." }, "inferrable": true, "http_endpoint_parameter_name": "end_time" }, { "name": "start_time_timestamp", "required": true, "description": "The timestamp to begin aggregating meter events (inclusive). Must align with minute boundaries.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries." }, "inferrable": true, "http_endpoint_parameter_name": "start_time" }, { "name": "meter_id", "required": true, "description": "The unique identifier for the billing meter to fetch event summaries for.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique identifier for the object." }, "inferrable": true, "http_endpoint_parameter_name": "id" }, { "name": "pagination_ending_before_id", "required": false, "description": "An object ID for pagination, used to fetch the previous page of a list. Aligns the list cursor to end before the specified object ID.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, "inferrable": true, "http_endpoint_parameter_name": "ending_before" }, { "name": "fields_to_expand", "required": false, "description": "A list of fields in the response that should be expanded for detailed results.", "value_schema": { "val_type": "array", "inner_val_type": "string", "enum": null, "properties": null, "inner_properties": null, "description": "Specifies which fields in the response should be expanded." }, "inferrable": true, "http_endpoint_parameter_name": "expand" }, { "name": "number_of_objects_limit", "required": false, "description": "A limit on the number of billing meter event summaries to be returned. Must be between 1 and 100, with a default of 10.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, "inferrable": true, "http_endpoint_parameter_name": "limit" }, { "name": "pagination_starting_after_id", "required": false, "description": "The object ID to use as a cursor to fetch the next page of the list for pagination.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." }, "inferrable": true, "http_endpoint_parameter_name": "starting_after" }, { "name": "granularity_for_event_summaries", "required": false, "description": "Specifies the granularity for event summaries: 'hour' or 'day'. If not set, returns a single summary for the time range.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": [ "day", "hour" ], "properties": null, "inner_properties": null, "description": "Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC)." }, "inferrable": true, "http_endpoint_parameter_name": "value_grouping_window" } ] }, "output": { "description": "Response from the API endpoint 'GetBillingMetersIdEventSummaries'.", "available_modes": [ "value", "error", "null" ], "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "requirements": { "authorization": null, "secrets": [ { "key": "STRIPE_API_KEY" } ], "metadata": null }, "deprecation_message": null, "metadata": { "object_type": "api_wrapper_tool", "version": "1.0.0", "description": "Tools that enable LLMs to interact directly with the Stripe API." }, "http_endpoint": { "metadata": { "object_type": "http_endpoint", "version": "1.0.0", "description": "" }, "url": "https://api.stripe.com/v1/billing/meters/{id}/event_summaries", "http_method": "GET", "headers": {}, "parameters": [ { "name": "customer", "tool_parameter_name": "customer_id", "description": "The customer for which to fetch event summaries.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The customer for which to fetch event summaries." }, "accepted_as": "query", "required": true, "deprecated": false, "documentation_urls": [] }, { "name": "end_time", "tool_parameter_name": "stop_aggregating_until", "description": "The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries." }, "accepted_as": "query", "required": true, "deprecated": false, "documentation_urls": [] }, { "name": "ending_before", "tool_parameter_name": "pagination_ending_before_id", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, "accepted_as": "query", "required": false, "deprecated": false, "documentation_urls": [] }, { "name": "expand", "tool_parameter_name": "fields_to_expand", "description": "Specifies which fields in the response should be expanded.", "value_schema": { "val_type": "array", "inner_val_type": "string", "enum": null, "properties": null, "inner_properties": null, "description": "Specifies which fields in the response should be expanded." }, "accepted_as": "query", "required": false, "deprecated": false, "documentation_urls": [] }, { "name": "limit", "tool_parameter_name": "number_of_objects_limit", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, "accepted_as": "query", "required": false, "deprecated": false, "documentation_urls": [] }, { "name": "start_time", "tool_parameter_name": "start_time_timestamp", "description": "The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries." }, "accepted_as": "query", "required": true, "deprecated": false, "documentation_urls": [] }, { "name": "starting_after", "tool_parameter_name": "pagination_starting_after_id", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." }, "accepted_as": "query", "required": false, "deprecated": false, "documentation_urls": [] }, { "name": "value_grouping_window", "tool_parameter_name": "granularity_for_event_summaries", "description": "Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": [ "day", "hour" ], "properties": null, "inner_properties": null, "description": "Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC)." }, "accepted_as": "query", "required": false, "deprecated": false, "documentation_urls": [] }, { "name": "id", "tool_parameter_name": "meter_id", "description": "Unique identifier for the object.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Unique identifier for the object." }, "accepted_as": "path", "required": true, "deprecated": false, "documentation_urls": [] } ], "documentation_urls": [], "secrets": [ { "arcade_key": "STRIPE_API_KEY", "parameter_name": "Authorization", "accepted_as": "header", "formatted_value": "Bearer {authorization}", "description": "", "is_auth_token": false } ] } }