Package com.stripe.model

Class Event

    • Constructor Detail

      • Event

        public Event()

    • Method Detail

      • list

        public static EventCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params)
                            throws StripeException
        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).
        Throws:
        StripeException

      • list

        public static EventCollection list​(java.util.Map<java.lang.String,​java.lang.Object> params,
                                   RequestOptions options)
                            throws StripeException
        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).
        Throws:
        StripeException

      • list

        public static EventCollection list​(EventListParams params)
                            throws StripeException
        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).
        Throws:
        StripeException

      • retrieve

        public static Event retrieve​(java.lang.String id)
                      throws StripeException
        Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.
        Throws:
        StripeException

      • retrieve

        public static Event retrieve​(java.lang.String id,
                             RequestOptions options)
                      throws StripeException
        Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.
        Throws:
        StripeException

      • retrieve

        public static Event retrieve​(java.lang.String id,
                             java.util.Map<java.lang.String,​java.lang.Object> params,
                             RequestOptions options)
                      throws StripeException
        Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.
        Throws:
        StripeException

      • getDataObjectDeserializer

        public EventDataObjectDeserializer getDataObjectDeserializer()
        Get deserialization helper to handle failure due to schema incompatibility. When event API version matches that of the library's pinned version, the following integration pattern is safe. 
           Event event = getEvent(); // either from webhook or event endpoint
   EventDataObjectDeserializer deserializer = event.getDataObjectDeserializer();
   Optional<StripeObject> stripeObject = deserializer.getObject();
        You can ensure that webhook events has the same API version by creating webhook endpoint specifying api version](https://stripe.com/docs/api/webhook_endpoints/create) as Stripe.API_VERSION. For reading from old webhook endpoints or old events with potential schema incompatibility, see EventDataObjectDeserializer.deserialize() and EventDataObjectDeserializer.deserializeUnsafe().

      • getAccount

        public java.lang.String getAccount()
        The connected account that originated the event.

      • getApiVersion

        public java.lang.String getApiVersion()
        The Stripe API version used to render data. Note: This property is populated only for events on or after October 31, 2014.

      • getCreated

        public java.lang.Long getCreated()
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • getLivemode

        public java.lang.Boolean getLivemode()
        Has the value true if the object exists in live mode or the value false if the object exists in test mode.

      • getObject

        public java.lang.String getObject()
        String representing the object's type. Objects of the same type share the same value.

        Equal to event.

      • getPendingWebhooks

        public java.lang.Long getPendingWebhooks()
        Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified.

      • getRequest

        public EventRequest getRequest()
        Information on the API request that instigated the event.

      • getType

        public java.lang.String getType()
        Description of the event (e.g., invoice.created or charge.refunded).

      • setAccount

        public void setAccount​(java.lang.String account)
        The connected account that originated the event.

      • setApiVersion

        public void setApiVersion​(java.lang.String apiVersion)
        The Stripe API version used to render data. Note: This property is populated only for events on or after October 31, 2014.

      • setCreated

        public void setCreated​(java.lang.Long created)
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • setData

        public void setData​(EventData data)

      • setId

        public void setId​(java.lang.String id)
        Unique identifier for the object.

      • setLivemode

        public void setLivemode​(java.lang.Boolean livemode)
        Has the value true if the object exists in live mode or the value false if the object exists in test mode.

      • setObject

        public void setObject​(java.lang.String object)
        String representing the object's type. Objects of the same type share the same value.

        Equal to event.

      • setPendingWebhooks

        public void setPendingWebhooks​(java.lang.Long pendingWebhooks)
        Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified.

      • setRequest

        public void setRequest​(EventRequest request)
        Information on the API request that instigated the event.

      • setType

        public void setType​(java.lang.String type)
        Description of the event (e.g., invoice.created or charge.refunded).

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getId

        public java.lang.String getId()
        Unique identifier for the object.
        Specified by:
        getId in interface HasId