Retrieve an event

Changed on

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

get/v1/events/{id}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/events/{id}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

idstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

accountstring

The connected account that originates the event.

api_versionstring nullable

The Stripe API version used to render data when the event was created. The contents of data never change, so this value remains static regardless of the API version currently in use. This property is populated only for events created on or after October 31, 2014.

contextstring

Authentication context needed to fetch the event or related object.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'event' required

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

pending_webhooksinteger required

Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.

typestring required

Description of the event (for example, invoice.created or charge.refunded).

Changes

  • e24a26de4188Revision changes
    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.