View Source Stripe.Event (stripity_stripe v3.3.1)

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 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 for 30 days.

Summary

Types

created()

t()

The event type.

Functions

list(params \\ %{}, opts \\ [])

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

retrieve(id, params \\ %{}, opts \\ [])

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.

Types

created()

@type created() :: %{
  optional(:gt) => integer(),
  optional(:gte) => integer(),
  optional(:lt) => integer(),
  optional(:lte) => integer()
}

t()

@type t() :: %Stripe.Event{
  account: binary(),
  api_version: binary() | nil,
  context: binary(),
  created: integer(),
  data: term(),
  id: binary(),
  livemode: boolean(),
  object: binary(),
  pending_webhooks: integer(),
  request: term() | nil,
  type: binary()
}

The event type.

account The connected account that originates the event.
api_version 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.
context Authentication context needed to fetch the event or related object.
created Time at which the object was created. Measured in seconds since the Unix epoch.
data
id Unique identifier for the object.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
object String representing the object's type. Objects of the same type share the same value.
pending_webhooks Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.
request Information on the API request that triggers the event.
type Description of the event (for example, invoice.created or charge.refunded).

Functions

list(params \\ %{}, opts \\ [])

@spec list(
  params :: %{
    optional(:created) => created() | integer(),
    optional(:delivery_success) => boolean(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary(),
    optional(:type) => binary(),
    optional(:types) => [binary()]
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

Details

Method: get
Path: /v1/events

retrieve(id, params \\ %{}, opts \\ [])

@spec retrieve(
  id :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

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.

Details

Method: get
Path: /v1/events/{id}