Class: Stripe::V2::Core::Event

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/v2/core/event.rb

Overview

Events are generated to keep you informed of activity in your business account. APIs in the /v2 namespace generate [thin events](docs.stripe.com/event-destinations#benefits-of-thin-events) which have small, unversioned payloads that include a reference to the ID of the object that has changed. The Events v2 API returns these new thin events. [Retrieve the event object](docs.stripe.com/event-destinations#fetch-data) for additional data about the event. Use the related object ID in the event payload to [fetch the API resource](docs.stripe.com/event-destinations#retrieve-the-object-associated-with-thin-events) of the object associated with the event. Comparatively, events generated by most API v1 include a versioned snapshot of an API object in their payload.

Direct Known Subclasses

Events::V1AccountUpdatedEvent, Events::V1ApplicationFeeCreatedEvent, Events::V1ApplicationFeeRefundedEvent, Events::V1BillingMeterErrorReportTriggeredEvent, Events::V1BillingMeterNoMeterFoundEvent, Events::V1BillingPortalConfigurationCreatedEvent, Events::V1BillingPortalConfigurationUpdatedEvent, Events::V1CapabilityUpdatedEvent, Events::V1ChargeCapturedEvent, Events::V1ChargeDisputeClosedEvent, Events::V1ChargeDisputeCreatedEvent, Events::V1ChargeDisputeFundsReinstatedEvent, Events::V1ChargeDisputeFundsWithdrawnEvent, Events::V1ChargeDisputeUpdatedEvent, Events::V1ChargeExpiredEvent, Events::V1ChargeFailedEvent, Events::V1ChargePendingEvent, Events::V1ChargeRefundUpdatedEvent, Events::V1ChargeRefundedEvent, Events::V1ChargeSucceededEvent, Events::V1ChargeUpdatedEvent, Events::V1CheckoutSessionAsyncPaymentFailedEvent, Events::V1CheckoutSessionAsyncPaymentSucceededEvent, Events::V1CheckoutSessionCompletedEvent, Events::V1CheckoutSessionExpiredEvent, Events::V1ClimateOrderCanceledEvent, Events::V1ClimateOrderCreatedEvent, Events::V1ClimateOrderDelayedEvent, Events::V1ClimateOrderDeliveredEvent, Events::V1ClimateOrderProductSubstitutedEvent, Events::V1ClimateProductCreatedEvent, Events::V1ClimateProductPricingUpdatedEvent, Events::V1CouponCreatedEvent, Events::V1CouponDeletedEvent, Events::V1CouponUpdatedEvent, Events::V1CreditNoteCreatedEvent, Events::V1CreditNoteUpdatedEvent, Events::V1CreditNoteVoidedEvent, Events::V1CustomerCreatedEvent, Events::V1CustomerDeletedEvent, Events::V1CustomerSubscriptionCreatedEvent, Events::V1CustomerSubscriptionDeletedEvent, Events::V1CustomerSubscriptionPausedEvent, Events::V1CustomerSubscriptionPendingUpdateAppliedEvent, Events::V1CustomerSubscriptionPendingUpdateExpiredEvent, Events::V1CustomerSubscriptionResumedEvent, Events::V1CustomerSubscriptionTrialWillEndEvent, Events::V1CustomerSubscriptionUpdatedEvent, Events::V1CustomerTaxIdCreatedEvent, Events::V1CustomerTaxIdDeletedEvent, Events::V1CustomerTaxIdUpdatedEvent, Events::V1CustomerUpdatedEvent, Events::V1FileCreatedEvent, Events::V1FinancialConnectionsAccountCreatedEvent, Events::V1FinancialConnectionsAccountDeactivatedEvent, Events::V1FinancialConnectionsAccountDisconnectedEvent, Events::V1FinancialConnectionsAccountReactivatedEvent, Events::V1FinancialConnectionsAccountRefreshedBalanceEvent, Events::V1FinancialConnectionsAccountRefreshedOwnershipEvent, Events::V1FinancialConnectionsAccountRefreshedTransactionsEvent, Events::V1IdentityVerificationSessionCanceledEvent, Events::V1IdentityVerificationSessionCreatedEvent, Events::V1IdentityVerificationSessionProcessingEvent, Events::V1IdentityVerificationSessionRedactedEvent, Events::V1IdentityVerificationSessionRequiresInputEvent, Events::V1IdentityVerificationSessionVerifiedEvent, Events::V1InvoiceCreatedEvent, Events::V1InvoiceDeletedEvent, Events::V1InvoiceFinalizationFailedEvent, Events::V1InvoiceFinalizedEvent, Events::V1InvoiceMarkedUncollectibleEvent, Events::V1InvoiceOverdueEvent, Events::V1InvoiceOverpaidEvent, Events::V1InvoicePaidEvent, Events::V1InvoicePaymentActionRequiredEvent, Events::V1InvoicePaymentFailedEvent, Events::V1InvoicePaymentPaidEvent, Events::V1InvoicePaymentSucceededEvent, Events::V1InvoiceSentEvent, Events::V1InvoiceUpcomingEvent, Events::V1InvoiceUpdatedEvent, Events::V1InvoiceVoidedEvent, Events::V1InvoiceWillBeDueEvent, Events::V1InvoiceitemCreatedEvent, Events::V1InvoiceitemDeletedEvent, Events::V1IssuingAuthorizationCreatedEvent, Events::V1IssuingAuthorizationRequestEvent, Events::V1IssuingAuthorizationUpdatedEvent, Events::V1IssuingCardCreatedEvent, Events::V1IssuingCardUpdatedEvent, Events::V1IssuingCardholderCreatedEvent, Events::V1IssuingCardholderUpdatedEvent, Events::V1IssuingDisputeClosedEvent, Events::V1IssuingDisputeCreatedEvent, Events::V1IssuingDisputeFundsReinstatedEvent, Events::V1IssuingDisputeFundsRescindedEvent, Events::V1IssuingDisputeSubmittedEvent, Events::V1IssuingDisputeUpdatedEvent, Events::V1IssuingPersonalizationDesignActivatedEvent, Events::V1IssuingPersonalizationDesignDeactivatedEvent, Events::V1IssuingPersonalizationDesignRejectedEvent, Events::V1IssuingPersonalizationDesignUpdatedEvent, Events::V1IssuingTokenCreatedEvent, Events::V1IssuingTokenUpdatedEvent, Events::V1IssuingTransactionCreatedEvent, Events::V1IssuingTransactionPurchaseDetailsReceiptUpdatedEvent, Events::V1IssuingTransactionUpdatedEvent, Events::V1MandateUpdatedEvent, Events::V1PaymentIntentAmountCapturableUpdatedEvent, Events::V1PaymentIntentCanceledEvent, Events::V1PaymentIntentCreatedEvent, Events::V1PaymentIntentPartiallyFundedEvent, Events::V1PaymentIntentPaymentFailedEvent, Events::V1PaymentIntentProcessingEvent, Events::V1PaymentIntentRequiresActionEvent, Events::V1PaymentIntentSucceededEvent, Events::V1PaymentLinkCreatedEvent, Events::V1PaymentLinkUpdatedEvent, Events::V1PaymentMethodAttachedEvent, Events::V1PaymentMethodAutomaticallyUpdatedEvent, Events::V1PaymentMethodDetachedEvent, Events::V1PaymentMethodUpdatedEvent, Events::V1PayoutCanceledEvent, Events::V1PayoutCreatedEvent, Events::V1PayoutFailedEvent, Events::V1PayoutPaidEvent, Events::V1PayoutReconciliationCompletedEvent, Events::V1PayoutUpdatedEvent, Events::V1PersonCreatedEvent, Events::V1PersonDeletedEvent, Events::V1PersonUpdatedEvent, Events::V1PlanCreatedEvent, Events::V1PlanDeletedEvent, Events::V1PlanUpdatedEvent, Events::V1PriceCreatedEvent, Events::V1PriceDeletedEvent, Events::V1PriceUpdatedEvent, Events::V1ProductCreatedEvent, Events::V1ProductDeletedEvent, Events::V1ProductUpdatedEvent, Events::V1PromotionCodeCreatedEvent, Events::V1PromotionCodeUpdatedEvent, Events::V1QuoteAcceptedEvent, Events::V1QuoteCanceledEvent, Events::V1QuoteCreatedEvent, Events::V1QuoteFinalizedEvent, Events::V1RadarEarlyFraudWarningCreatedEvent, Events::V1RadarEarlyFraudWarningUpdatedEvent, Events::V1RefundCreatedEvent, Events::V1RefundFailedEvent, Events::V1RefundUpdatedEvent, Events::V1ReviewClosedEvent, Events::V1ReviewOpenedEvent, Events::V1SetupIntentCanceledEvent, Events::V1SetupIntentCreatedEvent, Events::V1SetupIntentRequiresActionEvent, Events::V1SetupIntentSetupFailedEvent, Events::V1SetupIntentSucceededEvent, Events::V1SigmaScheduledQueryRunCreatedEvent, Events::V1SourceCanceledEvent, Events::V1SourceChargeableEvent, Events::V1SourceFailedEvent, Events::V1SourceRefundAttributesRequiredEvent, Events::V1SubscriptionScheduleAbortedEvent, Events::V1SubscriptionScheduleCanceledEvent, Events::V1SubscriptionScheduleCompletedEvent, Events::V1SubscriptionScheduleCreatedEvent, Events::V1SubscriptionScheduleExpiringEvent, Events::V1SubscriptionScheduleReleasedEvent, Events::V1SubscriptionScheduleUpdatedEvent, Events::V1TaxRateCreatedEvent, Events::V1TaxRateUpdatedEvent, Events::V1TerminalReaderActionFailedEvent, Events::V1TerminalReaderActionSucceededEvent, Events::V1TerminalReaderActionUpdatedEvent, Events::V1TestHelpersTestClockAdvancingEvent, Events::V1TestHelpersTestClockCreatedEvent, Events::V1TestHelpersTestClockDeletedEvent, Events::V1TestHelpersTestClockInternalFailureEvent, Events::V1TestHelpersTestClockReadyEvent, Events::V1TopupCanceledEvent, Events::V1TopupCreatedEvent, Events::V1TopupFailedEvent, Events::V1TopupReversedEvent, Events::V1TopupSucceededEvent, Events::V1TransferCreatedEvent, Events::V1TransferReversedEvent, Events::V1TransferUpdatedEvent, Events::V2BillingCadenceBilledEvent, Events::V2BillingCadenceCanceledEvent, Events::V2BillingCadenceCreatedEvent, Events::V2BillingLicenseFeeCreatedEvent, Events::V2BillingLicenseFeeUpdatedEvent, Events::V2BillingLicenseFeeVersionCreatedEvent, Events::V2BillingLicensedItemCreatedEvent, Events::V2BillingLicensedItemUpdatedEvent, Events::V2BillingMeteredItemCreatedEvent, Events::V2BillingMeteredItemUpdatedEvent, Events::V2BillingPricingPlanComponentCreatedEvent, Events::V2BillingPricingPlanComponentUpdatedEvent, Events::V2BillingPricingPlanCreatedEvent, Events::V2BillingPricingPlanSubscriptionCollectionAwaitingCustomerActionEvent, Events::V2BillingPricingPlanSubscriptionCollectionCurrentEvent, Events::V2BillingPricingPlanSubscriptionCollectionPastDueEvent, Events::V2BillingPricingPlanSubscriptionCollectionPausedEvent, Events::V2BillingPricingPlanSubscriptionCollectionUnpaidEvent, Events::V2BillingPricingPlanSubscriptionServicingActivatedEvent, Events::V2BillingPricingPlanSubscriptionServicingCanceledEvent, Events::V2BillingPricingPlanSubscriptionServicingPausedEvent, Events::V2BillingPricingPlanUpdatedEvent, Events::V2BillingPricingPlanVersionCreatedEvent, Events::V2BillingRateCardCreatedEvent, Events::V2BillingRateCardRateCreatedEvent, Events::V2BillingRateCardSubscriptionActivatedEvent, Events::V2BillingRateCardSubscriptionCanceledEvent, Events::V2BillingRateCardSubscriptionCollectionAwaitingCustomerActionEvent, Events::V2BillingRateCardSubscriptionCollectionCurrentEvent, Events::V2BillingRateCardSubscriptionCollectionPastDueEvent, Events::V2BillingRateCardSubscriptionCollectionPausedEvent, Events::V2BillingRateCardSubscriptionCollectionUnpaidEvent, Events::V2BillingRateCardSubscriptionServicingActivatedEvent, Events::V2BillingRateCardSubscriptionServicingCanceledEvent, Events::V2BillingRateCardSubscriptionServicingPausedEvent, Events::V2BillingRateCardUpdatedEvent, Events::V2BillingRateCardVersionCreatedEvent, Events::V2CoreAccountClosedEvent, Events::V2CoreAccountCreatedEvent, Events::V2CoreAccountIncludingConfigurationCardCreatorCapabilityStatusUpdatedEvent, Events::V2CoreAccountIncludingConfigurationCardCreatorUpdatedEvent, Events::V2CoreAccountIncludingConfigurationCustomerCapabilityStatusUpdatedEvent, Events::V2CoreAccountIncludingConfigurationCustomerUpdatedEvent, Events::V2CoreAccountIncludingConfigurationMerchantCapabilityStatusUpdatedEvent, Events::V2CoreAccountIncludingConfigurationMerchantUpdatedEvent, Events::V2CoreAccountIncludingConfigurationRecipientCapabilityStatusUpdatedEvent, Events::V2CoreAccountIncludingConfigurationRecipientUpdatedEvent, Events::V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent, Events::V2CoreAccountIncludingConfigurationStorerUpdatedEvent, Events::V2CoreAccountIncludingDefaultsUpdatedEvent, Events::V2CoreAccountIncludingIdentityUpdatedEvent, Events::V2CoreAccountIncludingRequirementsUpdatedEvent, Events::V2CoreAccountLinkReturnedEvent, Events::V2CoreAccountPersonCreatedEvent, Events::V2CoreAccountPersonDeletedEvent, Events::V2CoreAccountPersonUpdatedEvent, Events::V2CoreAccountUpdatedEvent, Events::V2CoreClaimableSandboxClaimedEvent, Events::V2CoreClaimableSandboxCreatedEvent, Events::V2CoreClaimableSandboxExpiredEvent, Events::V2CoreClaimableSandboxExpiringEvent, Events::V2CoreClaimableSandboxSandboxDetailsOwnerAccountUpdatedEvent, Events::V2CoreEventDestinationPingEvent, Events::V2CoreHealthApiErrorFiringEvent, Events::V2CoreHealthApiErrorResolvedEvent, Events::V2CoreHealthApiLatencyFiringEvent, Events::V2CoreHealthApiLatencyResolvedEvent, Events::V2CoreHealthAuthorizationRateDropFiringEvent, Events::V2CoreHealthAuthorizationRateDropResolvedEvent, Events::V2CoreHealthEventGenerationFailureResolvedEvent, Events::V2CoreHealthFraudRateIncreasedEvent, Events::V2CoreHealthIssuingAuthorizationRequestErrorsFiringEvent, Events::V2CoreHealthIssuingAuthorizationRequestErrorsResolvedEvent, Events::V2CoreHealthIssuingAuthorizationRequestTimeoutFiringEvent, Events::V2CoreHealthIssuingAuthorizationRequestTimeoutResolvedEvent, Events::V2CoreHealthPaymentMethodErrorFiringEvent, Events::V2CoreHealthPaymentMethodErrorResolvedEvent, Events::V2CoreHealthTrafficVolumeDropFiringEvent, Events::V2CoreHealthTrafficVolumeDropResolvedEvent, Events::V2CoreHealthWebhookLatencyFiringEvent, Events::V2CoreHealthWebhookLatencyResolvedEvent, Events::V2MoneyManagementAdjustmentCreatedEvent, Events::V2MoneyManagementFinancialAccountCreatedEvent, Events::V2MoneyManagementFinancialAccountUpdatedEvent, Events::V2MoneyManagementFinancialAddressActivatedEvent, Events::V2MoneyManagementFinancialAddressFailedEvent, Events::V2MoneyManagementInboundTransferAvailableEvent, Events::V2MoneyManagementInboundTransferBankDebitFailedEvent, Events::V2MoneyManagementInboundTransferBankDebitProcessingEvent, Events::V2MoneyManagementInboundTransferBankDebitQueuedEvent, Events::V2MoneyManagementInboundTransferBankDebitReturnedEvent, Events::V2MoneyManagementInboundTransferBankDebitSucceededEvent, Events::V2MoneyManagementOutboundPaymentCanceledEvent, Events::V2MoneyManagementOutboundPaymentCreatedEvent, Events::V2MoneyManagementOutboundPaymentFailedEvent, Events::V2MoneyManagementOutboundPaymentPostedEvent, Events::V2MoneyManagementOutboundPaymentReturnedEvent, Events::V2MoneyManagementOutboundPaymentUpdatedEvent, Events::V2MoneyManagementOutboundTransferCanceledEvent, Events::V2MoneyManagementOutboundTransferCreatedEvent, Events::V2MoneyManagementOutboundTransferFailedEvent, Events::V2MoneyManagementOutboundTransferPostedEvent, Events::V2MoneyManagementOutboundTransferReturnedEvent, Events::V2MoneyManagementOutboundTransferUpdatedEvent, Events::V2MoneyManagementPayoutMethodUpdatedEvent, Events::V2MoneyManagementReceivedCreditAvailableEvent, Events::V2MoneyManagementReceivedCreditFailedEvent, Events::V2MoneyManagementReceivedCreditReturnedEvent, Events::V2MoneyManagementReceivedCreditSucceededEvent, Events::V2MoneyManagementReceivedDebitCanceledEvent, Events::V2MoneyManagementReceivedDebitFailedEvent, Events::V2MoneyManagementReceivedDebitPendingEvent, Events::V2MoneyManagementReceivedDebitSucceededEvent, Events::V2MoneyManagementReceivedDebitUpdatedEvent, Events::V2MoneyManagementRecipientVerificationCreatedEvent, Events::V2MoneyManagementRecipientVerificationUpdatedEvent, Events::V2MoneyManagementTransactionCreatedEvent, Events::V2MoneyManagementTransactionUpdatedEvent, Events::V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent, Events::V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent, Events::V2PaymentsOffSessionPaymentCanceledEvent, Events::V2PaymentsOffSessionPaymentCreatedEvent, Events::V2PaymentsOffSessionPaymentFailedEvent, Events::V2PaymentsOffSessionPaymentRequiresCaptureEvent, Events::V2PaymentsOffSessionPaymentSucceededEvent, Events::V2ReportingReportRunCreatedEvent, Events::V2ReportingReportRunFailedEvent, Events::V2ReportingReportRunSucceededEvent, Events::V2ReportingReportRunUpdatedEvent

Defined Under Namespace

Classes: Reason

Constant Summary collapse

OBJECT_NAME = 
"v2.core.event"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#changes ⇒ Object (readonly)

Before and after changes for the primary related object.



43
44
45
 
# File 'lib/stripe/resources/v2/core/event.rb', line 43

def changes
  @changes
end

#context ⇒ Object (readonly)

Authentication context needed to fetch the event or related object.



45
46
47
 
# File 'lib/stripe/resources/v2/core/event.rb', line 45

def context
  @context
end

#created ⇒ Object (readonly)

Time at which the object was created.



47
48
49
 
# File 'lib/stripe/resources/v2/core/event.rb', line 47

def created
  @created
end

#id ⇒ Object (readonly)

Unique identifier for the event.



49
50
51
 
# File 'lib/stripe/resources/v2/core/event.rb', line 49

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



51
52
53
 
# File 'lib/stripe/resources/v2/core/event.rb', line 51

def livemode
  @livemode
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value of the object field.



53
54
55
 
# File 'lib/stripe/resources/v2/core/event.rb', line 53

def object
  @object
end

#reason ⇒ Object (readonly)

Reason for the event.



55
56
57
 
# File 'lib/stripe/resources/v2/core/event.rb', line 55

def reason
  @reason
end

#type ⇒ Object (readonly)

The type of the event.



57
58
59
 
# File 'lib/stripe/resources/v2/core/event.rb', line 57

def type
  @type
end

#v1_event_id ⇒ Object (readonly)

For interop events, this is the snapshot event ID.



59
60
61
 
# File 'lib/stripe/resources/v2/core/event.rb', line 59

def v1_event_id
  @v1_event_id
end

Class Method Details

.field_remappings ⇒ Object 



65
66
67
 
# File 'lib/stripe/resources/v2/core/event.rb', line 65

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



61
62
63
 
# File 'lib/stripe/resources/v2/core/event.rb', line 61

def self.inner_class_types
  @inner_class_types = { reason: Reason }
end

.object_name ⇒ Object 



10
11
12
 
# File 'lib/stripe/resources/v2/core/event.rb', line 10

def self.object_name
  "v2.core.event"
end