com.stripe.model.Event Maven / Gradle / Ivy
// File generated from our OpenAPI spec
package com.stripe.model;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.google.gson.annotations.SerializedName;
import com.stripe.exception.StripeException;
import com.stripe.net.ApiRequest;
import com.stripe.net.ApiRequestParams;
import com.stripe.net.ApiResource;
import com.stripe.net.BaseAddress;
import com.stripe.net.RequestOptions;
import com.stripe.net.StripeResponseGetter;
import com.stripe.param.EventListParams;
import com.stripe.param.EventRetrieveParams;
import java.util.Map;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
/**
* Events are our way of letting you know when something interesting happens in your account. When
* an interesting event occurs, we create a new {@code Event} object. For example, when a charge
* succeeds, we create a {@code charge.succeeded} event, and when an invoice payment attempt fails,
* we create an {@code invoice.payment_failed} event. Certain API requests might create multiple
* events. For example, if you create a new subscription for a customer, you receive both a {@code
* customer.subscription.created} event and a {@code charge.succeeded} event.
*
* Events occur when the state of another API resource changes. The event's data field embeds the
* resource's state at the time of the change. For example, a {@code charge.succeeded} event
* contains a charge, and an {@code invoice.payment_failed} event contains an invoice.
*
*
As with other API resources, you can use endpoints to retrieve an individual event or a list of events from the API. We also have a
* separate webhooks system for sending the
* {@code Event} objects directly to an endpoint on your server. You can manage webhooks in your account settings. Learn how to listen for events so that your integration can
* automatically trigger reactions.
*
*
When using Connect, you can also receive event
* notifications that occur in connected accounts. For these events, there's an additional {@code
* account} attribute in the received {@code Event} object.
*
*
We only guarantee access to events through the Retrieve Event API for 30 days.
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public class Event extends ApiResource implements HasId {
/** The connected account that originates the event. */
@SerializedName("account")
String account;
/**
* The Stripe API version used to render {@code data}. This property is populated only for events
* on or after October 31, 2014.
*/
@SerializedName("api_version")
String apiVersion;
/** Time at which the object was created. Measured in seconds since the Unix epoch. */
@SerializedName("created")
Long created;
@SerializedName("data")
Data data;
/** Unique identifier for the object. */
@Getter(onMethod_ = {@Override})
@SerializedName("id")
String id;
/**
* Has the value {@code true} if the object exists in live mode or the value {@code false} if the
* object exists in test mode.
*/
@SerializedName("livemode")
Boolean livemode;
/**
* String representing the object's type. Objects of the same type share the same value.
*
*
Equal to {@code event}.
*/
@SerializedName("object")
String object;
/**
* Number of webhooks that haven't been successfully delivered (for example, to return a 20x
* response) to the URLs you specify.
*/
@SerializedName("pending_webhooks")
Long pendingWebhooks;
/**
* Information about the action that causes the event. Only present when the event is triggered by
* an API request or an Automation
* action.
*/
@SerializedName("reason")
Reason reason;
/** Information on the API request that triggers the event. */
@SerializedName("request")
Request request;
/**
* Description of the event (for example, {@code invoice.created} or {@code charge.refunded}).
*
*
One of {@code account.application.authorized}, {@code account.application.deauthorized},
* {@code account.external_account.created}, {@code account.external_account.deleted}, {@code
* account.external_account.updated}, {@code account.updated}, {@code account_notice.created},
* {@code account_notice.updated}, {@code application_fee.created}, {@code
* application_fee.refund.updated}, {@code application_fee.refunded}, {@code balance.available},
* {@code billing.alert.triggered}, {@code billing.meter_error_report.triggered}, {@code
* billing_portal.configuration.created}, {@code billing_portal.configuration.updated}, {@code
* billing_portal.session.created}, {@code capability.updated}, {@code
* capital.financing_offer.accepted}, {@code capital.financing_offer.canceled}, {@code
* capital.financing_offer.created}, {@code capital.financing_offer.expired}, {@code
* capital.financing_offer.fully_repaid}, {@code capital.financing_offer.paid_out}, {@code
* capital.financing_offer.rejected}, {@code capital.financing_offer.replacement_created}, {@code
* capital.financing_transaction.created}, {@code cash_balance.funds_available}, {@code
* charge.captured}, {@code charge.dispute.closed}, {@code charge.dispute.created}, {@code
* charge.dispute.funds_reinstated}, {@code charge.dispute.funds_withdrawn}, {@code
* charge.dispute.updated}, {@code charge.expired}, {@code charge.failed}, {@code charge.pending},
* {@code charge.refund.updated}, {@code charge.refunded}, {@code charge.succeeded}, {@code
* charge.updated}, {@code checkout.session.async_payment_failed}, {@code
* checkout.session.async_payment_succeeded}, {@code checkout.session.completed}, {@code
* checkout.session.expired}, {@code climate.order.canceled}, {@code climate.order.created},
* {@code climate.order.delayed}, {@code climate.order.delivered}, {@code
* climate.order.product_substituted}, {@code climate.product.created}, {@code
* climate.product.pricing_updated}, {@code coupon.created}, {@code coupon.deleted}, {@code
* coupon.updated}, {@code credit_note.created}, {@code credit_note.updated}, {@code
* credit_note.voided}, {@code customer.created}, {@code customer.deleted}, {@code
* customer.discount.created}, {@code customer.discount.deleted}, {@code
* customer.discount.updated}, {@code customer.source.created}, {@code customer.source.deleted},
* {@code customer.source.expiring}, {@code customer.source.updated}, {@code
* customer.subscription.collection_paused}, {@code customer.subscription.collection_resumed},
* {@code customer.subscription.created}, {@code customer.subscription.custom_event}, {@code
* customer.subscription.deleted}, {@code customer.subscription.paused}, {@code
* customer.subscription.pending_update_applied}, {@code
* customer.subscription.pending_update_expired}, {@code
* customer.subscription.price_migration_failed}, {@code customer.subscription.resumed}, {@code
* customer.subscription.trial_will_end}, {@code customer.subscription.updated}, {@code
* customer.tax_id.created}, {@code customer.tax_id.deleted}, {@code customer.tax_id.updated},
* {@code customer.updated}, {@code customer_cash_balance_transaction.created}, {@code
* entitlements.active_entitlement_summary.updated}, {@code file.created}, {@code
* financial_connections.account.created}, {@code financial_connections.account.deactivated},
* {@code financial_connections.account.disconnected}, {@code
* financial_connections.account.reactivated}, {@code
* financial_connections.account.refreshed_balance}, {@code
* financial_connections.account.refreshed_inferred_balances}, {@code
* financial_connections.account.refreshed_ownership}, {@code
* financial_connections.account.refreshed_transactions}, {@code
* financial_connections.session.updated}, {@code identity.verification_session.canceled}, {@code
* identity.verification_session.created}, {@code identity.verification_session.processing},
* {@code identity.verification_session.redacted}, {@code
* identity.verification_session.requires_input}, {@code identity.verification_session.verified},
* {@code invoice.created}, {@code invoice.deleted}, {@code invoice.finalization_failed}, {@code
* invoice.finalized}, {@code invoice.marked_uncollectible}, {@code invoice.overdue}, {@code
* invoice.paid}, {@code invoice.payment.overpaid}, {@code invoice.payment_action_required},
* {@code invoice.payment_failed}, {@code invoice.payment_succeeded}, {@code invoice.sent}, {@code
* invoice.upcoming}, {@code invoice.updated}, {@code invoice.voided}, {@code
* invoice.will_be_due}, {@code invoiceitem.created}, {@code invoiceitem.deleted}, {@code
* issuing_authorization.created}, {@code issuing_authorization.request}, {@code
* issuing_authorization.updated}, {@code issuing_card.created}, {@code issuing_card.updated},
* {@code issuing_cardholder.created}, {@code issuing_cardholder.updated}, {@code
* issuing_dispute.closed}, {@code issuing_dispute.created}, {@code
* issuing_dispute.funds_reinstated}, {@code issuing_dispute.funds_rescinded}, {@code
* issuing_dispute.submitted}, {@code issuing_dispute.updated}, {@code
* issuing_personalization_design.activated}, {@code issuing_personalization_design.deactivated},
* {@code issuing_personalization_design.rejected}, {@code
* issuing_personalization_design.updated}, {@code issuing_token.created}, {@code
* issuing_token.updated}, {@code issuing_transaction.created}, {@code
* issuing_transaction.updated}, {@code mandate.updated}, {@code
* payment_intent.amount_capturable_updated}, {@code payment_intent.canceled}, {@code
* payment_intent.created}, {@code payment_intent.partially_funded}, {@code
* payment_intent.payment_failed}, {@code payment_intent.processing}, {@code
* payment_intent.requires_action}, {@code payment_intent.succeeded}, {@code
* payment_link.created}, {@code payment_link.updated}, {@code payment_method.attached}, {@code
* payment_method.automatically_updated}, {@code payment_method.detached}, {@code
* payment_method.updated}, {@code payout.canceled}, {@code payout.created}, {@code
* payout.failed}, {@code payout.paid}, {@code payout.reconciliation_completed}, {@code
* payout.updated}, {@code person.created}, {@code person.deleted}, {@code person.updated}, {@code
* plan.created}, {@code plan.deleted}, {@code plan.updated}, {@code price.created}, {@code
* price.deleted}, {@code price.updated}, {@code product.created}, {@code product.deleted}, {@code
* product.updated}, {@code promotion_code.created}, {@code promotion_code.updated}, {@code
* quote.accept_failed}, {@code quote.accepted}, {@code quote.accepting}, {@code quote.canceled},
* {@code quote.created}, {@code quote.draft}, {@code quote.finalized}, {@code
* quote.reestimate_failed}, {@code quote.reestimated}, {@code quote.stale}, {@code
* radar.early_fraud_warning.created}, {@code radar.early_fraud_warning.updated}, {@code
* refund.created}, {@code refund.updated}, {@code reporting.report_run.failed}, {@code
* reporting.report_run.succeeded}, {@code reporting.report_type.updated}, {@code review.closed},
* {@code review.opened}, {@code setup_intent.canceled}, {@code setup_intent.created}, {@code
* setup_intent.requires_action}, {@code setup_intent.setup_failed}, {@code
* setup_intent.succeeded}, {@code sigma.scheduled_query_run.created}, {@code source.canceled},
* {@code source.chargeable}, {@code source.failed}, {@code source.mandate_notification}, {@code
* source.refund_attributes_required}, {@code source.transaction.created}, {@code
* source.transaction.updated}, {@code subscription_schedule.aborted}, {@code
* subscription_schedule.canceled}, {@code subscription_schedule.completed}, {@code
* subscription_schedule.created}, {@code subscription_schedule.expiring}, {@code
* subscription_schedule.price_migration_failed}, {@code subscription_schedule.released}, {@code
* subscription_schedule.updated}, {@code tax.form.updated}, {@code tax.settings.updated}, {@code
* tax_rate.created}, {@code tax_rate.updated}, {@code terminal.reader.action_failed}, {@code
* terminal.reader.action_succeeded}, {@code terminal.reader.action_updated}, {@code
* test_helpers.test_clock.advancing}, {@code test_helpers.test_clock.created}, {@code
* test_helpers.test_clock.deleted}, {@code test_helpers.test_clock.internal_failure}, {@code
* test_helpers.test_clock.ready}, {@code topup.canceled}, {@code topup.created}, {@code
* topup.failed}, {@code topup.reversed}, {@code topup.succeeded}, {@code transfer.created},
* {@code transfer.reversed}, {@code transfer.updated}, {@code treasury.credit_reversal.created},
* {@code treasury.credit_reversal.posted}, {@code treasury.debit_reversal.completed}, {@code
* treasury.debit_reversal.created}, {@code treasury.debit_reversal.initial_credit_granted},
* {@code treasury.financial_account.closed}, {@code treasury.financial_account.created}, {@code
* treasury.financial_account.features_status_updated}, {@code
* treasury.inbound_transfer.canceled}, {@code treasury.inbound_transfer.created}, {@code
* treasury.inbound_transfer.failed}, {@code treasury.inbound_transfer.succeeded}, {@code
* treasury.outbound_payment.canceled}, {@code treasury.outbound_payment.created}, {@code
* treasury.outbound_payment.expected_arrival_date_updated}, {@code
* treasury.outbound_payment.failed}, {@code treasury.outbound_payment.posted}, {@code
* treasury.outbound_payment.returned}, {@code
* treasury.outbound_payment.tracking_details_updated}, {@code
* treasury.outbound_transfer.canceled}, {@code treasury.outbound_transfer.created}, {@code
* treasury.outbound_transfer.expected_arrival_date_updated}, {@code
* treasury.outbound_transfer.failed}, {@code treasury.outbound_transfer.posted}, {@code
* treasury.outbound_transfer.returned}, {@code
* treasury.outbound_transfer.tracking_details_updated}, {@code treasury.received_credit.created},
* {@code treasury.received_credit.failed}, {@code treasury.received_credit.succeeded}, or {@code
* treasury.received_debit.created}.
*/
@SerializedName("type")
String type;
/**
* 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 {@code api_version} attribute
* (not according to your current Stripe API version or {@code Stripe-Version} header).
*/
public static EventCollection list(Map params) throws StripeException {
return list(params, (RequestOptions) null);
}
/**
* 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 {@code api_version} attribute
* (not according to your current Stripe API version or {@code Stripe-Version} header).
*/
public static EventCollection list(Map params, RequestOptions options)
throws StripeException {
String path = "/v1/events";
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, EventCollection.class);
}
/**
* 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 {@code api_version} attribute
* (not according to your current Stripe API version or {@code Stripe-Version} header).
*/
public static EventCollection list(EventListParams params) throws StripeException {
return list(params, (RequestOptions) null);
}
/**
* 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 {@code api_version} attribute
* (not according to your current Stripe API version or {@code Stripe-Version} header).
*/
public static EventCollection list(EventListParams params, RequestOptions options)
throws StripeException {
String path = "/v1/events";
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, EventCollection.class);
}
/**
* 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.
*/
public static Event retrieve(String id) throws StripeException {
return retrieve(id, (Map) null, (RequestOptions) null);
}
/**
* 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.
*/
public static Event retrieve(String id, RequestOptions options) throws StripeException {
return retrieve(id, (Map) null, options);
}
/**
* 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.
*/
public static Event retrieve(String id, Map params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/events/%s", ApiResource.urlEncodeId(id));
ApiRequest request =
new ApiRequest(BaseAddress.API, ApiResource.RequestMethod.GET, path, params, options);
return getGlobalResponseGetter().request(request, Event.class);
}
/**
* 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.
*/
public static Event retrieve(String id, EventRetrieveParams params, RequestOptions options)
throws StripeException {
String path = String.format("/v1/events/%s", ApiResource.urlEncodeId(id));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.GET,
path,
ApiRequestParams.paramsToMap(params),
options);
return getGlobalResponseGetter().request(request, Event.class);
}
/**
* 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 {@link
* com.stripe.Stripe#API_VERSION}. For reading from old webhook endpoints or old events with
* potential schema incompatibility, see {@link EventDataObjectDeserializer#deserialize()} and
* {@link EventDataObjectDeserializer#deserializeUnsafe()}.
*/
public EventDataObjectDeserializer getDataObjectDeserializer() {
return new EventDataObjectDeserializer(apiVersion, type, data.object, getResponseGetter());
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Data extends StripeObject implements StripeActiveObject {
/**
* Object containing the names of the updated attributes and their values prior to the event
* (only included in events of type {@code *.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.
*/
@SerializedName("previous_attributes")
Map previousAttributes;
/**
* Raw JSON object intended to be deserialized as {@code StripeObject}. The deserialization
* should be deferred to the user. See the now deprecated method {@link #getObject()}.
*/
@SerializedName("object")
JsonObject object;
private transient StripeResponseGetter responseGetter;
/**
* @deprecated Deprecated in favor of getting {@code StripeObject} from {@link
* Event#getDataObjectDeserializer()} and {@link EventDataObjectDeserializer#getObject()}.
* Throws {@link JsonParseException} deserialization failure due to general invalid JSON, or
* more specifically when JSON data and model class have incompatible schemas.
* @return Deserialized StripeObject for event data.
*/
@Deprecated
public StripeObject getObject() {
return StripeObject.deserializeStripeObject(object, this.responseGetter);
}
@Override
public void setResponseGetter(StripeResponseGetter responseGetter) {
this.responseGetter = responseGetter;
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Reason extends StripeObject {
@SerializedName("automation_action")
AutomationAction automationAction;
@SerializedName("request")
Request request;
/**
* The type of the reason for the event.
*
* One of {@code automation_action}, or {@code request}.
*/
@SerializedName("type")
String type;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class AutomationAction extends StripeObject {
@SerializedName("stripe_send_webhook_custom_event")
StripeSendWebhookCustomEvent stripeSendWebhookCustomEvent;
/**
* The trigger name of the automation that triggered this action. Please visit Revenue and retention
* automations for all possible trigger names.
*/
@SerializedName("trigger")
String trigger;
/**
* The type of the {@code automation_action}.
*
*
Equal to {@code stripe_send_webhook_custom_event}.
*/
@SerializedName("type")
String type;
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class StripeSendWebhookCustomEvent extends StripeObject {
/** Set of key-value pairs attached to the action when creating an Automation. */
@SerializedName("custom_data")
Map customData;
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Request extends StripeObject implements HasId {
/**
* 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, but currently not in the API.
*/
@Getter(onMethod_ = {@Override})
@SerializedName("id")
String id;
/**
* The idempotency key transmitted during the request, if any. Note: This property is
* populated only for events on or after May 23, 2017.
*/
@SerializedName("idempotency_key")
String idempotencyKey;
}
}
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public static class Request extends StripeObject implements HasId {
/**
* 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, but currently not in the API.
*/
@Getter(onMethod_ = {@Override})
@SerializedName("id")
String id;
/**
* The idempotency key transmitted during the request, if any. Note: This property is
* populated only for events on or after May 23, 2017.
*/
@SerializedName("idempotency_key")
String idempotencyKey;
}
@Override
public void setResponseGetter(StripeResponseGetter responseGetter) {
super.setResponseGetter(responseGetter);
trySetResponseGetter(data, responseGetter);
trySetResponseGetter(reason, responseGetter);
trySetResponseGetter(request, responseGetter);
}
}