stripity_stripe v2.7.0 Stripe.Event View Source
Work with Stripe event objects.
You can:
- Retrieve an event
- List all events
Stripe API reference: https://stripe.com/docs/api#event
Link to this section Summary
Link to this section Types
Link to this type
event_data()
View Source
event_data()
View Source
event_data() :: %{object: event_data_object(), previous_attributes: map()}
event_data() :: %{object: event_data_object(), previous_attributes: map()}
Link to this type
event_data_object()
View Source
event_data_object()
View Source
event_data_object() ::
Stripe.Account.t()
| Stripe.ApplicationFee.t()
| Stripe.Charge.t()
| Stripe.Coupon.t()
| Stripe.Customer.t()
| Stripe.FileUpload.t()
| Stripe.Invoice.t()
| Stripe.Invoiceitem.t()
| Stripe.Order.t()
| Stripe.OrderReturn.t()
| Stripe.Payout.t()
| Stripe.Plan.t()
| Stripe.Relay.Product.t()
| Stripe.Product.t()
| Stripe.Recipient.t()
| Stripe.Review.t()
| Stripe.Sku.t()
| Stripe.Source.t()
| Stripe.Transfer.t()
| map()
event_data_object() :: Stripe.Account.t() | Stripe.ApplicationFee.t() | Stripe.Charge.t() | Stripe.Coupon.t() | Stripe.Customer.t() | Stripe.FileUpload.t() | Stripe.Invoice.t() | Stripe.Invoiceitem.t() | Stripe.Order.t() | Stripe.OrderReturn.t() | Stripe.Payout.t() | Stripe.Plan.t() | Stripe.Relay.Product.t() | Stripe.Product.t() | Stripe.Recipient.t() | Stripe.Review.t() | Stripe.Sku.t() | Stripe.Source.t() | Stripe.Transfer.t() | map()
Link to this type
event_request() View Source
Link to this type
t()
View Source
t()
View Source
t() :: %Stripe.Event{
account: term(),
api_version: String.t() | nil,
created: Stripe.timestamp(),
data: event_data(),
id: Stripe.id(),
livemode: boolean(),
object: String.t(),
pending_webhooks: non_neg_integer(),
request: event_request() | nil,
type: String.t()
}
t() :: %Stripe.Event{
account: term(),
api_version: String.t() | nil,
created: Stripe.timestamp(),
data: event_data(),
id: Stripe.id(),
livemode: boolean(),
object: String.t(),
pending_webhooks: non_neg_integer(),
request: event_request() | nil,
type: String.t()
}
Link to this section Functions
Link to this function
list(params \\ %{}, opts \\ [])
View Source
list(params \\ %{}, opts \\ [])
View Source
list(params, Stripe.options()) ::
{:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params:
%{
optional(:created) => Stripe.date_query(),
optional(:ending_before) => t() | Stripe.id(),
optional(:limit) => 1..100,
optional(:starting_after) => t() | Stripe.id(),
optional(:type) => String.t(),
optional(:types) => list()
}
| %{}
list(params, Stripe.options()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()} when params: %{ optional(:created) => Stripe.date_query(), optional(:ending_before) => t() | Stripe.id(), optional(:limit) => 1..100, optional(:starting_after) => t() | Stripe.id(), optional(:type) => String.t(), optional(:types) => list() } | %{}
List all events, going back up to 30 days.
Link to this function
retrieve(id, opts \\ [])
View Source
retrieve(id, opts \\ [])
View Source
retrieve(Stripe.id() | t(), Stripe.options()) ::
{:ok, t()} | {:error, Stripe.Error.t()}
retrieve(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieve an event.