Stripe: Events schemas

← Events operations · All schemas

Retrieve an event — response body

Field	Type	Presence	Description and constraints
$	object	Root	Snapshot events allow you to track and react to activity in your Stripe integration. When the state of another API resource changes, Stripe creates an `Event` object that contains all the relevant information associated with that action, including the affected API resource. For example, a successful payment triggers a `charge.succeeded` event, which contains the `Charge` in the event's data property. Some actions trigger multiple events. For example, if you create a new subscription for a customer, it triggers both a `customer.subscription.created` event and a `charge.succeeded` event. Configure an event destination in your account to listen for events that represent actions your integration needs to respond to. Additionally, you can retrieve an individual event or a list of events from the API. [Connect](https://docs.stripe.com/connect) platforms can also receive event notifications that occur in their connected accounts. These events include an account attribute that identifies the relevant connected account. You can access events through the [Retrieve Event API](https://docs.stripe.com/api/events#retrieve_event) for 30 days.
account	string	Optional	The connected account that originates the event. Maximum length: 5000
api_version	JSON	Optional
api_version (anyOf 1)	string	Alternative	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. Maximum length: 5000
api_version (anyOf 2)	null	Alternative
context	string	Optional	Authentication context needed to fetch the event or related object. Maximum length: 5000
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data	Model	Required within parent	Expand Retrieve an event — response body — data
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: event
pending_webhooks	JSON	Required within parent
pending_webhooks (anyOf 1)	integer	Alternative	Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.
pending_webhooks (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
request	JSON	Optional
request (anyOf 1)	JSON	Alternative	Information on the API request that triggers the event.
request (anyOf 1) (anyOf 1)	Model	Alternative	Expand Retrieve an event — response body — request value id, idempotency key
request (anyOf 2)	null	Alternative
type	string	Required within parent	Description of the event (for example, `invoice.created` or `charge.refunded`). Maximum length: 5000

Referenced models: Retrieve an event — response body — data, Retrieve an event — response body — request value id, idempotency key

Retrieve an event — response body — data

Field	Type	Presence	Description and constraints
$	object	Root
object	object	Required within parent	Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://docs.stripe.com/api#invoice_object) as the value of the object key. Additional keys: allowed
previous_attributes	object	Optional	Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements. Additional keys: allowed

Retrieve an event — response body — request value id, idempotency key

Field	Type	Presence	Description and constraints
$	object	Root
id	JSON	Optional
id (anyOf 1)	string	Alternative	ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API. Maximum length: 5000
id (anyOf 2)	null	Alternative
idempotency_key	JSON	Optional
idempotency_key (anyOf 1)	string	Alternative	The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*. Maximum length: 5000
idempotency_key (anyOf 2)	null	Alternative