Stripe.Event (stripity_stripe v2.17.2) View Source
Work with Stripe event objects.
You can:
- Retrieve an event
- List all events
Stripe API reference: https://stripe.com/docs/api/events
Link to this section Summary
Link to this section Types
Specs
event_data() :: %{ :object => event_data_object(), optional(:previous_attributes) => map() }
Specs
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.Price.t() | Stripe.Product.t() | Stripe.Recipient.t() | Stripe.Review.t() | Stripe.Sku.t() | Stripe.Source.t() | Stripe.Transfer.t() | map()
Specs
Specs
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
Specs
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.
Specs
retrieve(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieve an event.