Types of events v2

Core Resources
Events
Types of events

This is a list of all public thin events we currently send for /v1 and /v2 resources, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.

Event types

Type
Filter events by type
Related object
EventDestination

v1.billing.meter.error_report_triggered

Occurs when a Meter has invalid async usage events.

Attributes

  • idstring

    Unique identifier for the event.

  • objectstring, value is "v2.core.event"

    String representing the object’s type. Objects of the same type share the same value of the object field.

  • contextnullable string

    Authentication context needed to fetch the event or related object.

  • createdtimestamp

    Time at which the object was created.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • reasonnullable object

    Reason for the event.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

    Object containing the reference to API resource relevant to the event.

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v1.billing.meter.error_report_triggered"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

    • data.developer_message_summarystring

      Extra field included in the event’s data when fetched from /v2/events.

    • data.reasonobject

      This contains information about why meter error happens.

      • data.reason.error_countinteger

        The total error count within this window.

      • data.reason.error_typesarray of objects

        The error details.

        • data.reason.error_types.codeenum

          Possible enum values
          archived_meter

          Enum value: archived_meter.

          meter_event_customer_not_found

          Enum value: meter_event_customer_not_found.

          meter_event_dimension_count_too_high

          Enum value: meter_event_dimension_count_too_high.

          meter_event_invalid_value

          Enum value: meter_event_invalid_value.

          meter_event_no_customer_defined

          Enum value: meter_event_no_customer_defined.

          missing_dimension_payload_keys

          Enum value: missing_dimension_payload_keys.

          no_meter

          Enum value: no_meter.

          timestamp_in_future

          Enum value: timestamp_in_future.

          timestamp_too_far_in_past

          Enum value: timestamp_too_far_in_past.

        • data.reason.error_types.error_countinteger

          The number of errors of this type.

        • data.reason.error_types.sample_errorsarray of objects

          A list of sample errors of this type.

          • data.reason.error_types.sample_errors.error_messagestring

            The error message.

          • data.reason.error_types.sample_errors.requestobject

            The request causes the error.

            • data.reason.error_types.sample_errors.request.identifierstring

              The request idempotency key.

    • data.validation_endtimestamp

      The end of the window that is encapsulated by this summary.

    • data.validation_starttimestamp

      The start of the window that is encapsulated by this summary.

Event handler
# Select a client library to see examples of
# parsing and retrieving event details.

v1.billing.meter.no_meter_found

Occurs when a Meter's id is missing or invalid in async usage events.

Attributes

  • idstring

    Unique identifier for the event.

  • objectstring, value is "v2.core.event"

    String representing the object’s type. Objects of the same type share the same value of the object field.

  • contextnullable string

    Authentication context needed to fetch the event or related object.

  • createdtimestamp

    Time at which the object was created.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • reasonnullable object

    Reason for the event.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

    Object containing the reference to API resource relevant to the event.

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v1.billing.meter.no_meter_found"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

    • data.developer_message_summarystring

      Extra field included in the event’s data when fetched from /v2/events.

    • data.reasonobject

      This contains information about why meter error happens.

      • data.reason.error_countinteger

        The total error count within this window.

      • data.reason.error_typesarray of objects

        The error details.

        • data.reason.error_types.codeenum

          Possible enum values
          archived_meter

          Enum value: archived_meter.

          meter_event_customer_not_found

          Enum value: meter_event_customer_not_found.

          meter_event_dimension_count_too_high

          Enum value: meter_event_dimension_count_too_high.

          meter_event_invalid_value

          Enum value: meter_event_invalid_value.

          meter_event_no_customer_defined

          Enum value: meter_event_no_customer_defined.

          missing_dimension_payload_keys

          Enum value: missing_dimension_payload_keys.

          no_meter

          Enum value: no_meter.

          timestamp_in_future

          Enum value: timestamp_in_future.

          timestamp_too_far_in_past

          Enum value: timestamp_too_far_in_past.

        • data.reason.error_types.error_countinteger

          The number of errors of this type.

        • data.reason.error_types.sample_errorsarray of objects

          A list of sample errors of this type.

          • data.reason.error_types.sample_errors.error_messagestring

            The error message.

          • data.reason.error_types.sample_errors.requestobject

            The request causes the error.

            • data.reason.error_types.sample_errors.request.identifierstring

              The request idempotency key.

    • data.validation_endtimestamp

      The end of the window that is encapsulated by this summary.

    • data.validation_starttimestamp

      The start of the window that is encapsulated by this summary.

Event handler
# Select a client library to see examples of
# parsing and retrieving event details.

v2.core.event_destination.ping

A ping event used to test the connection to an EventDestination.

Attributes

  • idstring

    Unique identifier for the event.

  • objectstring, value is "v2.core.event"

    String representing the object’s type. Objects of the same type share the same value of the object field.

  • contextnullable string

    Authentication context needed to fetch the event or related object.

  • createdtimestamp

    Time at which the object was created.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • reasonnullable object

    Reason for the event.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

    Object containing the reference to API resource relevant to the event.

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring, value is "v2.core.event_destination.ping"

    The type of the event.

Fetched attributes

  • dataobject

    Additional data about the event.

Event payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.core.event_destination",
"url": "/v2/core/event_destinations/ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.core.event_destination.ping",
"livemode": true
}
Event handler
# Select a client library to see examples of
# parsing and retrieving event details.
Fetched payload
{
"context": null,
"created": "2025-01-01T00:00:00.000Z",
"id": "evt_65RCjj4EqW1sabcjs2Z16RCMoNQdSQkOWvfL6L5uU2K40u",
"object": "v2.core.event",
"reason": {
"type": "request",
"request": {
"id": "req_v24sUK2aV6o01RdVU",
"idempotency_key": "fe21992d-e123-3f8c-bc90-fec93712bcb2"
}
},
"related_object": {
"id": "ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me",
"type": "v2.core.event_destination",
"url": "/v2/core/event_destinations/ed_65SDS7HTasdQYsDClFT16CGd2aE2kBpeAvvRnBUcS2me"
},
"type": "v2.core.event_destination.ping",
"livemode": true,
"changes": {},
"data": {}
}